SettingsClustersSoftwareCheckResult

The Software.CheckResult structure contains fields that describe aggregated status of all checks performed.

Properties

string

commit Required

The identifier of the commit on which checks have been run. 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

Time when the operation completed.

array of SettingsClustersSoftwareEntityCheckResult

entity_results Required

List of Software.EntityCheckResult for all entities for which checks have been run.

map of SettingsHostInfo

host_info Required

Information about the hosts in this cluster for which checks have been requested to be run. 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

start_time Required

Time when the operation started.

SettingsClustersSoftwareStatus Enum

status Required

The Software.Status enumerated type defines the status result for a particular check.
OK : The check indicates a success.
WARNING : The check indicates a warning.
TIMEOUT : The check did not return in a timely manner.
ERROR : The check indicates an error.
RETRY : The check failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health check before considering the check as failed.

Possible values are: OK , WARNING , TIMEOUT , ERROR , RETRY

JSON Example

Show optional properties

{
	"commit": "string",
	"end_time": "string",
	"entity_results": [
		{
			"check_statuses": [
				{
					"check": {
						"check": "string",
						"description": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string"
						},
						"name": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string"
						}
					},
					"issues": [
						{
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string"
						}
					],
					"status": "OK"
				}
			],
			"status": "OK",
			"type": "CLUSTER"
		}
	],
	"host_info": {
		"key": {
			"name": "string"
		}
	},
	"start_time": "string",
	"status": "OK"
}

{
	"commit": "string",
	"end_time": "string",
	"entity_results": [
		{
			"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"
								}
							}
						},
						"originator": "string"
					},
					"check_issues": [
						{
							"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"
									}
								}
							}
						}
					],
					"issues": [
						{
							"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"
								}
							}
						}
					],
					"status": "OK"
				}
			],
			"cluster": "string",
			"host": "string",
			"status": "OK",
			"type": "CLUSTER"
		}
	],
	"host_info": {
		"key": {
			"is_vsan_witness": false,
			"name": "string"
		}
	},
	"start_time": "string",
	"status": "OK"
}

SettingsClustersSoftwareCheckResult

Properties

JSON Example

Was this page helpful?