REST API - summary

vcenter storage policies compliance: summary

Provides the details of a virtual machine and its associated entities which match the given compliance statuses. This structure was added in vSphere API 6.7.

Representation:

JSON
LEGACY JSON

{
    "disks" : {
        "obj-103" : "COMPLIANT"
    },
    "vm" : "obj-103",
    "vm_home" : "COMPLIANT"
}

{
    "disks" : [
        {
            "value" : "COMPLIANT",
            "key" : "obj-103"
        }
    ],
    "vm" : "obj-103",
    "vm_home" : "COMPLIANT"
}

Attributes:

Name	Type	Description
Required
-.vm	string	Identifier of virtual machine. This attribute was added in vSphere API 6.7. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `VirtualMachine`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `VirtualMachine`.
-.disks.*	string	This enumeration defines the set of status values for a compliance operation. 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 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 requirement that apply to the object-based datastore on which the entity is placed. This constant was added in vSphere API 6.7. OUT_OF_DATE: Compliance status becomes out of date when the profile associated with the entity is edited and not applied. The compliance status will remain out of date until the latest policy is applied to the entity. This constant was added in vSphere API 6.7.
Optional
-.vm_home	string	Compliance status of the virtual machine home. This attribute was added in vSphere API 6.7. Optional. If unset or empty, vmHome is not associated with a storage policy.
-.disks	object	List of the virtual hard disk. This attribute was added in vSphere API 6.7. Optional. If unset or empty, virtual machine entity 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 key/value pairs 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 key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Disk`.

Attributes:

Name	Type	Description
Required
vm	string	Identifier of virtual machine. This attribute was added in vSphere API 6.7. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `VirtualMachine`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `VirtualMachine`.
disks[].key	string
disks[].value	string	This enumeration defines the set of status values for a compliance operation. 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 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 requirement that apply to the object-based datastore on which the entity is placed. This constant was added in vSphere API 6.7. OUT_OF_DATE: Compliance status becomes out of date when the profile associated with the entity is edited and not applied. The compliance status will remain out of date until the latest policy is applied to the entity. This constant was added in vSphere API 6.7.
Optional
vm_home	string	Compliance status of the virtual machine home. This attribute was added in vSphere API 6.7. Optional. If unset or empty, vmHome is not associated with a storage policy.
disks	list	List of the virtual hard disk. This attribute was added in vSphere API 6.7. Optional. If unset or empty, virtual machine entity 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 key/value pairs 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 key/value pairs will be an identifier for the resource type: `com.vmware.vcenter.vm.hardware.Disk`.