Esx.Settings.Clusters.Configuration.Plugins.HostImpactResult

Esx.Settings.Clusters.Configuration.Plugins.HostImpactResult
Esx.Settings.Clusters.Configuration.Plugins.HostImpactResult

This Esx.Settings.Clusters.Configuration.Plugins.HostImpactResult schema contains properties that describe impact for an ESXi host. The result is generated by executing the check-compliance plugins to get compliance information. The impact information is computed for each ESXi host which is not compliant with desired configuration.

This schema was added in vSphere API 9.0.0.0.

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

JSON Example
{
    "impact": "string",
    "info": [
        "Vapi.Std.LocalizableMessage Object"
    ],
    "status": "string",
    "config_compliance": {
        "config_compliance": "string"
    },
    "errors": [
        {
            "path": "string",
            "display_path": [
                "string"
            ],
            "messages": [
                "Vapi.Std.LocalizableMessage Object"
            ]
        }
    ],
    "compliance_info": {
        "sets": [
            {
                "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
                }
            }
        ],
        "adds": [
            {
                "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
                }
            }
        ],
        "deletes": [
            {
                "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
impact
Optional

Possible values:

  • NO_IMPACT: Host has no impact.
  • MAINTENANCE_MODE_REQUIRED: Host requires maintenance mode to reach the desired state.
  • REBOOT_REQUIRED: Host requires reboot to reach the desired state.

For more information see: Esx.Settings.Clusters.Configuration.ImpactType.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is Esx.Settings.Clusters.Configuration.Plugins.ComplianceStatus.NON_COMPLIANT.

array of Vapi.Std.LocalizableMessage
info
Optional

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is Esx.Settings.Clusters.Configuration.Plugins.ComplianceStatus.NON_COMPLIANT.

string
status
Required

Compliance Status of the host.

Possible values:

  • COMPLIANT: Host is compliant.
  • NON_COMPLIANT: Host is not compliant.
  • ERROR: Host failed to set compliance status.
  • UNKNOWN: Host compliance status is not known.

For more information see: Esx.Settings.Clusters.Configuration.Plugins.ComplianceStatus.

This property was added in vSphere API 9.0.0.0.

object
config_compliance
Optional

Compliance Status per configuration.

Possible values:

  • COMPLIANT: Host is compliant.
  • NON_COMPLIANT: Host is not compliant.
  • ERROR: Host failed to set compliance status.
  • UNKNOWN: Host compliance status is not known.

For more information see: Esx.Settings.Clusters.Configuration.Plugins.ComplianceStatus.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.configuration.component.group.key. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.configuration.component.group.key.

array of Esx.Settings.Clusters.Configuration.ValidationError
errors
Optional

Captures error returned by the plugins.

This property was added in vSphere API 9.0.0.0.

compliance_info
Optional

Compliance drift computed by the plugins.

This property was added in vSphere API 9.0.0.0.