Esx.Settings.Internal.Summary.Hosts.ComplianceResult

Esx.Settings.Internal.Summary.Hosts.ComplianceResult
Esx.Settings.Internal.Summary.Hosts.ComplianceResult

The Esx.Settings.Internal.Summary.Hosts.ComplianceResult schema contains information to describe the compliance result of a host.

This schema was added in vSphere API 8.0.0.1.

Note: this schema is restricted for VMware internal use only.

JSON Example
{
    "status": "string",
    "stage_status": "string",
    "scan_time": "string",
    "compliant_data_processing_units": [
        "string"
    ],
    "non_compliant_data_processing_units": [
        "string"
    ],
    "incompatible_data_processing_units": [
        "string"
    ],
    "unavailable_data_processing_units": [
        "string"
    ]
}
string
status
Required

Overall compliance status of the host.

Possible values:

  • 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.

For more information see: Esx.Settings.ComplianceStatus.

This property was added in vSphere API 8.0.0.1.

string
stage_status
Optional

Overall stage status of the host. This is only relevant when the value of Esx.Settings.Internal.Summary.Hosts.ComplianceResult.status is Esx.Settings.ComplianceStatus.NON_COMPLIANT.

Possible values:

  • STAGED: Required components/payloads are already staged.
  • NOT_STAGED: Required components/payloads are not staged.
  • UNKNOWN: Required components/payloads staged status is unknown.

Warning: this constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

For more information see: Esx.Settings.StageStatus.

This property was added in vSphere API 8.0.0.1.

If missing or null the staging status is unknown - the contents may or may not be staged. This can happen, for instance, if the stage check failed, has not been done yet, or the target uses an older interface that does not include support for returning the staged status.

string As date-time As date-time
scan_time
Required

Scan completion time.

This property was added in vSphere API 8.0.0.1.

array of string
compliant_data_processing_units
Optional

Identifiers of compliant DPUs.

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit.

array of string
non_compliant_data_processing_units
Optional

Identifiers of non-compliant DPUs.

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit.

array of string
incompatible_data_processing_units
Optional

Identifiers of incompatible DPUs.

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit.

array of string
unavailable_data_processing_units
Optional

Identifiers of unavailable DPUs.

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.data_processing_unit.