This API has a deprecated equivalent from v7.0U1.
List Policies VM
Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
Request
URLURL
https://{api_host}/api/vcenter/storage/policies/{policy}/vm
Path Parameters
Path Parameters
string
policy
Required
storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.
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
map of
StoragePoliciesVMInfo
of type application/json
Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the result map will be an identifier for the resource type: VirtualMachine.
{
"disks": [
"string"
],
"vm_home": false
}
array of
string
disks
Required
List of the virtual disks that are associated with the given storage policy. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.
boolean
vm_home
Required
Flag to indicate whether or not the virtual machine home is associated with the given storage policy.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the required priveleges.
404
com.vmware.vapi.std.errors.not_found : if there is no policy associated with policy in the system.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 1000 virtual machines are associated with the specified policy. | com.vmware.vapi.std.errors.error : if the backend server encounters some an error while processing the request.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service necessary 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-ListPolicyPoliciesVm -Policy "MyPolicy"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/storage/policies/{policy}/vm
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/storage/policies/{policy}/vm
x-vmw-doc-operation: list
Availability
Added in 7.0U2
