This API has a deprecated equivalent from v7.0U1.
List Policies Compliance VM
DescriptionReturns compliance information about at most 1000 virtual machines matching the filter VM.FilterSpec. If there are no virtual machines matching the VM.FilterSpec an empty List is returned. Virtual machines without storage policy association are not returned.
Request
URLURL
https://{api_host}/api/vcenter/storage/policies/compliance/vm
Query Parameters
Query Parameters
array
status
Required
Compliance Status that a virtual machine must have to match the filter. Atleast one status must be specified.
array
vms
Optional
Identifiers of virtual machines that can match the filter
If unset or empty, virtual machines with any identifier matches the filter
When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Response
Response
Response BodyResponse Body
200 OK returns
map of
StoragePoliciesComplianceVMInfo of type application/json
compliance information about virtual machines matching the filter VM.FilterSpec. The key in the result map will be an identifier for the resource type: VirtualMachine.
{
"disks": "enum",
"vm_home": "enum"
}
disks
Required
A Map of virtual disks and their compliance status If 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.
Possible values are: COMPLIANT , NON_COMPLIANT , UNKNOWN_COMPLIANCE , NOT_APPLICABLE , OUT_OF_DATE
vm_home
Optional
Compliance status of the virtual machine home. If unset or empty, virtual machine home is not associated with a storage policy.
Possible values are: COMPLIANT , NON_COMPLIANT , UNKNOWN_COMPLIANCE , NOT_APPLICABLE , OUT_OF_DATE
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/storage/policies/compliance/vm?status=string&
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the VM.FilterSpec.status field contains a value that is not supported by the server. | com.vmware.vapi.std.errors.unsupported : if the API is invoked against vCenter Server version is less than 6.5
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.unable_to_allocate_resource : If more than 1000 results match the VM.FilterSpec
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
Availability
Added in 7.0U2
