location#

async idem_vra.exec.vra.iaas.location.create_zone(hub, ctx, regionId, name, **kwargs)[source]#

Create zone Create zone Performs POST /iaas/api/zones

Parameters:
  • regionId (string) – (required in body) The id of the region for which this profile is created

  • 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

  • customProperties (object) – (optional in body) A list of key value pair of properties that will be used

  • folder (string) – (optional in body) The folder relative path to the datacenter where resources are deployed to. (only applicable for vSphere cloud zones)

  • computeIds (array) – (optional in body) The ids of the compute resources that will be explicitly assigned to this zone

  • tagsToMatch (array) – (optional in body) A set of tag keys and optional values that will be used

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

  • placementPolicy (string) – (optional in body) Placement policy for the zone. One of DEFAULT, SPREAD, BINPACK or SPREAD_MEMORY.

  • tags (array) – (optional in body) A set of tag keys and optional values that are effectively applied to all compute resources in this zone, but only in the context of this zone.

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

Delete a zone Delete a zone Performs DELETE /iaas/api/zones/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the zone.

  • 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.location.get_computes(hub, ctx, p_id, **kwargs)[source]#

Get computes Get zone’s computes by given zone ID Performs GET /iaas/api/zones/{id}/computes

Parameters:
  • p_id (string) – (required in path) The ID of the zone.

  • 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.location.get_region(hub, ctx, p_id, **kwargs)[source]#

Get Region Get Region with a given id Performs GET /iaas/api/regions/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the region.

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

Get regions Get all regions Performs GET /iaas/api/regions

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.

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

Get zone Get zone with given id Performs GET /iaas/api/zones/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the zone.

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

Get zones Get all zones Performs GET /iaas/api/zones

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.

async idem_vra.exec.vra.iaas.location.update_zone(hub, ctx, p_id, regionId, name, **kwargs)[source]#

Update zone Update zone Performs PATCH /iaas/api/zones/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the zone.

  • regionId (string) – (required in body) The id of the region for which this profile is created

  • 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

  • customProperties (object) – (optional in body) A list of key value pair of properties that will be used

  • folder (string) – (optional in body) The folder relative path to the datacenter where resources are deployed to. (only applicable for vSphere cloud zones)

  • computeIds (array) – (optional in body) The ids of the compute resources that will be explicitly assigned to this zone

  • tagsToMatch (array) – (optional in body) A set of tag keys and optional values that will be used

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

  • placementPolicy (string) – (optional in body) Placement policy for the zone. One of DEFAULT, SPREAD, BINPACK or SPREAD_MEMORY.

  • tags (array) – (optional in body) A set of tag keys and optional values that are effectively applied to all compute resources in this zone, but only in the context of this zone.