catalogitems

async idem_vra.exec.vra.catalog.catalogitems.get_catalog_item_using_get5(hub, ctx, p_id, **kwargs)

Find a catalog item with specified ID. Returns the catalog item with the specified ID. Performs GET /catalog/api/items/{id}

Parameters:

• p_id (string) – (required in path) Catalog item 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.

• expandProjects (boolean) – (optional in query) Retrieves the ‘projects’ field of the catalog item

async idem_vra.exec.vra.catalog.catalogitems.get_catalog_items_using_get5(hub, ctx, **kwargs)

Fetch a list of catalog items. Returns a paginated list of catalog items. Performs GET /catalog/api/items

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.

• expandProjects (boolean) – (optional in query) Whether or not to return detailed project data for each result.

• projects (array) – (optional in query) A list of project IDs. Results will belong to one of these projects.

• search (string) – (optional in query) Matches will have this string somewhere in their name or description.

• types (array) – (optional in query) A list of Catalog Item Type IDs. Results will be one of these types.

async idem_vra.exec.vra.catalog.catalogitems.get_upfront_price_response_for_catalog_item_using_get2(hub, ctx, p_id, p_upfrontPriceId, **kwargs)

Get a response with upfront prices for a given catalog item. Returns upfront prices of a given catalog item. Performs GET /catalog/api/items/{id}/upfront-prices/{upfrontPriceId}

Parameters:

• p_id (string) – (required in path) Catalog Item ID

• p_upfrontPriceId (string) – (required in path) Upfront Price 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.catalogitems.get_version_by_id_using_get2(hub, ctx, p_id, p_versionId, **kwargs)

Fetch detailed catalog item version. Returns a detailed catalog item version. Performs GET /catalog/api/items/{id}/versions/{versionId}

Parameters:

• p_id (string) – (required in path) Catalog Item ID

• p_versionId (string) – (required in path) Catalog Item Version 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.catalogitems.get_versions_using_get2(hub, ctx, p_id, **kwargs)

Fetch a list of catalog items with versions. Returns a paginated list of catalog item versions. Performs GET /catalog/api/items/{id}/versions

Parameters:

• p_id (string) – (required in path) Catalog Item 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.

• page (integer) – (optional in query) Results page you want to retrieve (0..N)

• size (integer) – (optional in query) Number of records per page.

async idem_vra.exec.vra.catalog.catalogitems.request_catalog_item_instances_using_post1(hub, ctx, p_id, **kwargs)

Create deployments. Creates deployments from a catalog item. Performs POST /catalog/api/items/{id}/request

Parameters:

• p_id (string) – (required in path) Catalog item 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.

• bulkRequestCount (integer) – (optional in body) Deployment request count; defaults to 1 if not specified.

• deploymentName (string) – (optional in body) Name of the requested deployment

• inputs (object) – (optional in body) Input parameters for the request. These must be compliant with the schema of the corresponding catalog item

• projectId (string) – (optional in body) Project to be used for the request

• reason (string) – (optional in body) Reason for request

• version (string) – (optional in body) Version of the catalog item. e.g. v2.0

async idem_vra.exec.vra.catalog.catalogitems.submit_upfront_price_request_for_catalog_item_using_post2(hub, ctx, p_id, **kwargs)

Create a request to calculate upfront price for a given catalog item. Returns upfront price response for a given catalog item. Performs POST /catalog/api/items/{id}/upfront-prices

Parameters:

• p_id (string) – (required in path) Catalog Item 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.

• bulkRequestCount (integer) – (optional in body) Deployment request count; defaults to 1 if not specified.

• deploymentName (string) – (optional in body) Name of the requested deployment

• inputs (object) – (optional in body) Input parameters for the request. These must be compliant with the schema of the corresponding catalog item

• projectId (string) – (optional in body) Project to be used for the request

• reason (string) – (optional in body) Reason for request

• version (string) – (optional in body) Version of the catalog item. e.g. v2.0