clusterplans#

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

Create a cluster plan The body shall contain a cluster plan entity. Performs POST /cmx/api/resources/cluster-plans

Parameters:

  • cloudAccountSelfLinkId (string) – (optional in body)

  • createdMillis (integer) – (optional in body)

  • definition (object) – (optional in body) The definition varies depending on the type of cluster plan. Example shown below is for cluster plans of type TANZU_CLUSTER_PLAN. In that case the definition is equivalent to the spec of a Tanzu Kubernetes cluster in JSON format. Here is a documentation https://docs.vmware.com/en/VMware-vSphere/7.0/vmware-vsphere-with- tanzu/GUID-B1034373-8C38-4FE2-9517-345BF7271A1E.html example: {“spec”:{“distribution”:{“version”:”1.20”},”topology”:{“contr olPlane”:{“count”:1,”class”:”best-effort-xsmall”,”storageClass”:”vsan- default-storage-policy”},”workers”:{“count”:1,”class”:”best-effort- xsmall”,”storageClass”:”vsan-default-storage- policy”}},”settings”:{“storage”:{“defaultClass”:””,”classes”:[]}}}}

  • description (string) – (optional in body)

  • id (string) – (optional in body)

  • name (string) – (optional in body)

  • orgId (string) – (optional in body)

  • type (string) – (optional in body)

  • updatedMillis (integer) – (optional in body)

async idem_vra.exec.vra.cmx.clusterplans.delete_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Cluster Plan by Id Delete a Cluster Plan identified by id string Performs DELETE /cmx/api/resources/cluster-plans/{id}

Parameters:

p_id (string) – (required in path) id

async idem_vra.exec.vra.cmx.clusterplans.get_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a Cluster Plan by Id Get a Cluster Plan by Id Performs GET /cmx/api/resources/cluster-plans/{id}

Parameters:

p_id (string) – (required in path) id

async idem_vra.exec.vra.cmx.clusterplans.search_cluster_plan_aggregations_using_get(hub, ctx, q_groupBy, **kwargs)[source]#
Search for cluster plan aggregations Search for cluster plan aggregations by name and cloud account document self

link id. Performs GET /cmx/api/resources/cluster-plans/aggregation

Parameters:

  • q_groupBy (string) – (required in query) groupBy

  • 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)

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

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

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

Search a cluster plan instance Search a cluster plan by name and cloud account document self link id. Performs GET /cmx/api/resources/cluster-plans

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)

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

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

async idem_vra.exec.vra.cmx.clusterplans.update_using_put(hub, ctx, p_id, **kwargs)[source]#

Update a cluster plan The body shall contains the cluster plan mutation entity. Performs PUT /cmx/api/resources/cluster-plans/{id}

Parameters:

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

  • cloudAccountSelfLinkId (string) – (optional in body)

  • createdMillis (integer) – (optional in body)

  • definition (object) – (optional in body) The definition varies depending on the type of cluster plan. Example shown below is for cluster plans of type TANZU_CLUSTER_PLAN. In that case the definition is equivalent to the spec of a Tanzu Kubernetes cluster in JSON format. Here is a documentation https://docs.vmware.com/en/VMware-vSphere/7.0/vmware-vsphere-with- tanzu/GUID-B1034373-8C38-4FE2-9517-345BF7271A1E.html example: {“spec”:{“distribution”:{“version”:”1.20”},”topology”:{“contr olPlane”:{“count”:1,”class”:”best-effort-xsmall”,”storageClass”:”vsan- default-storage-policy”},”workers”:{“count”:1,”class”:”best-effort- xsmall”,”storageClass”:”vsan-default-storage- policy”}},”settings”:{“storage”:{“defaultClass”:””,”classes”:[]}}}}

  • description (string) – (optional in body)

  • id (string) – (optional in body)

  • name (string) – (optional in body)

  • orgId (string) – (optional in body)

  • type (string) – (optional in body)

  • updatedMillis (integer) – (optional in body)