SettingsClustersConfigurationClusterPrecheckResult

The PrecheckResult structure contains fields that describe precheck status of applying the desired document to a group of hosts.


Properties

string
commit Optional

This identifier refers to the commit action of importing the desired configuration document. It will not be set for a precheck of a draft configuration. 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 as date-time
end_time Required

Precheck completion time.


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.


host_precheck Required

Map of host IDs to their precheck results. If ClusterPrecheckResult.status is ERROR, This field will contain Validation errors or Host Impact and Health Check errors. If ClusterPrecheckResult.status is OK, This field will contain Impact and Health Check information. 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.


precheck_result Optional

This field represents the precheck results on the cluster, if any one host in the cluster needs to be put in maintenance mode or to be rebooted. This field is set if cluster prechecks are invoked.


precheck_summary Optional

Summarizing precheck stating number of precheck errors on host and cluster.


remediation_notes Required

Static notes to the user describing steps that will be taken during remediation.


remediation_summary Required

Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster.


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.


status Required

The ClusterPrecheckResult.Status enumerated type contains the possible statuses of the Precheck API on the cluster.
OK : The operation completed successfully.
ERROR : The operation failed with errors.

Possible values are: OKERROR

JSON Example

{
	"end_time": "string",
	"host_info": {
		"key": {
			"name": "string"
		}
	},
	"host_precheck": {
		"key": {
			"status": {
				"end_time": "string",
				"notifications": {},
				"start_time": "string",
				"status": "OK"
			}
		}
	},
	"remediation_notes": [
		{
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string"
		}
	],
	"remediation_summary": [
		{
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string"
		}
	],
	"software_commit": "string",
	"status": "OK"
}

Feedback

Was this page helpful?