Esx.Settings.Inventory.Reports.Summary.Hosts.ComplianceResult

Esx.Settings.Inventory.Reports.Summary.Hosts.ComplianceResult
Esx.Settings.Inventory.Reports.Summary.Hosts.ComplianceResult

The Esx.Settings.Inventory.Reports.Summary.Hosts.ComplianceResult schema contains properties to describe the compliance result of a standalone host.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "task_status": "string",
    "compliance_status": "string",
    "last_compliance_time": "string",
    "notifications": {
        "info": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "warnings": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "errors": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ]
    }
}
string
task_status
Required

Provides the status of the compliance task.

Possible values:

  • PENDING: The operation is not performed yet.
  • RUNNING: The operation is in progress.
  • CANCELED: The operation is canceled.
  • SUCCEEDED: The operation indicates a success.
  • FAILED: The operation encountered an unspecified error.
  • SKIPPED: The operation was skipped.
  • UNKNOWN: The operation is in an unknown state.

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.Inventory.Reports.Summary.Hosts.TaskStatus.

This property was added in vSphere API 9.0.0.0.

string
compliance_status
Required

Overall compliance status of the standalone 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 9.0.0.0.

string As date-time As date-time
last_compliance_time
Optional

Time when the operation performed last time.

This property was added in vSphere API 9.0.0.0.

If missing or null, the operation has not been run yet.

notifications
Required

Notifications returned by the scan operation.

This property was added in vSphere API 9.0.0.0.