SettingsHostCompliance

The HostCompliance structure contains information to describe the compliance result of a host with respect to given target software specification.


Properties

add_on Required

Compliance result for the OEM add-on.


base_image Required

Compliance result for the base image.


string
commit Optional

Identifier of the commit on which the scan is run to generate this result. unset if operation is performed on a working copy document. 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.


components Required

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. 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: com.vmware.esx.settings.component. 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: com.vmware.esx.settings.component.


hardware_support Optional

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 field will be unset or contain an empty map if operation is performed on an image whose SoftwareSpec does not have a value for its hardwareSupport field. 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: com.vmware.esx.setting.hardware_support.manager. 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: com.vmware.esx.setting.hardware_support.manager.


impact Required

Overall impact.


notifications Required

Notifications returned by the scan operation.


string
scan_time Required

Scan completion time.


solutions Required

Compliance result for solutions. The key is the solution name and value is the SolutionCompliance. 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: com.vmware.esx.settings.solution. 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: com.vmware.esx.settings.solution.


status Required

Overall compliance state of the host.

JSON Example

{
    "add_on": {
        "notifications": {},
        "status": "enum"
    },
    "base_image": {
        "current": {
            "version": "string"
        },
        "notifications": {},
        "status": "enum",
        "target": {
            "version": "string"
        }
    },
    "components": {
        "key": {
            "notifications": {},
            "status": "enum"
        }
    },
    "impact": "enum",
    "notifications": {},
    "scan_time": "string",
    "solutions": {
        "key": {
            "notifications": {},
            "status": "enum"
        }
    },
    "status": "enum"
}
Feedback

Was this page helpful?