Settings_DataProcessingUnitCompliance
The DataProcessingUnitCompliance structure contains information to describe the compliance result of a data processing unit with respect to the target software specification. This DataProcessingUnitCompliance structure is mirror of HostCompliance, any changes in either of them should reflect in both.
{
"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"
}
},
"status": "string",
"stage_status": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": {
"id": "string",
"params": {
"params": "Std_LocalizationParam Object"
}
},
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
]
},
"scan_time": "string",
"base_image": {
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"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": "Settings_Notifications Object"
},
"add_on": {
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"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": "Settings_Notifications Object"
},
"hardware_support": {
"hardware_support": {
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"current": {
"pkg": "string",
"version": "string"
},
"target": {
"pkg": "string",
"version": "string"
},
"hardware_modules": {
"hardware_modules": {
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"details": {
"component_class": "string",
"description": "string"
},
"current": {
"version": "string"
},
"target": {
"version": "string"
},
"notifications": "Settings_Notifications Object"
}
},
"notifications": "Settings_Notifications Object"
}
},
"components": {
"components": {
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"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": "Settings_Notifications Object"
}
},
"solutions": {
"solutions": {
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"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": "Settings_Notifications Object"
}
},
"removed_components": {
"removed_components": {
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"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": "Settings_Notifications Object"
}
}
}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.
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.
The ImpactDetails structure contains information that provides more details about the compliance impact.
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.
The StageStatus enumerated type contains the possible different staged statuses with respect to target version. This is only relevant when the value of ComplianceStatus is NON_COMPLIANT.
STAGED : Required components/payloads are already staged.
NOT_STAGED : Required components/payloads are not staged.
The Notifications structure contains info/warning/error messages that can be reported by the task.
Scan completion time.
The BaseImageCompliance structure contains information that describe the compliance of ESX base image with respect to the base image present in the target software specification.
The AddOnCompliance structure contains information that describe the compliance of the OEM add-on with respect to the add-on present in the target software specification.
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. For initial release hardwareSupport field would be empty. 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.
Compliance result for all user components present on the data processing unit and in the software specification. The key is the component name and value is the ComponentCompliance object. 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.
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.
Compliance result for all removed components present on the data processing unit and in the software specification. The key is the component name and value is the ComponentCompliance object. 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.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.