Settings_Clusters_Configuration_ClusterPrecheckResult
The PrecheckResult structure contains fields that describe precheck status of applying the desired document to a group of hosts.
{
"status": "string",
"commit": "string",
"software_commit": "string",
"end_time": "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"
},
"remediation_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"
}
],
"remediation_notes": [
{
"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"
}
],
"validation_errors": [
{
"path": "string",
"messages": [
"Std_LocalizableMessage Object"
]
}
],
"host_info": {
"host_info": {
"name": "string",
"is_vsan_witness": false
}
},
"host_precheck": {
"host_precheck": {
"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",
"validation_errors": [
"Settings_Clusters_Configuration_ValidationError Object"
],
"impact": {
"impact": "string",
"info": [
"Std_LocalizableMessage Object"
]
},
"precheck_result": {
"status": "string",
"check_statuses": [
{
"check": {
"check": "string",
"name": "Std_LocalizableMessage Object",
"description": "Std_LocalizableMessage Object"
},
"status": "Settings_Status Object",
"originator": "string",
"errors": [
{
"description": "Std_LocalizableMessage Object",
"resolution": "Std_LocalizableMessage Object"
}
]
}
]
}
}
},
"precheck_result": {
"status": "string",
"check_statuses": [
{
"check": {
"check": "string",
"name": "Std_LocalizableMessage Object",
"description": "Std_LocalizableMessage Object"
},
"status": "Settings_Status Object",
"originator": "string",
"errors": [
{
"description": "Std_LocalizableMessage Object",
"resolution": "Std_LocalizableMessage Object"
}
]
}
]
},
"successful_hosts": [
"string"
],
"failed_hosts": [
"string"
],
"skipped_hosts": [
"string"
]
}The ClusterPrecheckResult.Status enumerated type contains the possible statuses of the Precheck API on the cluster.
RUNNING : The task is in-progress.
OK : The operation completed successfully.
ERROR : The operation failed with errors.
This identifier refers to the commit action of importing the desired configuration document. This field is s not 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.
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.
Precheck completion time.
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.
Summarizing remediation stating number of hosts needing reboot and maintenance mode during remediation and number of precheck errors on host and cluster.
Static notes to the user describing steps that will be taken during remediation.
This field represents the validation errors if the desired configuration specified is not valid. This field is set if #Status#status is ERROR due to validation errors.
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.
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.
The StatusInfo structure contains fields that describe aggregated status of all checks performed on an entity.
Hosts in this cluster where the precheck was sucessfully run. 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 in this cluster where the precheck failed to run. 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 in this cluster where the precheck was not tried because the host was disconnected. 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.