Esx.Settings.Clusters.Configuration.HostResult
This Esx.Settings.Clusters.Configuration.HostResult schema contains properties that describe the result of the check compliance operation on an ESXi host.
This schema was added in vSphere API 8.0.1.0.
{
"host_status": {
"status": "string",
"attempts": 0,
"remaining_retries": 0,
"start_time": "string",
"end_time": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
]
}
},
"summary": "Vapi.Std.LocalizableMessage Object",
"errors": [
{
"path": "string",
"display_path": [
"string"
],
"messages": [
"Vapi.Std.LocalizableMessage Object"
]
}
],
"host_compliance": {
"status": "string",
"compliance_info": {
"sets": [
{
"path": "string",
"display_path": [
"string"
],
"current": "string",
"target": "string",
"type": "string",
"reference_current": "string",
"reference_target": "string",
"error": {
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
}
],
"adds": [
{
"path": "string",
"display_path": [
"string"
],
"current": "string",
"target": "string",
"type": "string",
"reference_current": "string",
"reference_target": "string",
"error": {
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
}
],
"deletes": [
{
"path": "string",
"display_path": [
"string"
],
"current": "string",
"target": "string",
"type": "string",
"reference_current": "string",
"reference_target": "string",
"error": {
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
}
}
]
}
}
}
This field represents the status of the check compliance operation. If status is OK, the result of operation can be retrieved from {#HostCompliance} {#Summary} field will summarize the status of the operation and if applicable, the specific error that occurred. Additionally, {#ValidationError} is populated if the operation fails due to host validation errors in desired document.
This property was added in vSphere API 8.0.1.0.
Summary of check compliance operation on the host.
This property was added in vSphere API 8.0.1.0.
List of validation errors returned by the host. This is only set for a specific HostStatus ERROR case.
This property was added in vSphere API 8.0.1.0.
This field is set only if the document fails to validate on the host.
This field provides compliance results for the host if the operation successfully completed on the host. That is, this field is populated only if HostStatus is OK.
This property was added in vSphere API 8.0.1.0.
This field is missing or null if check compliance could not be completed on the host.