1. Types
  2. vcenter
  3. vm
  4. storage
  5. policy
  6. compliance

vcenter vm storage policy compliance: vm compliance info

The vm_compliance_info structure contains information about storage policy compliance associated with a virtual machine. This structure was added in vSphere API 6.7

Representation:

{
    "check_time": "2015-01-01T22:13:05.651Z",
    "failure_cause": [
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        }
    ],
    "policy": "obj-103",
    "status": "COMPLIANT"
}

Attributes:

Name Type Description
Required
status string Status of the compliance operation. This attribute was added in vSphere API 6.7

Defines the storage compliance status of a virtual machine and its applicable entities. This enumeration was added in vSphere API 6.7 Value is one of:
COMPLIANT: Entity is in compliance. This constant was added in vSphere API 6.7
NON_COMPLIANT: Entity is out of compliance. This constant was added in vSphere API 6.7
UNKNOWN_COMPLIANCE: Compliance status of the entity is not known. This constant was added in vSphere API 6.7
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. This constant was added in vSphere API 6.7
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. This constant was added in vSphere API 6.7
check_time date_time Date and time of the most recent compliance check. This attribute was added in vSphere API 6.7
failure_cause localizable_message[] The exception that caused the compliance check to fail. There can be more than one cause, since a policy can contain capabilities from multiple providers. If empty, it implies no failures while retrieving compliance. This attribute was added in vSphere API 6.7
Optional
policy string Identifier of the storage policy associated with the virtual machine. This attribute was added in vSphere API 6.7

Optional. If unset SPBM is unable to retrieve or determine the associated policy, vcenter.vm.storage.policy.compliance.vm_compliance_info.failure_cause is set in such casses.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.