Esx.Settings.Clusters.Configuration.SettingCompliance

Esx.Settings.Clusters.Configuration.SettingCompliance
Esx.Settings.Clusters.Configuration.SettingCompliance

The Esx.Settings.Clusters.Configuration.SettingCompliance schema contains properties that describe a drift in an ESXi host setting. This structure describes a change in configuration value(set) or addition of configuration or deletion of configuration. In addition this structure also describes error encountered in case realization of configuration fails. When used to describe addition or deletion of a setting, if the setting is an instance in an array without an instance ID, the whole instance object is populated in target or current, respectively. When used to describe a drift in primitive type, current and target values are populated when applicable.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "path": "string",
    "display_path": [
        "string"
    ],
    "current": "string",
    "target": "string",
    "type": "string",
    "reference_current": "string",
    "reference_target": "string",
    "error": {
        "type": "string",
        "id": "string",
        "time": "string",
        "message": "Vapi.Std.LocalizableMessage Object",
        "resolution": "Vapi.Std.LocalizableMessage Object",
        "originator": "string",
        "retriable": false
    }
}
string
path
Required

Full path to the setting within the desired document.

This property was added in vSphere API 8.0.1.0.

array of string
display_path
Optional

A list of the display names for components of the value provided by Esx.Settings.Clusters.Configuration.SettingCompliance.path property.

This property was added in vSphere API 9.0.0.0.

This field is missing or null if the display names cannot be computed.

string
current
Optional

Value of setting on the ESXi host.

This property was added in vSphere API 8.0.1.0.

This field is missing or null if there is no host value to report.

string
target
Optional

Value of setting in the desired document.

This property was added in vSphere API 8.0.1.0.

This field is missing or null if there is no value in the desired document to report.

string
type
Optional

The data type of the property in document pointed by {#path}.

Possible values:

  • PRIMITIVE: The property in drift is of primitive data type.
  • OBJECT: The property in drift is of type object.
  • ARRAY_OF_OBJECTS: The property in drift is of array of object data type.
  • REFERENCE: The drift is in reference configuration.
  • ARRAY_OF_PRIMITIVES: The property in drift is of array of primitive data type.

For more information see: Esx.Settings.Clusters.Configuration.SettingCompliance.Type.

This property was added in vSphere API 9.0.0.0.

This field is missing or null if the data type of the property is not available in the drift provided by the ESXi host.

string
reference_current
Optional

Value of the reference configuration on the ESXi host encoded as JSON.

This property was added in vSphere API 9.0.0.0.

This field is missing or null if host does not have reference configuration.

string
reference_target
Optional

Value of the reference configuration in the desired state encoded as JSON.

This property was added in vSphere API 9.0.0.0.

This field is missing or null if desired state does not have reference configuration.

error
Optional

This field contains an error message that describes the reason for the setting to be non compliant.

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

This field is missing or null if solution configuration is successfully realized.

Property Of