blueprint

async idem_vra.exec.vra.blueprint.blueprint.create_blueprint_using_post1(hub, ctx, name, projectId, **kwargs)

Creates a blueprint Performs POST /blueprint/api/blueprints

Parameters:

• name (string) – (required in body) Blueprint name

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

• 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

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

• contentSourceId (string) – (optional in body) Content source id

• contentSourcePath (string) – (optional in body) Content source path

• contentSourceSyncAt (string) – (optional in body) Content source last sync time

• contentSourceSyncMessages (array) – (optional in body) Content source last sync messages

• contentSourceSyncStatus (string) – (optional in body) Content source last sync status

• contentSourceType (string) – (optional in body) Content source type

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

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

• description (string) – (optional in body) Blueprint description

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

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

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

• requestScopeOrg (boolean) – (optional in body) Flag to indicate blueprint can be requested from any project in org

• selfLink (string) – (optional in body) Blueprint self link

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

• totalReleasedVersions (integer) – (optional in body) Total released versions

• totalVersions (integer) – (optional in body) Total versions

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

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

• valid (boolean) – (optional in body) Validation result on update

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

async idem_vra.exec.vra.blueprint.blueprint.create_blueprint_version_using_post1(hub, ctx, p_blueprintId, version, **kwargs)

Creates version for the given blueprint ID Performs POST /blueprint/api/blueprints/{blueprintId}/versions

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• version (string) – (required in body) Blueprint version

• 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

• changeLog (string) – (optional in body) Blueprint version change log

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

• release (boolean) – (optional in body) Flag indicating to release version

async idem_vra.exec.vra.blueprint.blueprint.delete_blueprint_using_delete1(hub, ctx, p_blueprintId, **kwargs)

Deletes a blueprint Performs DELETE /blueprint/api/blueprints/{blueprintId}

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• 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.blueprint.get_blueprint_inputs_schema_using_get1(hub, ctx, p_blueprintId, **kwargs)

Returns blueprint inputs schema Performs GET /blueprint/api/blueprints/{blueprintId}/inputs-schema

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• 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.blueprint.get_blueprint_using_get1(hub, ctx, p_blueprintId, **kwargs)

Returns blueprint details Performs GET /blueprint/api/blueprints/{blueprintId}

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

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

• 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.blueprint.get_blueprint_version_inputs_schema_using_get1(hub, ctx, p_blueprintId, p_version, **kwargs)

Returns blueprint version inputs schema Performs GET /blueprint/api/blueprints/{blueprintId}/versions/{version}/inputs-schema

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• p_version (string) – (required in path) version

• 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.blueprint.get_blueprint_version_using_get1(hub, ctx, p_blueprintId, p_version, **kwargs)

Returns versioned blueprint details Performs GET /blueprint/api/blueprints/{blueprintId}/versions/{version}

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• p_version (string) – (required in path) version

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

async idem_vra.exec.vra.blueprint.blueprint.list_blueprint_versions_using_get(hub, ctx, p_blueprintId, **kwargs)

Lists blueprint versions Performs GET /blueprint/api/blueprints/{blueprintId}/versions

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• 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, name, version.

• 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

• propertyGroups (array) – (optional in query) Filter versions with any of the specified property groups

• status (string) – (optional in query) Filter by blueprint status: versioned / released

• version (string) – (optional in query) Filter by version

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

Lists draft blueprint Performs GET /blueprint/api/blueprints

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, name.

• 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

• name (string) – (optional in query) Filter by name

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

• propertyGroups (array) – (optional in query) Filter blueprints with any of the specified property groups

• released (boolean) – (optional in query) Filter blueprints with at least one released version

• search (string) – (optional in query) Search by name and description

• versioned (boolean) – (optional in query) Filter blueprints with at least one version

async idem_vra.exec.vra.blueprint.blueprint.release_blueprint_version_using_post1(hub, ctx, p_blueprintId, p_version, **kwargs)

Release versioned blueprint to catalog Performs POST /blueprint/api/blueprints/{blueprintId}/versions/{version}/actions/release

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• p_version (string) – (required in path) version

• 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.blueprint.restore_blueprint_version_using_post1(hub, ctx, p_blueprintId, p_version, **kwargs)

Restores content of draft from versioned blueprint Performs POST /blueprint/api/blueprints/{blueprintId}/versions/{version}/actions/restore

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• p_version (string) – (required in path) version

• 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.blueprint.un_release_blueprint_version_using_post1(hub, ctx, p_blueprintId, p_version, **kwargs)

UnRelease versioned blueprint from catalog Performs POST /blueprint/api/blueprints/{blueprintId}/versions/{version}/actions/unrelease

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• p_version (string) – (required in path) version

• 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.blueprint.update_blueprint_using_put1(hub, ctx, p_blueprintId, name, projectId, **kwargs)

Updates a blueprint Performs PUT /blueprint/api/blueprints/{blueprintId}

Parameters:

• p_blueprintId (string) – (required in path) blueprintId

• name (string) – (required in body) Blueprint name

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

• 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

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

• contentSourceId (string) – (optional in body) Content source id

• contentSourcePath (string) – (optional in body) Content source path

• contentSourceSyncAt (string) – (optional in body) Content source last sync time

• contentSourceSyncMessages (array) – (optional in body) Content source last sync messages

• contentSourceSyncStatus (string) – (optional in body) Content source last sync status

• contentSourceType (string) – (optional in body) Content source type

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

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

• description (string) – (optional in body) Blueprint description

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

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

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

• requestScopeOrg (boolean) – (optional in body) Flag to indicate blueprint can be requested from any project in org

• selfLink (string) – (optional in body) Blueprint self link

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

• totalReleasedVersions (integer) – (optional in body) Total released versions

• totalVersions (integer) – (optional in body) Total versions

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

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

• valid (boolean) – (optional in body) Validation result on update

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