storageprofile#
- async idem_vra.exec.vra.iaas.storageprofile.create_aws_storage_profile(hub, ctx, deviceType, regionId, name, **kwargs)[source]#
Create AWS storage profile Create AWS storage profile Performs POST /iaas/api/storage-profiles-aws
- Parameters:
deviceType (string) – (required in body) Indicates the type of storage.
regionId (string) – (required in body) A link to the region that is associated with the storage profile.
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
volumeType (string) – (optional in body) Indicates the type of volume associated with type of storage.
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
iops (string) – (optional in body) Indicates maximum I/O operations per second in range(1-20,000).
description (string) – (optional in body) A human-friendly description.
defaultItem (boolean) – (optional in body) Indicates if a storage profile is default or not.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile
- async idem_vra.exec.vra.iaas.storageprofile.create_azure_storage_profile(hub, ctx, regionId, name, **kwargs)[source]#
Create Azure storage profile Create Azure storage profile Performs POST /iaas/api/storage-profiles-azure
- Parameters:
regionId (string) – (required in body) The If of the region that is associated with the storage profile.
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
storageAccountId (string) – (optional in body) Id of a storage account where in the disk is placed.
supportsEncryption (boolean) – (optional in body) Indicates whether this storage policy should support encryption or not.
description (string) – (optional in body) A human-friendly description.
defaultItem (boolean) – (optional in body) Indicates if a storage policy contains default storage properties.
diskType (string) – (optional in body) Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
dataDiskCaching (string) – (optional in body) Indicates the caching mechanism for additional disk.
osDiskCaching (string) – (optional in body) Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.
diskEncryptionSetId (string) – (optional in body) Indicates the id of disk encryption set.
tags (array) – (optional in body) A set of tag keys and optional values for a storage policy which define set of specifications for creating a disk.
- async idem_vra.exec.vra.iaas.storageprofile.create_gcp_storage_profile(hub, ctx, regionId, name, persistentDiskType, **kwargs)[source]#
Create GCP storage profile Create GCP storage profile Performs POST /iaas/api/storage-profiles-gcp
- Parameters:
regionId (string) – (required in body) A link to the region that is associated with the storage profile.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
persistentDiskType (string) – (required in body) Indicates the type of disk.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
description (string) – (optional in body) A human-friendly description.
defaultItem (boolean) – (optional in body) Indicates if a storage profile is default or not.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile
- async idem_vra.exec.vra.iaas.storageprofile.create_storage_profile(hub, ctx, regionId, name, defaultItem, **kwargs)[source]#
Create storage profile Create storage profile Performs POST /iaas/api/storage-profiles
- Parameters:
regionId (string) – (required in body) The Id of the region that is associated with the storage profile.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
defaultItem (boolean) – (required in body) Indicates if a storage profile is a default profile.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
diskProperties (object) – (optional in body) Map of storage properties that are to be applied on disk while provisioning.
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
diskTargetProperties (object) – (optional in body) Map of storage placements to know where the disk is provisioned.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile
- async idem_vra.exec.vra.iaas.storageprofile.create_v_sphere_storage_profile(hub, ctx, regionId, name, defaultItem, **kwargs)[source]#
Create vSphere storage profile Create vSphere storage profile Performs POST /iaas/api/storage-profiles-vsphere
- Parameters:
regionId (string) – (required in body) The Id of the region that is associated with the storage profile.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
defaultItem (boolean) – (required in body) Indicates if a storage profile acts as a default storage profile for a disk.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
sharesLevel (string) – (optional in body) Shares are specified as High, Normal, Low or Custom and these values specify share values with a 4:2:1 ratio, respectively.
description (string) – (optional in body) A human-friendly description.
diskMode (string) – (optional in body) Type of mode for the disk
storagePolicyId (string) – (optional in body) Id of the vSphere Storage Policy to be applied.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile.
shares (string) – (optional in body) A specific number of shares assigned to each virtual machine.
provisioningType (string) – (optional in body) Type of provisioning policy for the disk.
limitIops (string) – (optional in body) The upper bound for the I/O operations per second allocated for each virtual disk.
diskType (string) – (optional in body) Disk types are specified as Standard - Simple vSphere virtual disks which cannot be managed independently without an attached VM. First Class - Improved version of standard virtual disks, designed to be fully mananged independent storage objects. Empty value is considered as Standard
datastoreId (string) – (optional in body) Id of the vSphere Datastore for placing disk and VM.
- async idem_vra.exec.vra.iaas.storageprofile.delete_aws_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Delete AWS storage profile Delete AWS storage profile with a given id Performs DELETE /iaas/api/storage-profiles-aws/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
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.storageprofile.delete_azure_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Delete Azure storage profile Delete Azure storage profile with a given id Performs DELETE /iaas/api/storage-profiles-azure/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
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.storageprofile.delete_gcp_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Delete GCP storage profile Delete GCP storage profile with a given id Performs DELETE /iaas/api/storage-profiles-gcp/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
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.storageprofile.delete_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Delete storage profile Delete storage profile with a given id Performs DELETE /iaas/api/storage-profiles/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
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.storageprofile.delete_v_sphere_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Delete vSphere storage profile Delete vSphere storage profile with a given id Performs DELETE /iaas/api/storage-profiles-vsphere/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
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.storageprofile.get_aws_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Get AWS storage profile Get AWS storage profile with a given id Performs GET /iaas/api/storage-profiles-aws/{id}
- Parameters:
p_id (string) – (required in path) The ID of storage profile.
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.storageprofile.get_aws_storage_profiles(hub, ctx, **kwargs)[source]#
Get AWS storage profiles Get all AWS storage profiles Performs GET /iaas/api/storage-profiles-aws
- 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
- async idem_vra.exec.vra.iaas.storageprofile.get_azure_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Get Azure storage profile Get Azure storage profile with a given id Performs GET /iaas/api/storage-profiles-azure/{id}
- Parameters:
p_id (string) – (required in path) The ID of storage profile.
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.storageprofile.get_azure_storage_profiles(hub, ctx, **kwargs)[source]#
Get Azure storage profiles Get all Azure storage profiles Performs GET /iaas/api/storage-profiles-azure
- 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
- async idem_vra.exec.vra.iaas.storageprofile.get_gcp_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Get GCP storage profile Get GCP storage profile with a given id Performs GET /iaas/api/storage-profiles-gcp/{id}
- Parameters:
p_id (string) – (required in path) The ID of storage profile.
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.storageprofile.get_gcp_storage_profiles(hub, ctx, **kwargs)[source]#
Get GCP storage profiles Get all GCP storage profiles Performs GET /iaas/api/storage-profiles-gcp
- 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
- async idem_vra.exec.vra.iaas.storageprofile.get_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Get storage profile Get storage profile with a given id Performs GET /iaas/api/storage-profiles/{id}
- Parameters:
p_id (string) – (required in path) The ID of storage profile.
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.storageprofile.get_storage_profiles(hub, ctx, **kwargs)[source]#
Get storage profiles Get all storage profiles Performs GET /iaas/api/storage-profiles
- 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
- async idem_vra.exec.vra.iaas.storageprofile.get_v_sphere_storage_profile(hub, ctx, p_id, **kwargs)[source]#
Get vSphere storage profile Get vSphere storage profile with a given id Performs GET /iaas/api/storage-profiles-vsphere/{id}
- Parameters:
p_id (string) – (required in path) The ID of storage profile.
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.storageprofile.get_v_sphere_storage_profiles(hub, ctx, **kwargs)[source]#
Get vSphere storage profiles Get all vSphere storage profiles Performs GET /iaas/api/storage-profiles-vsphere
- 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
- async idem_vra.exec.vra.iaas.storageprofile.replace_storage_profile(hub, ctx, p_id, regionId, name, defaultItem, **kwargs)[source]#
Replace storage profile Replace storage profile with a given id Performs PUT /iaas/api/storage-profiles/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
regionId (string) – (required in body) The Id of the region that is associated with the storage profile.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
defaultItem (boolean) – (required in body) Indicates if a storage profile is a default profile.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
diskProperties (object) – (optional in body) Map of storage properties that are to be applied on disk while provisioning.
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
diskTargetProperties (object) – (optional in body) Map of storage placements to know where the disk is provisioned.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile
- async idem_vra.exec.vra.iaas.storageprofile.update_aws_storage_profile(hub, ctx, p_id, deviceType, regionId, name, **kwargs)[source]#
Update AWS storage profile Update AWS storage profile Performs PATCH /iaas/api/storage-profiles-aws/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
deviceType (string) – (required in body) Indicates the type of storage.
regionId (string) – (required in body) A link to the region that is associated with the storage profile.
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
volumeType (string) – (optional in body) Indicates the type of volume associated with type of storage.
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
iops (string) – (optional in body) Indicates maximum I/O operations per second in range(1-20,000).
description (string) – (optional in body) A human-friendly description.
defaultItem (boolean) – (optional in body) Indicates if a storage profile is default or not.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile
- async idem_vra.exec.vra.iaas.storageprofile.update_azure_storage_profile(hub, ctx, p_id, regionId, name, **kwargs)[source]#
Update Azure storage profile Update Azure storage profile Performs PATCH /iaas/api/storage-profiles-azure/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
regionId (string) – (required in body) The If of the region that is associated with the storage profile.
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
storageAccountId (string) – (optional in body) Id of a storage account where in the disk is placed.
supportsEncryption (boolean) – (optional in body) Indicates whether this storage policy should support encryption or not.
description (string) – (optional in body) A human-friendly description.
defaultItem (boolean) – (optional in body) Indicates if a storage policy contains default storage properties.
diskType (string) – (optional in body) Indicates the performance tier for the storage type. Premium disks are SSD backed and Standard disks are HDD backed.
dataDiskCaching (string) – (optional in body) Indicates the caching mechanism for additional disk.
osDiskCaching (string) – (optional in body) Indicates the caching mechanism for OS disk. Default policy for OS disks is Read/Write.
diskEncryptionSetId (string) – (optional in body) Indicates the id of disk encryption set.
tags (array) – (optional in body) A set of tag keys and optional values for a storage policy which define set of specifications for creating a disk.
- async idem_vra.exec.vra.iaas.storageprofile.update_gcp_storage_profile(hub, ctx, p_id, regionId, name, persistentDiskType, **kwargs)[source]#
Update GCP storage profile Update GCP storage profile Performs PATCH /iaas/api/storage-profiles-gcp/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
regionId (string) – (required in body) A link to the region that is associated with the storage profile.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
persistentDiskType (string) – (required in body) Indicates the type of disk.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
description (string) – (optional in body) A human-friendly description.
defaultItem (boolean) – (optional in body) Indicates if a storage profile is default or not.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile
- async idem_vra.exec.vra.iaas.storageprofile.update_v_sphere_storage_profile(hub, ctx, p_id, regionId, name, defaultItem, **kwargs)[source]#
Update vSphere storage profile Update vSphere storage profile Performs PATCH /iaas/api/storage-profiles-vsphere/{id}
- Parameters:
p_id (string) – (required in path) The ID of the storage profile.
regionId (string) – (required in body) The Id of the region that is associated with the storage profile.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
defaultItem (boolean) – (required in body) Indicates if a storage profile acts as a default storage profile for a disk.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
supportsEncryption (boolean) – (optional in body) Indicates whether this storage profile supports encryption or not.
sharesLevel (string) – (optional in body) Shares are specified as High, Normal, Low or Custom and these values specify share values with a 4:2:1 ratio, respectively.
description (string) – (optional in body) A human-friendly description.
diskMode (string) – (optional in body) Type of mode for the disk
storagePolicyId (string) – (optional in body) Id of the vSphere Storage Policy to be applied.
tags (array) – (optional in body) A list of tags that represent the capabilities of this storage profile.
shares (string) – (optional in body) A specific number of shares assigned to each virtual machine.
provisioningType (string) – (optional in body) Type of provisioning policy for the disk.
limitIops (string) – (optional in body) The upper bound for the I/O operations per second allocated for each virtual disk.
diskType (string) – (optional in body) Disk types are specified as Standard - Simple vSphere virtual disks which cannot be managed independently without an attached VM. First Class - Improved version of standard virtual disks, designed to be fully mananged independent storage objects. Empty value is considered as Standard
datastoreId (string) – (optional in body) Id of the vSphere Datastore for placing disk and VM.