Settings_ClusterCompliance
The ClusterCompliance structure contains fields to describe the compliance result of a cluster.
{
"impact": "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",
"commit": "string",
"compliant_hosts": [
"string"
],
"non_compliant_hosts": [
"string"
],
"incompatible_hosts": [
"string"
],
"unavailable_hosts": [
"string"
],
"hosts": {
"hosts": {
"impact": "Settings_ComplianceImpact Object",
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"notifications": "Settings_Notifications Object",
"scan_time": "string",
"commit": "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"
}
},
"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"
}
},
"data_processing_units_compliance": {
"compliant_data_processing_units": [
"string"
],
"non_compliant_data_processing_units": [
"string"
],
"incompatible_data_processing_units": [
"string"
],
"unavailable_data_processing_units": [
"string"
],
"compliance": {
"compliance": {
"impact": "Settings_ComplianceImpact Object",
"impact_details": "Settings_ImpactDetails Object",
"status": "Settings_ComplianceStatus Object",
"stage_status": "Settings_StageStatus Object",
"notifications": "Settings_Notifications Object",
"scan_time": "string",
"base_image": "Settings_BaseImageCompliance Object",
"add_on": "Settings_AddOnCompliance Object",
"hardware_support": {
"hardware_support": "Settings_HardwareSupportPackageCompliance Object"
},
"components": {
"components": "Settings_ComponentCompliance Object"
},
"solutions": {
"solutions": "Settings_SolutionCompliance Object"
},
"removed_components": {
"removed_components": "Settings_ComponentCompliance Object"
}
}
},
"data_processing_unit_info": {
"data_processing_unit_info": {
"alias": "string"
}
}
},
"compliance_status_details": "Settings_Notification Object",
"remediation_details": {
"remediation_actions": [
{
"action": "Std_LocalizableMessage Object"
}
]
}
}
},
"host_info": {
"host_info": {
"name": "string",
"is_vsan_witness": false
}
}
}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 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.
Identifier of the commit on which the scan is run to generate this result. unset if operation is performed on a draft. 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.
Identifiers of compliant hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
Identifiers of non-compliant hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
Identifiers of incompatible hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
Identifiers of unavailable hosts. There will not be compliance details for these hosts in ClusterCompliance.hosts. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
Mapping from host identifier to the compliance information for the host. 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: HostSystem. 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: HostSystem.
Auxillary information about the hosts. This gives some additional information about the hosts referenced in this result. 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: HostSystem. 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: HostSystem.