Get Storage Policy Compliance Deprecated
Returns the cached storage policy compliance information of a virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/storage/policy/compliance
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
VmStoragePolicyComplianceGetResponseBody of type application/json
Virtual machine storage policy compliance Info Compliance.Info. If unset, neither the virtual machine home directory nor any of it’s virtual disks are associated with a storage policy.
{
"value": {
"disks": [
{
"key": "key1",
"value": {
"check_time": "string",
"failure_cause": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
}
],
"policy": "string",
"status": "COMPLIANT"
}
}
],
"overall_compliance": "COMPLIANT",
"vm_home": {
"check_time": "string",
"failure_cause": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
}
],
"policy": "string",
"status": "COMPLIANT"
}
}
}
value
Optional
Virtual machine storage policy compliance Info Compliance.Info. If unset, neither the virtual machine home directory nor any of it’s virtual disks are associated with a storage policy.
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.
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
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/storage/policy/compliance
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/vcenter/vm/{vm}/storage/policy/compliance
x-vmw-doc-operation: get
Availability
Added in 6.7
