SettingsClusterCompliance

The ClusterCompliance structure contains fields to describe the compliance result of a cluster.


Properties

Required Property Name Type Description
optional commit string

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.

required compliant_hosts array of string

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.

required host_info map of SettingsHostInfo

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.

required hosts map of SettingsHostCompliance

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.

required impact SettingsComplianceImpact Enum

Overall impact.

required incompatible_hosts array of string

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.

required non_compliant_hosts array of string

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.

required notifications SettingsNotifications

Notifications returned by the scan operation.

required scan_time string

Scan completion time.

required status SettingsComplianceStatus Enum

Overall compliance state of the host.

required unavailable_hosts array of string

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.

JSON Example

{
    "compliant_hosts": [
        "string"
    ],
    "host_info": {
        "key": {
            "name": "string"
        }
    },
    "hosts": {
        "key": {
            "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"
        }
    },
    "impact": "enum",
    "incompatible_hosts": [
        "string"
    ],
    "non_compliant_hosts": [
        "string"
    ],
    "notifications": {},
    "scan_time": "string",
    "status": "enum",
    "unavailable_hosts": [
        "string"
    ]
}
Feedback

Was this page helpful?