Esx.Settings.Clusters.Configuration.HostCompliance

Esx.Settings.Clusters.Configuration.HostCompliance
Esx.Settings.Clusters.Configuration.HostCompliance

The Esx.Settings.Clusters.Configuration.HostCompliance schema contains properties that describe compliance information for the ESXi host on which the Check Compliance operation completed successfully.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "status": "string",
    "compliance_info": {
        "sets": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string",
                "error": {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            }
        ],
        "adds": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string",
                "error": {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            }
        ],
        "deletes": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string",
                "error": {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            }
        ]
    }
}
string
status
Required

This field indicates whether the ESXi host is compliant with the desired configuration specified in com.vmware.esx.settings_daemon.Configuration#CheckComplianceSpec. If COMPLIANT, no other information is available. If NON_COMPLAINT, drift information can be fetched from {#ComplianceInfo}

Possible values:

  • COMPLIANT: ESXi host is in compliance with Desired configuration.
  • NON_COMPLIANT: ESXi host is not in compliance with Desired configuration.

For more information see: Esx.Settings.Clusters.Configuration.ComplianceStatus.

This property was added in vSphere API 8.0.1.0.

compliance_info
Optional

Settings compliance information generated by the CheckCompliance operation.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is Esx.Settings.Clusters.Configuration.ComplianceStatus.NON_COMPLIANT.