SettingsClustersConfigurationHostPrecheckResult

This HostPrecheckResult structure contains fields that describes the Precheck API result on a host. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Properties

SettingsClustersConfigurationImpactInfo

impact Optional

This field represents the impact on the host to reach the desired configuration state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set if there are no validation errors on the host. The HostStatus.status may be OK or ERROR.

SettingsStatusInfo

precheck_result Optional

This field represents the health check results from the host, if the host needs to be put in maintenance mode or to be rebooted. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set if there are not validation errors and health checks are run on the host. The HostStatus.status may be OK or ERROR.

SettingsClustersConfigurationHostStatus

status Required

This field represents the status of the precheck request for this host. {link HostStatus#status} is ERROR or SKIPPED, if precheck was not completed on the host due to some error or if health checks failed. If precheck failed due to host validation errors, details are specified in HostPrecheckResult.validation-errors. If precheck failed due to generic error, details are specified in the HostPrecheckResult.summary. Health check result is specified in HostPrecheckResult.precheck-result. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

StdLocalizableMessage

summary Required

Summarizing precheck operation on the host. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

array of SettingsClustersConfigurationValidationError

validation_errors Optional

This field represents the validation errors if the desired configuration specified is not valid. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is set if #HostStatus#status is ERROR due to host returning validation errors.

JSON Example

Show optional properties

{
	"status": {
		"end_time": "string",
		"notifications": {},
		"start_time": "string",
		"status": "OK"
	},
	"summary": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string"
	}
}

{
	"impact": {
		"impact": "NO_IMPACT",
		"info": [
			{
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string",
				"localized": "string",
				"params": {
					"key": {
						"d": 0,
						"dt": "string",
						"format": "SHORT_DATE",
						"i": 0,
						"l": {
							"id": "string",
							"params": "StdLocalizationParam Object"
						},
						"precision": 0,
						"s": "string"
					}
				}
			}
		]
	},
	"precheck_result": {
		"check_statuses": [
			{
				"check": {
					"check": "string",
					"description": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"name": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					}
				},
				"errors": [
					{
						"description": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						},
						"resolution": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						}
					}
				],
				"originator": "string",
				"status": "OK"
			}
		],
		"status": "OK"
	},
	"status": {
		"attempts": 0,
		"end_time": "string",
		"notifications": {
			"errors": [
				{
					"id": "string",
					"message": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"originator": "string",
					"resolution": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"retriable": false,
					"time": "string",
					"type": "INFO"
				}
			],
			"info": [
				{
					"id": "string",
					"message": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"originator": "string",
					"resolution": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"retriable": false,
					"time": "string",
					"type": "INFO"
				}
			],
			"warnings": [
				{
					"id": "string",
					"message": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"originator": "string",
					"resolution": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"retriable": false,
					"time": "string",
					"type": "INFO"
				}
			]
		},
		"remaining_retries": 0,
		"start_time": "string",
		"status": "OK"
	},
	"summary": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string",
		"localized": "string",
		"params": {
			"key": {
				"d": 0,
				"dt": "string",
				"format": "SHORT_DATE",
				"i": 0,
				"l": {
					"id": "string",
					"params": "StdLocalizationParam Object"
				},
				"precision": 0,
				"s": "string"
			}
		}
	},
	"validation_errors": [
		{
			"messages": [
				{
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				}
			],
			"path": "string"
		}
	]
}

SettingsClustersConfigurationHostPrecheckResult

Properties

JSON Example

Was this page helpful?