requests#

async idem_vra.exec.vra.catalog.requests.action_deployment_request_using_post2(hub, ctx, q_action, p_requestId, **kwargs)[source]#
Submit action on requests. Allowable values: cancel, dismiss. Cancel can be submitted on In-progress requests and Dismiss can be submitted on

Failed requests. Performs POST /deployment/api/requests/{requestId}

Parameters:

  • q_action (string) – (required in query) action

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

  • 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.requests.get_deployment_requests_using_get2(hub, ctx, p_deploymentId, **kwargs)[source]#

Fetch deployment requests. Returns the requests for the deployment. Performs GET /deployment/api/deployments/{deploymentId}/requests

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.

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

  • inprogressRequests (boolean) – (optional in query) Retrieves the requests that are currently in-progress for a deployment. Incase of a false value the param is ignored.

async idem_vra.exec.vra.catalog.requests.get_event_logs_content_using_get2(hub, ctx, p_eventId, p_requestId, **kwargs)[source]#

Fetch Event logs content as a file. Returns the log file for an event. Performs GET /deployment/api/requests/{requestId}/events/{eventId}/logs/download

Parameters:

  • p_eventId (string) – (required in path) Event ID

  • p_requestId (string) – (required in path) Request 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.requests.get_event_logs_using_get2(hub, ctx, p_eventId, p_requestId, **kwargs)[source]#

Fetch Event logs. Returns the logs for an event. Performs GET /deployment/api/requests/{requestId}/events/{eventId}/logs

Parameters:

  • p_eventId (string) – (required in path) Event ID

  • p_requestId (string) – (required in path) Request 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.

  • sinceRow (integer) – (optional in query) A positive row number from which to show logs.

async idem_vra.exec.vra.catalog.requests.get_request_events_using_get2(hub, ctx, p_requestId, **kwargs)[source]#

Fetch Request events. Returns all the events for a request. Performs GET /deployment/api/requests/{requestId}/events

Parameters:

  • p_requestId (string) – (required in path) Request 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.requests.get_request_using_get2(hub, ctx, p_requestId, **kwargs)[source]#

Get the Request. Returns the request with the given ID. Performs GET /deployment/api/requests/{requestId}

Parameters:

  • p_requestId (string) – (required in path) Request 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.requests.list_resource_requests_using_get2(hub, ctx, p_resourceId, **kwargs)[source]#

Get all requests for a resource Performs GET /deployment/api/resources/{resourceId}/requests

Parameters:

  • p_resourceId (string) – (required in path) Resource 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.