project#

async idem_vra.exec.vra.iaas.project.create_project(hub, ctx, name, **kwargs)[source]#

Create project Create project Performs POST /iaas/api/projects

Parameters:

  • name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.

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

  • viewers (array) – (optional in body) List of viewer users associated with the project.

  • machineNamingTemplate (string) – (optional in body) The naming template to be used for machines provisioned in this project

  • customProperties (object) – (optional in body) The project custom properties which are added to all requests in this project

  • sharedResources (boolean) – (optional in body) Specifies whether the resources in this projects are shared or not. If not set default will be used.

  • operationTimeout (integer) – (optional in body) The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds

  • members (array) – (optional in body) List of member users associated with the project.

  • zoneAssignmentConfigurations (array) – (optional in body) List of configurations for zone assignment to a project.

  • description (string) – (optional in body) A human-friendly description.

  • placementPolicy (string) – (optional in body) Placement policy for the project. Determines how a zone will be selected for provisioning. DEFAULT, SPREAD or SPREAD_MEMORY.

  • constraints (object) – (optional in body) List of storage, network and extensibility constraints to be applied when provisioning through this project.

  • administrators (array) – (optional in body) List of administrator users associated with the project. Only administrators can manage project’s configuration.

async idem_vra.exec.vra.iaas.project.delete_project(hub, ctx, p_id, **kwargs)[source]#

Delete project Delete project with a given id Performs DELETE /iaas/api/projects/{id}

Parameters:

  • p_id (string) – (required in path) The ID of the project.

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

async idem_vra.exec.vra.iaas.project.get_project_resource_metadata(hub, ctx, p_id, **kwargs)[source]#

Get project resource metadata Get project resource metadata by a given project id Performs GET /iaas/api/projects/{id}/resource-metadata

Parameters:

  • p_id (string) – (required in path) The ID of the project.

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

async idem_vra.exec.vra.iaas.project.get_project(hub, ctx, p_id, **kwargs)[source]#

Get project Get project with a given id Performs GET /iaas/api/projects/{id}

Parameters:

  • p_id (string) – (required in path) The ID of the project.

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

async idem_vra.exec.vra.iaas.project.get_projects(hub, ctx, **kwargs)[source]#

Get projects Get all projects Performs GET /iaas/api/projects

Parameters:

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

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

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

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

  • count (boolean) – (optional in query) Flag which when specified, regardless of the assigned value, shows the total number of records. If the collection has a filter it shows the number of records matching the filter.

  • filter (string) – (optional in query) Filter the results by a specified predicate expression. A set of operators and functions are defined for use: Operators: eq, ne, gt, ge, lt, le, and, or, not. Functions: bool substringof(string p0, string p1) bool endswith(string p0, string p1) bool startswith(string p0, string p1) int length(string p0) int indexof(string p0, string p1) string replace(string p0, string find, string replace) string substring(string p0, int pos) string substring(string p0, int pos, int length) string tolower(string p0) string toupper(string p0) string trim(string p0) string concat(string p0, string p1)

async idem_vra.exec.vra.iaas.project.update_project_resource_metadata(hub, ctx, p_id, **kwargs)[source]#

Update project resource metadata Update project resource metadata by a given project id Performs PATCH /iaas/api/projects/{id}/resource-metadata

Parameters:

  • p_id (string) – (required in path) The ID of the project.

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

  • tags (array) – (optional in body) A list of keys and optional values to be applied to compute resources provisioned in a project

async idem_vra.exec.vra.iaas.project.update_project(hub, ctx, p_id, name, **kwargs)[source]#

Update project Update project Performs PATCH /iaas/api/projects/{id}

Parameters:

  • p_id (string) – (required in path) The ID of the project.

  • name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.

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

  • viewers (array) – (optional in body) List of viewer users associated with the project.

  • machineNamingTemplate (string) – (optional in body) The naming template to be used for machines provisioned in this project

  • customProperties (object) – (optional in body) The project custom properties which are added to all requests in this project

  • sharedResources (boolean) – (optional in body) Specifies whether the resources in this projects are shared or not. If not set default will be used.

  • operationTimeout (integer) – (optional in body) The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds

  • members (array) – (optional in body) List of member users associated with the project.

  • zoneAssignmentConfigurations (array) – (optional in body) List of configurations for zone assignment to a project.

  • description (string) – (optional in body) A human-friendly description.

  • placementPolicy (string) – (optional in body) Placement policy for the project. Determines how a zone will be selected for provisioning. DEFAULT, SPREAD or SPREAD_MEMORY.

  • constraints (object) – (optional in body) List of storage, network and extensibility constraints to be applied when provisioning through this project.

  • administrators (array) – (optional in body) List of administrator users associated with the project. Only administrators can manage project’s configuration.