policies#

async idem_vra.exec.vra.catalog.policies.delete_policy_using_delete5(hub, ctx, p_id, **kwargs)[source]#

Delete a policy Delete a specified policy corresponding to its unique id. Performs DELETE /policy/api/policies/{id}

Parameters:

  • p_id (string) – (required in path) Policy 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.policies.dry_run_policy_using_post2(hub, ctx, q_dryRun, typeId, **kwargs)[source]#

Trigger a policy dry-run. Dry-run an existing policy to rehearse actual policy effect on application. Performs POST /policy/api/policies

Parameters:

  • q_dryRun (string) – (required in query)

  • typeId (string) – (required in body) The policy type 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.

  • createdAt (string) – (optional in body) Policy creation timestamp.

  • createdBy (string) – (optional in body) Policy author.

  • criteria (Any) – (optional in body)

  • definition (object) – (optional in body) Policy-type-specific settings such as lease limits for lease policies.

  • definitionLegend (object) – (optional in body)

  • description (string) – (optional in body) The policy description.

  • enforcementType (string) – (optional in body) Defines enforcement type for policy. Default enforcement type is HARD.

  • id (string) – (optional in body) The policy ID.

  • lastUpdatedAt (string) – (optional in body) Most recent policy update timestamp.

  • lastUpdatedBy (string) – (optional in body) Most recent policy editor.

  • name (string) – (optional in body) The policy name.

  • orgId (string) – (optional in body) The ID of the organization to which the policy belongs.

  • projectId (string) – (optional in body) For project-scoped policies, the ID of the project to which the policy belongs.

  • scopeCriteria (Any) – (optional in body)

  • statistics (Any) – (optional in body)

async idem_vra.exec.vra.catalog.policies.get_policies_using_get5(hub, ctx, **kwargs)[source]#

Returns a paginated list of policies. Find all the policies associated with current org. Performs GET /policy/api/policies

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.

  • computeStats (boolean) – (optional in query) computeStats

  • expandDefinition (boolean) – (optional in query) Retrieves policy definition information for each returned policy.

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

async idem_vra.exec.vra.catalog.policies.get_policy_using_get5(hub, ctx, p_id, **kwargs)[source]#

Returns a specified policy. Find a specific policy based on the input policy id. Performs GET /policy/api/policies/{id}

Parameters:

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

  • computeStats (boolean) – (optional in query) computeStats