Vcenter Vm Storage Policy Compliance check
Returns the storage policy Compliance Vcenter Vm Storage Policy Compliance Info of a virtual machine after explicitly re-computing compliance check.
This operation was added in vSphere API 6.7.
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
Parameter specifies the entities on which storage policy compliance check is to be invoked. The storage compliance Info Vcenter Vm Storage Policy Compliance Info is returned.
If missing or null, the behavior is equivalent to a Vcenter Vm Storage Policy Compliance CheckSpec with CheckSpec#vmHome set to true and CheckSpec#disks populated with all disks attached to the virtual machine.
Show optional properties
{
"vm_home": false
}{
"vm_home": false,
"disks": [
"string"
]
}Invoke compliance check on the virtual machine home directory if set to true.
This property was added in vSphere API 6.7.
Identifiers of the virtual machine's virtual disks for which compliance should be checked.
This property was added in vSphere API 6.7.
If missing or null or empty, compliance check is invoked on all the associated disks.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.
Virtual machine storage policy compliance Vcenter Vm Storage Policy Compliance Info schema .
If missing or null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.
"Vcenter Vm Storage Policy Compliance Info Object"The overall compliance status of the virtual machine and all it's entities.
For more information see: Vcenter Vm Storage Policy Compliance Status.
This property was added in vSphere API 6.7.
The storage policy compliance information Vcenter Vm Storage Policy Compliance VmComplianceInfo for the virtual machine's home directory.
This property was added in vSphere API 6.7.
If missing or null the virtual machine home directory has no storage policy association.
The compliance information Vcenter Vm Storage Policy Compliance VmComplianceInfo for the virtual machine's virtual disks that are currently associated with a storage policy.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have the required privileges.
"Vapi Std Errors Unauthorized Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the system is unable to communicate with a service necessary to complete the request.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"vm_home:"boolean"}' https://{api_host}/api/vcenter/vm/{vm}/storage/policy/compliance?action=check