SettingsClustersConfigurationClusterCompliance

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


Properties

cluster_status Required

Consolidated compliance status of the cluster
OK : All hosts in the cluster are compliant.
ERROR :

Possible values are: OKERROR


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.


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.


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.


string as date-time
last_check_time Required

CheckCompliance completion time.


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
not_computable_hosts Required

Identifiers of not computable 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
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.


array of string
unavailable_hosts Required

Identifiers of failed or unavailable hosts. There won’t be any compliance details for these hosts in 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.

JSON Example

{
	"cluster_status": "OK",
	"compliant_hosts": [
		"string"
	],
	"hosts": {
		"key": {
			"host_info": {
				"name": "string"
			},
			"host_status": {
				"end_time": "string",
				"notifications": {},
				"start_time": "string",
				"status": "OK"
			}
		}
	},
	"last_check_time": "string",
	"non_compliant_hosts": [
		"string"
	],
	"not_computable_hosts": [
		"string"
	],
	"software_commit": "string",
	"unavailable_hosts": [
		"string"
	]
}

Feedback

Was this page helpful?