This API has a deprecated equivalent from v7.0U1.
Get Storage Policy
Returns Information about Storage Policy associated with a virtual machine’s home directory and/or its virtual hard disks.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/storage/policy
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmStoragePolicyInfo
of type application/json
Overview of Storage Policy associated with a virtual machine’s home directory and/or its associated virtual hard disks.
{
"disks": {
"key": "string"
},
"vm_home": "string"
}
map of
string
disks
Required
Storage policies associated with virtual disks. The values in this map are storage policy identifiers. They will be identifiers for the resource type:com.vmware.vcenter.StoragePolicy If the map is empty, the virtual machine does not have any disks or its disks are not associated with a storage policy. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
string
vm_home
Optional
Storage Policy associated with virtual machine home. Ifunset, the virtual machine’s home directory doesn’t have any storage policy. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmStoragePolicy -Vm "MyVm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/storage/policy
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/storage/policy
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Storage Policy Operations
patch
