SettingsClusterCompliance

The ClusterCompliance structure contains fields to describe the compliance result of a cluster.


Properties

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
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.


host_info Required

Auxillary information about the hosts. This gives some additional information about the hosts referenced in this result. 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.


hosts Required

Mapping from host identifier to the compliance information for the host. 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.


impact Required

The ComplianceImpact enumerated type contains information about the impact of applying the target state in case of non compliance.
NO_IMPACT : Host has no impact.
MAINTENANCE_MODE_REQUIRED : Host requires maintenance mode to reach this target state.
REBOOT_REQUIRED : Host requires reboot to reach this target state.
UNKNOWN : Impact is unknown.

Possible values are: NO_IMPACTMAINTENANCE_MODE_REQUIREDREBOOT_REQUIREDUNKNOWN


array of string
incompatible_hosts Required

Identifiers of incompatible 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.


notifications Required

Notifications returned by the scan operation.


string as date-time
scan_time Required

Scan completion time.


status Required

The ComplianceStatus enumerated type contains the possible different status of compliance with respect to target version.
COMPLIANT : Target version is same as current version.
NON_COMPLIANT : Target version is greater than current version.
INCOMPATIBLE : Target state cannot be applied due to conflict or missing dependencies or the target state is lesser than the current version.
UNAVAILABLE : Drift check failed due to unknown error or check hasn’t happened yet and results are not available.

Possible values are: COMPLIANTNON_COMPLIANTINCOMPATIBLEUNAVAILABLE


array of string
unavailable_hosts Required

Identifiers of unavailable hosts. There will not be compliance details for these hosts in ClusterCompliance.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
commit Optional

Identifier of the commit on which the scan is run to generate this result. unset if operation is performed on a draft. 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.

JSON Example

{
	"compliant_hosts": [
		"string"
	],
	"host_info": {
		"key": {
			"name": "string"
		}
	},
	"hosts": {
		"key": {
			"add_on": {
				"notifications": {},
				"status": "COMPLIANT"
			},
			"base_image": {
				"current": {
					"version": "string"
				},
				"notifications": {},
				"status": "COMPLIANT",
				"target": {
					"version": "string"
				}
			},
			"components": {
				"key": {
					"notifications": {},
					"status": "COMPLIANT"
				}
			},
			"impact": "NO_IMPACT",
			"notifications": {},
			"scan_time": "string",
			"solutions": {
				"key": {
					"notifications": {},
					"status": "COMPLIANT"
				}
			},
			"status": "COMPLIANT"
		}
	},
	"impact": "NO_IMPACT",
	"incompatible_hosts": [
		"string"
	],
	"non_compliant_hosts": [
		"string"
	],
	"notifications": {},
	"scan_time": "string",
	"status": "COMPLIANT",
	"unavailable_hosts": [
		"string"
	]
}

Feedback

Was this page helpful?