Esx.Settings.HardwareSupportPackageCompliance
The Esx.Settings.HardwareSupportPackageCompliance schema contains information that describe compliance of the Hardware Support Package (HSP) on the host with respect to the Hardware support Package (HSP) present in the target software image specification, if any.
This schema was added in vSphere API 7.0.0.0.
{
"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
}
]
}
}Compliance status of the Hardware Support Package (HSP).
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.
Stage status of the Hardware Support Package (HSP). This is only relevant when the value of Esx.Settings.HardwareSupportPackageCompliance.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.
Current version of the Hardware Support Package present on the host.
This property was added in vSphere API 7.0.0.0.
missing or null if there is no known Hardware Support Package on the host.
Target version of the Hardware Support Package present in the software specification.
This property was added in vSphere API 7.0.0.0.
missing or null if current desired image includes a Hardware Support Manager (HSM) but no target Hardware Support Package (HSP).
Compliance result for individual hardware module on the host. The key is the module identifier and value is the HardwareModuleFirmwareCompliance for the device. NOTE: if no individual hardware module compliance is returned by the, Hardware Support Manager (HSM), this map may have no entries even if ComplianceStatus = NON_COMPLIANT
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.setting.hardware_module. 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_module.
Notifications describing the compliance result.
This property was added in vSphere API 7.0.0.0.