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

The ComplianceImpact enumerated type contains information about the impact of applying the target state in case of non compliance.
NO_IMPACT : Host has no impact.
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.

Possible values are: NO_IMPACTMAINTENANCE_MODE_REQUIREDREBOOT_REQUIREDUNKNOWN


notifications Required

Notifications returned by the scan operation.


string as date-time
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

The ComplianceStatus enumerated type contains the possible different status of compliance with respect to target version.
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.

Possible values are: COMPLIANTNON_COMPLIANTINCOMPATIBLEUNAVAILABLE

JSON Example

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

Feedback

Was this page helpful?