Esx.Settings.HostCompliance
The Esx.Settings.HostCompliance schema contains information to describe the compliance result of a host with respect to given target software specification. Any change in Esx.Settings.HostCompliance schema may need to be reflected in Esx.Settings.DataProcessingUnitCompliance
This schema was added in vSphere API 7.0.0.0.
{
"impact": "string",
"status": "string",
"stage_status": "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
}
]
},
"scan_time": "string",
"commit": "string",
"base_image": {
"status": "string",
"stage_status": "string",
"current": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"target": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "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
}
]
}
},
"add_on": {
"status": "string",
"stage_status": "string",
"current": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"target": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "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
}
]
}
},
"hardware_support": {
"hardware_support": {
"status": "string",
"stage_status": "string",
"current": {
"pkg": "string",
"version": "string"
},
"target": {
"pkg": "string",
"version": "string"
},
"hardware_modules": {
"hardware_modules": {
"status": "string",
"stage_status": "string",
"details": {
"component_class": "string",
"description": "string"
},
"current": {
"version": "string"
},
"target": {
"version": "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
}
]
}
}
},
"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
}
]
}
}
},
"components": {
"components": {
"status": "string",
"stage_status": "string",
"current": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"target": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"current_source": "string",
"target_source": "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
}
]
}
}
},
"solutions": {
"solutions": {
"status": "string",
"stage_status": "string",
"current": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
},
"target": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "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
}
]
}
}
},
"removed_components": {
"removed_components": {
"status": "string",
"stage_status": "string",
"current": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"target": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"current_source": "string",
"target_source": "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
}
]
}
}
},
"impact_details": {
"memory_reservation": {
"temporary_reservation": 0,
"permanent_reservation_increase": 0
},
"partial_maintenance_mode_name": "string",
"partial_maintenance_mode_upgrade_actions": [
"string"
],
"solution_impacts": {
"solution_impacts": "string"
},
"maintenance_actions": [
{
"key": "string",
"value": "string"
}
]
},
"data_processing_units_compliance": {
"compliant_data_processing_units": [
"string"
],
"non_compliant_data_processing_units": [
"string"
],
"incompatible_data_processing_units": [
"string"
],
"unavailable_data_processing_units": [
"string"
],
"compliance": {
"compliance": {
"impact": "string",
"impact_details": {
"memory_reservation": {
"temporary_reservation": 0,
"permanent_reservation_increase": 0
},
"partial_maintenance_mode_name": "string",
"partial_maintenance_mode_upgrade_actions": [
"string"
],
"solution_impacts": {
"solution_impacts": "string"
},
"maintenance_actions": [
{
"key": "string",
"value": "string"
}
]
},
"status": "string",
"stage_status": "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
}
]
},
"scan_time": "string",
"base_image": {
"status": "string",
"stage_status": "string",
"current": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "string"
},
"target": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string",
"quick_patch_compatible_versions": {
"quick_patch_compatible_versions": "string"
}
},
"version": "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
}
]
}
},
"add_on": {
"status": "string",
"stage_status": "string",
"current": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "string"
},
"target": {
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
},
"name": "string",
"version": "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
}
]
}
},
"hardware_support": {
"hardware_support": {
"status": "string",
"stage_status": "string",
"current": {
"pkg": "string",
"version": "string"
},
"target": {
"pkg": "string",
"version": "string"
},
"hardware_modules": {
"hardware_modules": {
"status": "string",
"stage_status": "string",
"details": {
"component_class": "string",
"description": "string"
},
"current": {
"version": "string"
},
"target": {
"version": "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
}
]
}
}
},
"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
}
]
}
}
},
"components": {
"components": {
"status": "string",
"stage_status": "string",
"current": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"target": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"current_source": "string",
"target_source": "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
}
]
}
}
},
"solutions": {
"solutions": {
"status": "string",
"stage_status": "string",
"current": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "string"
}
]
},
"target": {
"details": {
"display_name": "string",
"display_version": "string",
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
]
},
"version": "string",
"components": [
{
"component": "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
}
]
}
}
},
"removed_components": {
"removed_components": {
"status": "string",
"stage_status": "string",
"current": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"target": {
"version": "string",
"details": {
"display_name": "string",
"vendor": "string",
"display_version": "string"
}
},
"current_source": "string",
"target_source": "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
}
]
}
}
}
}
},
"data_processing_unit_info": {
"data_processing_unit_info": {
"alias": "string"
}
}
},
"compliance_status_details": {
"type": "string",
"id": "string",
"time": "string",
"message": "Vapi.Std.LocalizableMessage Object",
"resolution": "Vapi.Std.LocalizableMessage Object",
"originator": "string",
"retriable": false
},
"remediation_details": {
"remediation_actions": [
{
"action": "Vapi.Std.LocalizableMessage Object"
}
]
},
"image": {
"id": "string",
"info": {
"display_name": "string"
}
},
"host_hardware_details": {
"host_uuid": "string",
"vendor": "string",
"model": "string",
"family": "string",
"oem_strings": [
"string"
]
}
}Overall impact.
Possible values:
- NO_IMPACT: Host has no impact.
- PARTIAL_MAINTENANCE_MODE_REQUIRED: Host requires partial maintenance mode to reach this target state.
- MAINTENANCE_MODE_REQUIRED: Host requires maintenance mode to reach this target state.
- REBOOT_REQUIRED: Host requires reboot to reach this target state.
- UNKNOWN: Impact is unknown.
For more information see: Esx.Settings.ComplianceImpact.
This property was added in vSphere API 7.0.0.0.
Overall compliance status of the host.
Possible values:
- COMPLIANT: Target version is same as current version.
- NON_COMPLIANT: Target version is greater than current version.
- INCOMPATIBLE: Target state cannot be applied due to conflict or missing dependencies or the target state is lesser than the current version.
- UNAVAILABLE: Drift check failed due to unknown error or check hasn't happened yet and results are not available.
For more information see: Esx.Settings.ComplianceStatus.
This property was added in vSphere API 7.0.0.0.
Overall stage status of the host. This is only relevant when the value of Esx.Settings.HostCompliance.status is Esx.Settings.ComplianceStatus.NON_COMPLIANT.
Possible values:
- STAGED: Required components/payloads are already staged.
- NOT_STAGED: Required components/payloads are not staged.
- UNKNOWN: Required components/payloads staged status is unknown.
Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
For more information see: Esx.Settings.StageStatus.
This property was added in vSphere API 8.0.0.1.
If missing or null the staging status is unknown - the contents may or may not be staged. This can happen, for instance, if the stage check failed, has not been done yet, or the target uses an older interface that does not include support for returning the staged status.
Notifications returned by the scan operation.
This property was added in vSphere API 7.0.0.0.
Scan completion time.
This property was added in vSphere API 7.0.0.0.
Identifier of the commit on which the scan is run to generate this result.
This property was added in vSphere API 7.0.0.0.
missing or null if operation is performed on a working copy document.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
Compliance result for the base image.
This property was added in vSphere API 7.0.0.0.
Compliance result for the OEM add-on.
This property was added in vSphere API 7.0.0.0.
Compliance result for hardware support (both Hardware Support Package or HSP and individual hardware module firmware) for every HSP configured, keyed by Hardware Support Manager (HSM).
This property was added in vSphere API 7.0.0.0.
This property will be missing or null or contain an empty map if operation is performed on an image whose Esx.Settings.SoftwareSpec does not have a value for its hardwareSupport property.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.setting.hardware_support.manager.
Compliance result for all the effective components and all the components present on the host. The key is the component name and value is the ComponentCompliance.
This property was added in vSphere API 7.0.0.0.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.
Compliance result for solutions. The key is the solution name and value is the SolutionCompliance.
This property was added in vSphere API 7.0.0.0.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.solution.
Compliance result for all removed components present on the host and in the software specification. The key is the component name and value is the ComponentCompliance object.
This property was added in vSphere API 8.0.3.0.
This property is optional because it was added in a newer version than its parent node.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.
Details about compliance impact.
This property was added in vSphere API 8.0.3.0.
This property is optional because it was added in a newer version than its parent node.
Compliance results of all data processing units on the host.
This property was added in vSphere API 8.0.0.1.
This property will be missing or null if host doesn't have any data processing units.
User-friendly notification to describe the compliance status in detail.
This property was added in vSphere API 8.0.3.0.
If missing or null, the default compliance status message will be shown.
Details about remediation actions, including a list of pending remediation actions.
This property was added in vSphere API 8.0.3.0.
for now, set only when Quick Patch is supported and the Quick Patch remediation policy is enforced.
Details of the Image.
This property was added in vSphere API 9.0.0.0.
is missing or null when the host is part of a Single Image Cluster or the host is a standalone host.
Details of the host's hardware.
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.