kubernetesclusters

async idem_vra.exec.vra.cmx.kubernetesclusters.assign_status_using_get(hub, ctx, p_requestId, **kwargs)

Retrieve assign status. Retrieve assign status. Performs GET /cmx/api/resources/k8s/clusters/assign/{requestId}

Parameters:

p_requestId (string) – (required in path) requestId

async idem_vra.exec.vra.cmx.kubernetesclusters.assign_using_post(hub, ctx, **kwargs)

Assign K8s cluster to cluster cluster group. Assign K8s cluster to cluster cluster group. Performs POST /cmx/api/resources/k8s/clusters/assign

Parameters:

• clusterGroup (string) – (optional in body)

• clusterIds (array) – (optional in body)

• projectId (string) – (optional in body)

async idem_vra.exec.vra.cmx.kubernetesclusters.delete_cluster_using_delete(hub, ctx, p_id, **kwargs)

Delete a K8S Cluster Delete a K8S Cluster by provided id Performs DELETE /cmx/api/resources/k8s/clusters/{id}

Parameters:

p_id (string) – (required in path) id

async idem_vra.exec.vra.cmx.kubernetesclusters.destroy_cluster_using_delete(hub, ctx, p_id, **kwargs)

Destroy a K8S Cluster Destroy a K8S Cluster by provided id Performs DELETE /cmx/api/resources/k8s/clusters/{id}/destroy

Parameters:

p_id (string) – (required in path) id

async idem_vra.exec.vra.cmx.kubernetesclusters.get_cluster_using_get(hub, ctx, p_id, **kwargs)

Find a K8S Cluster by id Retrieve a K8S by id Performs GET /cmx/api/resources/k8s/clusters/{id}

Parameters:

p_id (string) – (required in path) id

async idem_vra.exec.vra.cmx.kubernetesclusters.get_kube_config_using_get(hub, ctx, p_id, **kwargs)

Get a KubeConfig for a K8S Cluster Get a KubeConfig for a K8S Cluster by provided id Performs GET /cmx/api/resources/k8s/clusters/{id}/kube-config

Parameters:

• p_id (string) – (required in path) id

• ignoreTMC (boolean) – (optional in query) ignoreTMC

• includeCredentials (boolean) – (optional in query) includeCredentials

async idem_vra.exec.vra.cmx.kubernetesclusters.get_nodes_using_get(hub, ctx, p_id, **kwargs)

Get nodes of K8S Clusters Get nodes of K8S Clusters by provided id Performs GET /cmx/api/resources/k8s/clusters/{id}/nodes

Parameters:

p_id (string) – (required in path) id

async idem_vra.exec.vra.cmx.kubernetesclusters.list_using_get(hub, ctx, **kwargs)

Get all registered K8S Clusters Retrieve the managed K8S Clusters Performs GET /cmx/api/resources/k8s/clusters

Parameters:

• id (string) – (optional in query)

• localAddress.address.MCGlobal (boolean) – (optional in query)

• localAddress.address.MCLinkLocal (boolean) – (optional in query)

• localAddress.address.MCNodeLocal (boolean) – (optional in query)

• localAddress.address.MCOrgLocal (boolean) – (optional in query)

• localAddress.address.MCSiteLocal (boolean) – (optional in query)

• localAddress.address.address (string) – (optional in query)

• localAddress.address.anyLocalAddress (boolean) – (optional in query)

• localAddress.address.canonicalHostName (string) – (optional in query)

• localAddress.address.hostAddress (string) – (optional in query)

• localAddress.address.hostName (string) – (optional in query)

• localAddress.address.linkLocalAddress (boolean) – (optional in query)

• localAddress.address.loopbackAddress (boolean) – (optional in query)

• localAddress.address.multicastAddress (boolean) – (optional in query)

• localAddress.address.siteLocalAddress (boolean) – (optional in query)

• localAddress.hostName (string) – (optional in query)

• localAddress.hostString (string) – (optional in query)

• localAddress.port (integer) – (optional in query)

• localAddress.unresolved (boolean) – (optional in query)

• offset (integer) – (optional in query)

• pageNumber (integer) – (optional in query)

• pageSize (integer) – (optional in query)

• paged (boolean) – (optional in query)

• remoteAddress.address.MCGlobal (boolean) – (optional in query)

• remoteAddress.address.MCLinkLocal (boolean) – (optional in query)

• remoteAddress.address.MCNodeLocal (boolean) – (optional in query)

• remoteAddress.address.MCOrgLocal (boolean) – (optional in query)

• remoteAddress.address.MCSiteLocal (boolean) – (optional in query)

• remoteAddress.address.address (string) – (optional in query)

• remoteAddress.address.anyLocalAddress (boolean) – (optional in query)

• remoteAddress.address.canonicalHostName (string) – (optional in query)

• remoteAddress.address.hostAddress (string) – (optional in query)

• remoteAddress.address.hostName (string) – (optional in query)

• remoteAddress.address.linkLocalAddress (boolean) – (optional in query)

• remoteAddress.address.loopbackAddress (boolean) – (optional in query)

• remoteAddress.address.multicastAddress (boolean) – (optional in query)

• remoteAddress.address.siteLocalAddress (boolean) – (optional in query)

• remoteAddress.hostName (string) – (optional in query)

• remoteAddress.hostString (string) – (optional in query)

• remoteAddress.port (integer) – (optional in query)

• remoteAddress.unresolved (boolean) – (optional in query)

• sort.sorted (boolean) – (optional in query)

• sort.unsorted (boolean) – (optional in query)

• sslInfo.peerCertificates[0].TBSCertificate (string) – (optional in query)

• sslInfo.peerCertificates[0].basicConstraints (integer) – (optional in query)

• sslInfo.peerCertificates[0].encoded (string) – (optional in query)

• sslInfo.peerCertificates[0].extendedKeyUsage (array) – (optional in query)

• sslInfo.peerCertificates[0].issuerDN.name (string) – (optional in query)

• sslInfo.peerCertificates[0].issuerUniqueID (array) – (optional in query)

• sslInfo.peerCertificates[0].issuerX500Principal.encoded (string) – (optional in query)

• sslInfo.peerCertificates[0].issuerX500Principal.name (string) – (optional in query)

• sslInfo.peerCertificates[0].keyUsage (array) – (optional in query)

• sslInfo.peerCertificates[0].notAfter (string) – (optional in query)

• sslInfo.peerCertificates[0].notBefore (string) – (optional in query)

• sslInfo.peerCertificates[0].serialNumber (integer) – (optional in query)

• sslInfo.peerCertificates[0].sigAlgName (string) – (optional in query)

• sslInfo.peerCertificates[0].sigAlgOID (string) – (optional in query)

• sslInfo.peerCertificates[0].sigAlgParams (string) – (optional in query)

• sslInfo.peerCertificates[0].signature (string) – (optional in query)

• sslInfo.peerCertificates[0].subjectDN.name (string) – (optional in query)

• sslInfo.peerCertificates[0].subjectUniqueID (array) – (optional in query)

• sslInfo.peerCertificates[0].subjectX500Principal.encoded (string) – (optional in query)

• sslInfo.peerCertificates[0].subjectX500Principal.name (string) – (optional in query)

• sslInfo.peerCertificates[0].type (string) – (optional in query)

• sslInfo.peerCertificates[0].version (integer) – (optional in query)

• sslInfo.sessionId (string) – (optional in query)

• unpaged (boolean) – (optional in query)

async idem_vra.exec.vra.cmx.kubernetesclusters.onboard_using_post(hub, ctx, **kwargs)

Onboard a K8S Cluster Onboard a K8S Cluster entity Performs POST /cmx/api/resources/k8s/clusters

Parameters:

• address (string) – (optional in body)

• authCredentialsLink (string) – (optional in body)

• caCertificate (string) – (optional in body)

• clusterType (string) – (optional in body)

• createdMillis (integer) – (optional in body)

• credentials (Any) – (optional in body)

• customProperties (object) – (optional in body)

• description (string) – (optional in body)

• directConnection (boolean) – (optional in body)

• endpointId (string) – (optional in body)

• externalLink (string) – (optional in body)

• global (boolean) – (optional in body)

• id (string) – (optional in body)

• installerId (string) – (optional in body)

• kubernetesWorkerInstances (integer) – (optional in body)

• lastOperation (string) – (optional in body)

• lastOperationMessage (string) – (optional in body)

• lastOperationStatus (string) – (optional in body)

• lastRefreshedMillis (integer) – (optional in body)

• name (string) – (optional in body)

• nodes (array) – (optional in body)

• orgId (string) – (optional in body)

• owner (string) – (optional in body)

• projectId (string) – (optional in body)

• remainingUnreachableRetryThreshold (integer) – (optional in body)

• shared (boolean) – (optional in body)

• status (string) – (optional in body)

• updatedMillis (integer) – (optional in body)

• version (string) – (optional in body)

async idem_vra.exec.vra.cmx.kubernetesclusters.update_using_put1(hub, ctx, p_id, **kwargs)

Update a K8S Cluster Update K8S Cluster by id Performs PUT /cmx/api/resources/k8s/clusters/{id}

Parameters:

• p_id (string) – (required in path) id

• address (string) – (optional in body)

• authCredentialsLink (string) – (optional in body)

• caCertificate (string) – (optional in body)

• clusterType (string) – (optional in body)

• createdMillis (integer) – (optional in body)

• credentials (Any) – (optional in body)

• customProperties (object) – (optional in body)

• description (string) – (optional in body)

• directConnection (boolean) – (optional in body)

• endpointId (string) – (optional in body)

• externalLink (string) – (optional in body)

• global (boolean) – (optional in body)

• id (string) – (optional in body)

• installerId (string) – (optional in body)

• kubernetesWorkerInstances (integer) – (optional in body)

• lastOperation (string) – (optional in body)

• lastOperationMessage (string) – (optional in body)

• lastOperationStatus (string) – (optional in body)

• lastRefreshedMillis (integer) – (optional in body)

• name (string) – (optional in body)

• nodes (array) – (optional in body)

• orgId (string) – (optional in body)

• owner (string) – (optional in body)

• projectId (string) – (optional in body)

• remainingUnreachableRetryThreshold (integer) – (optional in body)

• shared (boolean) – (optional in body)

• status (string) – (optional in body)

• updatedMillis (integer) – (optional in body)

• version (string) – (optional in body)

async idem_vra.exec.vra.cmx.kubernetesclusters.validate_using_put(hub, ctx, **kwargs)

Validate provided K8S Cluster entity Validate provided K8S Cluster entity Performs PUT /cmx/api/resources/k8s/clusters/validate

Parameters:

• address (string) – (optional in body)

• authCredentialsLink (string) – (optional in body)

• caCertificate (string) – (optional in body)

• clusterType (string) – (optional in body)

• createdMillis (integer) – (optional in body)

• credentials (Any) – (optional in body)

• customProperties (object) – (optional in body)

• description (string) – (optional in body)

• directConnection (boolean) – (optional in body)

• endpointId (string) – (optional in body)

• externalLink (string) – (optional in body)

• global (boolean) – (optional in body)

• id (string) – (optional in body)

• installerId (string) – (optional in body)

• kubernetesWorkerInstances (integer) – (optional in body)

• lastOperation (string) – (optional in body)

• lastOperationMessage (string) – (optional in body)

• lastOperationStatus (string) – (optional in body)

• lastRefreshedMillis (integer) – (optional in body)

• name (string) – (optional in body)

• nodes (array) – (optional in body)

• orgId (string) – (optional in body)

• owner (string) – (optional in body)

• projectId (string) – (optional in body)

• remainingUnreachableRetryThreshold (integer) – (optional in body)

• shared (boolean) – (optional in body)

• status (string) – (optional in body)

• updatedMillis (integer) – (optional in body)

• version (string) – (optional in body)