supervisorclusters#

async idem_vra.exec.vra.cmx.supervisorclusters.existing_tanzu_clusters_using_get(hub, ctx, p_selfLinkId, **kwargs)[source]#

Get all existing tanzu kubernetes clusters on a supervisor cluster. Get all existing tanzu kubernetes clusters on a supervisor cluster. Performs GET /cmx/api/resources/supervisor-clusters/{selfLinkId}/tanzu-clusters-namespace

Parameters:

  • p_selfLinkId (string) – (required in path) selfLinkId

  • registered (string) – (optional in query) registered

  • searchTerm (string) – (optional in query) searchTerm

async idem_vra.exec.vra.cmx.supervisorclusters.get_cluster_using_get1(hub, ctx, p_endpointSelfLinkId, p_moref, **kwargs)[source]#
Find a Supervisor Cluster by vSphere moref and vSphere endpoint id Retrieve a Supervisor Cluster by vSphere moref and id from the endpoint self

link of the vSphere endpoint this cluster is associated to Performs GET /cmx/api/resources/supervisor-clusters/endpoint/{endpointSelfLinkId}/cluster/{moref}

Parameters:

  • p_endpointSelfLinkId (string) – (required in path) endpointSelfLinkId

  • p_moref (string) – (required in path) moref

async idem_vra.exec.vra.cmx.supervisorclusters.get_cluster_using_get2(hub, ctx, p_clusterSelfLinkId, **kwargs)[source]#

Find a Supervisor Cluster by the id from documentSelfLink Retrieve a Supervisor Cluster by id from documentSelfLink Performs GET /cmx/api/resources/supervisor-clusters/{clusterSelfLinkId}

Parameters:

p_clusterSelfLinkId (string) – (required in path) clusterSelfLinkId

async idem_vra.exec.vra.cmx.supervisorclusters.list_clusters_on_endpoint_using_get(hub, ctx, p_endpointSelfLinkId, **kwargs)[source]#
Get all Supervisor Clusters on a vSphere endpoint Get all Supervisor Clusters on a vSphere endpoint by provided id from the

endpoint self link Performs GET /cmx/api/resources/supervisor-clusters/endpoint/{endpointSelfLinkId}

Parameters:

  • p_endpointSelfLinkId (string) – (required in path) endpointSelfLinkId

  • offset (integer) – (optional in query)

  • pageNumber (integer) – (optional in query)

  • pageSize (integer) – (optional in query)

  • paged (boolean) – (optional in query)

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

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

  • unpaged (boolean) – (optional in query)

  • registered (string) – (optional in query) registered

async idem_vra.exec.vra.cmx.supervisorclusters.list_using_get4(hub, ctx, **kwargs)[source]#

Get all managed Supervisor Clusters Get all managed Supervisor Clusters Performs GET /cmx/api/resources/supervisor-clusters

Parameters:

  • offset (integer) – (optional in query)

  • pageNumber (integer) – (optional in query)

  • pageSize (integer) – (optional in query)

  • paged (boolean) – (optional in query)

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

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

  • unpaged (boolean) – (optional in query)

async idem_vra.exec.vra.cmx.supervisorclusters.register_using_put1(hub, ctx, p_clusterSelfLinkId, **kwargs)[source]#

Make a Supervisor Cluster a managed entity A valid document self link id shall be provided. Performs PUT /cmx/api/resources/supervisor-clusters/{clusterSelfLinkId}/register

Parameters:

p_clusterSelfLinkId (string) – (required in path) clusterSelfLinkId

async idem_vra.exec.vra.cmx.supervisorclusters.unregister_using_delete(hub, ctx, p_clusterSelfLinkId, **kwargs)[source]#

Make a Supervisor Cluster an unmanaged entity A valid document self link id shall be provided. Performs DELETE /cmx/api/resources/supervisor-clusters/{clusterSelfLinkId}

Parameters:

p_clusterSelfLinkId (string) – (required in path) clusterSelfLinkId