deployments#

async idem_vra.exec.vra.catalog.deployments.check_deployment_name_exists_using_get2(hub, ctx, **kwargs)[source]#

Check if a deployment exists. Returns OK if a deployment with the supplied name exists. Performs GET /deployment/api/deployments/names

Parameters:

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

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

async idem_vra.exec.vra.catalog.deployments.check_deployment_name_using_get2(hub, ctx, p_name, **kwargs)[source]#

Check if a deployment exists. Returns OK if a deployment with the supplied name exists. Performs GET /deployment/api/deployments/names/{name}

Parameters:

  • p_name (string) – (required in path) Deployment name

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

async idem_vra.exec.vra.catalog.deployments.delete_deployment_using_delete2(hub, ctx, p_deploymentId, **kwargs)[source]#
Delete a deployment. Effectively triggers a Delete Day2 operation Deletes the deployment with the supplied ID, cleans up the associated resources

from the Cloud Provider. Performs DELETE /deployment/api/deployments/{deploymentId}

Parameters:

  • p_deploymentId (string) – (required in path) Deployment ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

async idem_vra.exec.vra.catalog.deployments.delete_resource_using_delete2(hub, ctx, p_deploymentId, p_resourceId, **kwargs)[source]#
Delete resource associated with a deployment. Effectively triggers a Delete

Day2 operation. Deletes the resource with the specified ID and attempts to delete resource from the Cloud Provider. Performs DELETE /deployment/api/deployments/{deploymentId}/resources/{resourceId}

Parameters:

  • p_deploymentId (string) – (required in path) Deployment ID

  • p_resourceId (string) – (required in path) Resource ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

async idem_vra.exec.vra.catalog.deployments.get_deployment_by_id_v3_using_get(hub, ctx, p_deploymentId, **kwargs)[source]#

Fetch a specific deployment. Returns the deployment with the supplied ID. Performs GET /deployment/api/deployments/{deploymentId}

Parameters:

  • p_deploymentId (string) – (required in path) Deployment ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • deleted (boolean) – (optional in query) Retrieves the deployment, includes soft-deleted deployments that have not yet been completely deleted.

  • expand (array) – (optional in query) The expanded details of the requested comma separated objects. <br /> ‘resources’ option returns resources with summary properties

async idem_vra.exec.vra.catalog.deployments.get_deployment_expense_history_by_id_using_get2(hub, ctx, p_deploymentId, **kwargs)[source]#

Fetch a specific deployment’s expense history. Returns the deployment expense history with the supplied ID. Performs GET /deployment/api/deployments/{deploymentId}/expense-history

Parameters:

  • p_deploymentId (string) – (required in path) Deployment ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • from (string) – (optional in query) The timestamp from when history is requested. Should be of ISO_INSTANT format.

  • interval (string) – (optional in query) The interval of the expense history. Should be one of daily, weekly or monthly.

  • to (string) – (optional in query) The timestamp until when history is requested. Should be of ISO_INSTANT format.

async idem_vra.exec.vra.catalog.deployments.get_deployment_filter_by_id_using_get2(hub, ctx, p_filterId, **kwargs)[source]#

Returns the Deployment filter with the supplied ID. Performs GET /deployment/api/deployments/filters/{filterId}

Parameters:

  • p_filterId (string) – (required in path) Filter Id

  • orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • skip (integer) – (optional in query) Number of records you want to skip

  • top (integer) – (optional in query) Number of records you want

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • projects (array) – (optional in query) A comma-separated list. Results must be associated with one of these project IDs.

  • search (string) – (optional in query) Search string for filters

async idem_vra.exec.vra.catalog.deployments.get_deployment_filters_using_get2(hub, ctx, **kwargs)[source]#

Returns the Deployment filters in context of given user. Performs GET /deployment/api/deployments/filters

Parameters:

  • ISO3Country (string) – (optional in query)

  • ISO3Language (string) – (optional in query)

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • country (string) – (optional in query)

  • displayCountry (string) – (optional in query)

  • displayLanguage (string) – (optional in query)

  • displayName (string) – (optional in query)

  • displayScript (string) – (optional in query)

  • displayVariant (string) – (optional in query)

  • language (string) – (optional in query)

  • script (string) – (optional in query)

  • unicodeLocaleAttributes (array) – (optional in query)

  • unicodeLocaleKeys (array) – (optional in query)

  • variant (string) – (optional in query)

async idem_vra.exec.vra.catalog.deployments.get_deployment_resources_using_get2(hub, ctx, p_deploymentId, **kwargs)[source]#
Fetch resources associated with a deployment. Returns a paginated list of resources corresponding to the deployment with the

supplied ID. Performs GET /deployment/api/deployments/{deploymentId}/resources

Parameters:

  • p_deploymentId (string) – (required in path) Deployment ID

  • orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • skip (integer) – (optional in query) Number of records you want to skip

  • top (integer) – (optional in query) Number of records you want

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • expand (array) – (optional in query) The expanded details of the requested comma separated objects. Ex. currentRequest

  • names (array) – (optional in query) Results must have exactly these resource names.

  • resourceTypes (array) – (optional in query) A comma-separated list. Results must be associated with one of these resourceType Names.

  • tags (array) – (optional in query) A comma-separated list. Results must be associated with one of these tags

async idem_vra.exec.vra.catalog.deployments.get_deployments_for_project_using_get2(hub, ctx, p_projectId, **kwargs)[source]#

Returns a count of deployments using the project. Performs GET /deployment/api/projects/{projectId}/deployment-count

Parameters:

  • p_projectId (string) – (required in path) Project ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

async idem_vra.exec.vra.catalog.deployments.get_deployments_v3_using_get(hub, ctx, **kwargs)[source]#

Fetch all deployments. Returns a paginated list of deployments. Performs GET /deployment/api/deployments

Parameters:

  • orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • skip (integer) – (optional in query) Number of records you want to skip

  • top (integer) – (optional in query) Number of records you want

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • cloudAccounts (array) – (optional in query) A comma-separated list. Results must be associated with one of these cloud accounts.

  • cloudTypes (array) – (optional in query) A comma-separated list. Results must be associated with one of these endpoint Types

  • createdAt (string) – (optional in query) Comma-separated start and end dates where start date or end date is optional (e.g. [2020-12-01T08:00:00.000Z,2020-12-11T23:59:00.000Z], [2020-11-03T08:00:00.000Z,], [,2020-11-08T08:00:00.000Z]

  • deleted (boolean) – (optional in query) Retrieves only soft-deleted deployments that have not yet been completely deleted.

  • expand (array) – (optional in query) The expanded details of the requested comma separated objects. <br />’resources’ option returns resources with summary properties.

  • expiresAt (string) – (optional in query) Comma-separated start and end dates for the interval

  • lastRequestStatus (array) – (optional in query) A comma-separated list of last request statuses. Allowed values are: ABORTED, APPROVAL_PENDING, APPROVAL_REJECTED, FAILED, INPROGRESS, PENDING and SUCCESSFUL. Results must be associated with one of these last request statuses.

  • lastUpdatedAt (string) – (optional in query) Comma-separated start and end dates where start date or end date is optional (e.g. [2020-12-01T08:00:00.000Z,2020-12-11T23:59:00.000Z], [2020-11-03T08:00:00.000Z,], [,2020-11-08T08:00:00.000Z]

  • name (string) – (optional in query) Results must have exactly this name.

  • ownedBy (array) – (optional in query) A comma-separated list. Results must be associated with one of these owners

  • projects (array) – (optional in query) A comma-separated list. Results must be associated with one of these project IDs.

  • requestedBy (array) – (optional in query) A comma-separated list. Results must be associated with one of these requesters

  • resourceTypes (array) – (optional in query) A comma-separated list. Results must be associated with one of these resourceType Names.

  • search (string) – (optional in query) Given string should either be part of a searchable field in a deployment or one of deployment’s resources.

  • status (array) – (optional in query) A comma-separated list. Results must be associated with one of these statuses.

  • tags (array) – (optional in query) A comma-separated list. Results must be associated with one of these tags

async idem_vra.exec.vra.catalog.deployments.get_resource_by_id_using_get4(hub, ctx, p_deploymentId, p_resourceId, **kwargs)[source]#
Fetch resource associated with a deployment. Returns the resource with the specified ID that is correlated with the supplied

deployment. Performs GET /deployment/api/deployments/{deploymentId}/resources/{resourceId}

Parameters:

  • p_deploymentId (string) – (required in path) Deployment ID

  • p_resourceId (string) – (required in path) Resource ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • expand (array) – (optional in query) The expanded details of the requested comma separated objects. Ex. currentRequest

async idem_vra.exec.vra.catalog.deployments.patch_deployment_using_patch2(hub, ctx, p_deploymentId, **kwargs)[source]#

Update deployment. Updates the deployment with the supplied ID. Performs PATCH /deployment/api/deployments/{deploymentId}

Parameters:

  • p_deploymentId (string) – (required in path) Deployment ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • description (string) – (optional in body) New description of the deployment

  • iconId (string) – (optional in body) New iconid of the deployment

  • name (string) – (optional in body) New name of the deployment