Esx.Settings.Hosts.Configuration.ComplianceResult

Esx.Settings.Hosts.Configuration.ComplianceResult
Esx.Settings.Hosts.Configuration.ComplianceResult

This Compliance schema contains properties that describe the compliance result for the standalone host.

Warning: this schema is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

JSON Example
{
    "status": {
        "status": "string",
        "attempts": 0,
        "remaining_retries": 0,
        "start_time": "string",
        "end_time": "string",
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "compliance_status": "string",
    "summary": "Vapi.Std.LocalizableMessage Object",
    "compliance_info": {
        "sets": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string"
            }
        ],
        "adds": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string"
            }
        ],
        "deletes": [
            {
                "path": "string",
                "display_path": [
                    "string"
                ],
                "current": "string",
                "target": "string",
                "type": "string",
                "reference_current": "string",
                "reference_target": "string"
            }
        ]
    },
    "commit": "string",
    "software_commit": "string",
    "validation_errors": [
        {
            "path": "string",
            "display_path": [
                "string"
            ],
            "messages": [
                "Vapi.Std.LocalizableMessage Object"
            ]
        }
    ],
    "host_info": {
        "name": "string",
        "is_vsan_witness": false
    }
}
status
Required

This field represents the status of the check compliance operation.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

string
compliance_status
Optional

Compliance status of the host.

Possible values:

  • COMPLIANT: The host is compliant.
  • NOT_COMPLIANT

For more information see: Esx.Settings.Hosts.Configuration.ComplianceResult.ComplianceStatus.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

It will be set if Esx.Settings.Hosts.Configuration.HostStatus.status is OK.

summary
Required

Summarizing check compliance operation on the standalone host.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

compliance_info
Optional

This field provides the configuration drift in case the Esx.Settings.Hosts.Configuration.ComplianceResult.ComplianceStatus is NOT_COMPLIANT

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional and it is only relevant when the value of compliance_status is Esx.Settings.Hosts.Configuration.ComplianceResult.ComplianceStatus.NOT_COMPLIANT.

string
commit
Optional

This identifier refers to the commit action of importing the desired configuration document.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

It will not be set for a draft execution of check compliance.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

string
software_commit
Optional

The current commit ID for the software associated with the standalone host.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field is set if the host is managed by vlcm.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

array of Esx.Settings.Hosts.Configuration.ValidationError
validation_errors
Optional

This field represents the validation errors if the desired configuration specified is not valid.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This field may be set if Esx.Settings.Hosts.Configuration.HostStatus.status is ERROR due to validation errors.

host_info
Required

hostname of the standalone host.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.