tmcendpoints#

async idem_vra.exec.vra.cmx.tmcendpoints.create_request_tracker_using_post(hub, ctx, **kwargs)[source]#
Create a request tracker for endpoint creation Create a request tracker for a TMC endpoint by providing the endpoint

configuration Performs POST /cmx/api/resources/tmc/endpoints/request-tracker

Parameters:

  • customProperties (Any) – (optional in body)

  • endpointProperties (Any) – (optional in body)

  • endpointType (string) – (optional in body)

  • name (string) – (optional in body)

  • requestType (string) – (optional in body)

  • resourceReference (string) – (optional in body)

  • taskReference (string) – (optional in body)

async idem_vra.exec.vra.cmx.tmcendpoints.get_cluster_groups_by_endpoint_using_get(hub, ctx, p_id, **kwargs)[source]#
Get all cluster groups for TMC endpoint Get cluster groups for a TMC endpoint by provided TMC endpoint id and starting

with the provided cluster group name. If cluster group name is not provided, then all cluster groups are returned Performs GET /cmx/api/resources/tmc/endpoints/{id}/clustergroups

Parameters:

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

  • includeTotalCount (boolean) – (optional in query) Include total count.

  • pagination.offset (string) – (optional in query) Offset at which to start returning records.

  • pagination.size (string) – (optional in query) Number of records to return.

  • query (string) – (optional in query) TQL query string.

  • searchScope.name (string) – (optional in query) Scope search to the specified name; supports globbing; default (*).

  • sortBy (string) – (optional in query) Sort Order.

async idem_vra.exec.vra.cmx.tmcendpoints.get_cluster_groups_by_request_tracker_using_get(hub, ctx, q_requestTrackerId, **kwargs)[source]#
Get all cluster groups for TMC endpoint Get cluster groups for a TMC endpoint by provided TMC endpoint id and starting

with the provided cluster group name. If cluster group name is not provided, then all cluster groups are returned Performs GET /cmx/api/resources/tmc/endpoints/clustergroups

Parameters:

  • q_requestTrackerId (string) – (required in query)

  • includeTotalCount (boolean) – (optional in query) Include total count.

  • pagination.offset (string) – (optional in query) Offset at which to start returning records.

  • pagination.size (string) – (optional in query) Number of records to return.

  • query (string) – (optional in query) TQL query string.

  • searchScope.name (string) – (optional in query) Scope search to the specified name; supports globbing; default (*).

  • sortBy (string) – (optional in query) Sort Order.

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

Get Tmc CLI binaries Get Tanzu CLI binaries for Mac, Linux, Windows Performs GET /cmx/api/resources/tmc/endpoints/tanzu-cli-binaries

async idem_vra.exec.vra.cmx.tmcendpoints.get_workspaces_by_endpoint_using_get(hub, ctx, p_id, **kwargs)[source]#
Get all workspace names list for TMC endpoint Get workspace names list for a TMC endpoint by provided TMC endpoint id and

starting with the default workspace name. If workspace name is not provided, then all workspaces are returned Performs GET /cmx/api/resources/tmc/endpoints/{id}/workspaces

Parameters:

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

  • includeTotalCount (boolean) – (optional in query) Include total count.

  • pagination.offset (string) – (optional in query) Offset at which to start returning records.

  • pagination.size (string) – (optional in query) Number of records to return.

  • query (string) – (optional in query) TQL query string.

  • searchScope.name (string) – (optional in query) Scope search to the specified name; supports globbing; default (*).

  • sortBy (string) – (optional in query) Sort Order.

async idem_vra.exec.vra.cmx.tmcendpoints.get_workspaces_by_request_tracker_using_get(hub, ctx, q_requestTrackerId, **kwargs)[source]#
Get all workspace names list for TMC endpoint Get workspace names list for a TMC endpoint by provided TMC endpoint id and

starting with the default workspace name. If workspace name is not provided, then all workspaces are returned Performs GET /cmx/api/resources/tmc/endpoints/workspaces

Parameters:

  • q_requestTrackerId (string) – (required in query)

  • includeTotalCount (boolean) – (optional in query) Include total count.

  • pagination.offset (string) – (optional in query) Offset at which to start returning records.

  • pagination.size (string) – (optional in query) Number of records to return.

  • query (string) – (optional in query) TQL query string.

  • searchScope.name (string) – (optional in query) Scope search to the specified name; supports globbing; default (*).

  • sortBy (string) – (optional in query) Sort Order.