Settings_Clusters_Configuration_ClusterCompliance

Settings_Clusters_Configuration_ClusterCompliance
Settings_Clusters_Configuration_ClusterCompliance

This ClusterCompliance structure contains fields that describe the compliance result for each host in the cluster as well as overall cluster compliance status.

JSON Example
{
    "cluster_status": "string",
    "commit": "string",
    "software_commit": "string",
    "summary": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": {
                    "id": "string",
                    "params": {
                        "params": "Std_LocalizationParam Object"
                    }
                },
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "hosts": {
        "hosts": {
            "host_status": {
                "status": "string",
                "attempts": 0,
                "remaining_retries": 0,
                "start_time": "string",
                "end_time": "string",
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Std_LocalizableMessage Object",
                            "resolution": "Std_LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            },
            "summary": "Std_LocalizableMessage Object",
            "errors": [
                {
                    "path": "string",
                    "messages": [
                        "Std_LocalizableMessage Object"
                    ]
                }
            ],
            "host_compliance": {
                "status": "string",
                "compliance_info": {
                    "sets": [
                        {
                            "path": "string",
                            "current": "string",
                            "target": "string"
                        }
                    ],
                    "adds": [
                        {
                            "path": "string",
                            "current": "string",
                            "target": "string"
                        }
                    ],
                    "deletes": [
                        {
                            "path": "string",
                            "current": "string",
                            "target": "string"
                        }
                    ]
                }
            }
        }
    },
    "compliant_hosts": [
        "string"
    ],
    "non_compliant_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ],
    "end_time": "string"
}
cluster_status
Required

Consolidated compliance status of the cluster
RUNNING : The task is in-progress.
COMPLIANT : All hosts in the cluster are compliant.
NOT_COMPLIANT :

string
commit
Optional

This identifier refers to the commit action of importing the desired configuration document. It will not be set for a draft execution of check compliance. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.

string
software_commit
Required

The current commit ID for the software associated with the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.

summary
Required

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

object
host_info
Required

Map of host IDs to hostname. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: HostSystem.

object
hosts
Required

Map of host IDs to their compliance results. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: HostSystem.

array of string
compliant_hosts
Required

Identifiers of compliant hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

array of string
non_compliant_hosts
Required

Identifiers of non-compliant hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

array of string
failed_hosts
Required

Identifiers of hosts where the operation failed. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

array of string
skipped_hosts
Required

Identifiers of hosts where the operation was skipped. i.e disconnected hosts When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

string As date-time
end_time
Required

CheckCompliance completion time.