blueprintrequests

async idem_vra.exec.vra.blueprint.blueprintrequests.cancel_blueprint_request_using_post(hub, ctx, p_requestId, **kwargs)

Cancel request Performs POST /blueprint/api/blueprint-requests/{requestId}/actions/cancel

Parameters:

• p_requestId (string) – (required in path) requestId

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

async idem_vra.exec.vra.blueprint.blueprintrequests.create_blueprint_request_using_post1(hub, ctx, **kwargs)

Creates a blueprint request Performs POST /blueprint/api/blueprint-requests

Parameters:

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

• blueprintId (string) – (optional in body) Blueprint Id

• blueprintVersion (string) – (optional in body) Blueprint version

• cancelRequestedAt (string) – (optional in body) Cancel request time

• cancelRequestedBy (string) – (optional in body) Cancel requested by

• content (string) – (optional in body) Blueprint YAML content

• createdAt (string) – (optional in body) Created time

• createdBy (string) – (optional in body) Created by

• deploymentId (string) – (optional in body) Existing deployment Id

• deploymentName (string) – (optional in body) Name for the new deployment

• description (string) – (optional in body) Description for the new request

• destroy (boolean) – (optional in body) Destroy existing deployment

• failureMessage (string) – (optional in body) Failure message

• flowExecutionId (string) – (optional in body) Flow execution Id

• flowId (string) – (optional in body) Flow Id

• id (string) – (optional in body) Object ID

• ignoreDeleteFailures (boolean) – (optional in body) Ignore delete failures in blueprint request

• inputs (object) – (optional in body) Blueprint request inputs

• orgId (string) – (optional in body) Org ID

• plan (boolean) – (optional in body) Plan only without affecting existing deployment

• projectId (string) – (optional in body) Project ID

• projectName (string) – (optional in body) Project Name

• reason (string) – (optional in body) Reason for requesting a blueprint

• requestTrackerId (string) – (optional in body) Request tracker Id

• simulate (boolean) – (optional in body) Simulate blueprint request with providers

• status (string) – (optional in body) Status

• targetResources (array) – (optional in body) Target resources

• updatedAt (string) – (optional in body) Updated time

• updatedBy (string) – (optional in body) Updated by

• validationMessages (array) – (optional in body) Validation messages

async idem_vra.exec.vra.blueprint.blueprintrequests.delete_blueprint_request_using_delete1(hub, ctx, p_requestId, **kwargs)

Deletes request Performs DELETE /blueprint/api/blueprint-requests/{requestId}

Parameters:

• p_requestId (string) – (required in path) requestId

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

• force (boolean) – (optional in query) Force delete if not in final stage

async idem_vra.exec.vra.blueprint.blueprintrequests.get_blueprint_plan_using_get1(hub, ctx, p_requestId, **kwargs)

Returns request plan Performs GET /blueprint/api/blueprint-requests/{requestId}/plan

Parameters:

• p_requestId (string) – (required in path) requestId

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

• expand (boolean) – (optional in query) Detailed plan

async idem_vra.exec.vra.blueprint.blueprintrequests.get_blueprint_request_using_get1(hub, ctx, p_requestId, **kwargs)

Returns blueprint request details Performs GET /blueprint/api/blueprint-requests/{requestId}

Parameters:

• p_requestId (string) – (required in path) requestId

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

async idem_vra.exec.vra.blueprint.blueprintrequests.get_blueprint_resources_plan_using_get1(hub, ctx, p_requestId, **kwargs)

Returns request resources plan Performs GET /blueprint/api/blueprint-requests/{requestId}/resources-plan

Parameters:

• p_requestId (string) – (required in path) requestId

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

• expand (boolean) – (optional in query) Detailed plan

async idem_vra.exec.vra.blueprint.blueprintrequests.list_blueprint_requests_using_get1(hub, ctx, **kwargs)

Lists blueprint requests Performs GET /blueprint/api/blueprint-requests

Parameters:

• orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is descending on updatedAt. Sorting is supported on fields createdAt, updatedAt, createdBy, updatedBy.

• select (array) – (optional in query) Fields to include in content.

• 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). For versioning information please refer to /blueprint/api/about

• deploymentId (string) – (optional in query) Deployment Id filter

• includePlan (boolean) – (optional in query) Plan Requests filter