Esx.Settings.AddOnCompliance

Esx.Settings.AddOnCompliance
Esx.Settings.AddOnCompliance

The Esx.Settings.AddOnCompliance schema contains information that describe the compliance of the OEM add-on with respect to the add-on present in the target software specification.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "status": "string",
    "stage_status": "string",
    "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": {
        "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
status
Required

Compliance status of the OEM add-on.

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

string
stage_status
Optional

Stage status of the OEM add-on. This is only relevant when the value of Esx.Settings.AddOnCompliance.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.

current
Optional

Current OEM add-on present on the host.

This property was added in vSphere API 7.0.0.0.

missing or null if OEM add-on is not present on the host.

target
Optional

Target OEM add-on present in the software specification.

This property was added in vSphere API 7.0.0.0.

missing or null if OEM add-on is not present in the software specification.

notifications
Required

Notifications describing the compliance result.

This property was added in vSphere API 7.0.0.0.