This API has a deprecated equivalent from v7.0U1.
Check Storage Policy Compliance
Returns the storage policy Compliance Compliance.Info of a virtual machine after explicitly re-computing compliance check.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/storage/policy/compliance?action=check
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"
Request Body
Request Body
VmStoragePolicyComplianceCheckSpec of mimetype application/json
Optional
Parameter specifies the entities on which storage policy compliance check is to be invoked. The storage compliance Info Compliance.Info is returned. If unset, the behavior is equivalent to a Compliance.CheckSpec with CheckSpec#vmHome set to true and CheckSpec#disks populated with all disks attached to the virtual machine.
{
"vm_home": false
}
boolean
vm_home
Required
Invoke compliance check on the virtual machine home directory if set to true.
array of
string
disks
Optional
Identifiers of the virtual machine’s virtual disks for which compliance should be checked. If unset or empty, compliance check is invoked on all the associated disks. 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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmStoragePolicyComplianceInfo
of type application/json
Virtual machine storage policy compliance Compliance.Info structure . If unset, neither the virtual machine home directory nor any of it’s virtual disks are associated with a storage policy.
{
"disks": {
"key": {
"check_time": "string",
"failure_cause": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"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": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"policy": "string",
"status": "COMPLIANT"
}
}
disks
Required
The compliance information Compliance.VmComplianceInfo for the virtual machine’s virtual disks that are currently 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.
overall_compliance
Required
The Compliance.Status enumerated type defines the storage compliance status of a virtual machine and its applicable entities.
COMPLIANT : Entity is in compliance.
NON_COMPLIANT : Entity is out of compliance.
UNKNOWN_COMPLIANCE : Compliance status of the entity is not known.
NOT_APPLICABLE : Compliance computation is not applicable for this entity because it does not have any storage requirements that apply to the datastore on which it is placed.
OUT_OF_DATE : The Compliance status becomes out-of-date when the profile associated with the entity is edited but not applied. The compliance status remains out-of-date until the edited policy is applied to the entity.
Possible values are: COMPLIANT , NON_COMPLIANT , UNKNOWN_COMPLIANCE , NOT_APPLICABLE , OUT_OF_DATE
vm_home
Optional
The storage policy compliance information Compliance.VmComplianceInfo for the virtual machine’s home directory. If unset the virtual machine home directory has no storage policy association.
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 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-CheckVmPolicyCompliance -Vm "MyVm"
PowerCLI Client SDK All Parameters Example
$VmStoragePolicyComplianceCheckSpec = Initialize-VmStoragePolicyComplianceCheckSpec -VmHome $false -Disks "MyDisks"
Invoke-CheckVmPolicyCompliance -Vm "MyVm" -VmStoragePolicyComplianceCheckSpec $VmStoragePolicyComplianceCheckSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"disks":["string"],"vm_home":false}' https://{api_host}/api/vcenter/vm/{vm}/storage/policy/compliance?action=check
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/storage/policy/compliance?action=check
x-vmw-doc-operation: check
Availability
Added in 7.0U2
