Developer Documentation

SettingsHostCompliance

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


Properties

Required Property Name Type Description
required add_on SettingsAddOnCompliance

Compliance result for the OEM add-on.

required base_image SettingsBaseImageCompliance

Compliance result for the base image.

optional commit string

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.

required components map of SettingsComponentCompliance

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.

optional hardware_support map of SettingsHardwareSupportPackageCompliance

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 is optional because it was added in a newer version than its parent node. 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.

required impact SettingsComplianceImpact Enum

Overall impact.

required notifications SettingsNotifications

Notifications returned by the scan operation.

required scan_time string

Scan completion time.

required solutions map of SettingsSolutionCompliance

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.

required status SettingsComplianceStatus Enum

Overall compliance state of the host.

Feedback

Was this page helpful?