Esx.Settings.Clusters.Configuration.Plugins.ClusterSolutionCompliance

This Esx.Settings.Clusters.Configuration.Plugins.ClusterSolutionCompliance schema contains properties that describes the check compliance for a cluster solution.

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

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

JSON Example

{
    "config_compliance": {
        "config_compliance": "string"
    },
    "display_name": "Vapi.Std.LocalizableMessage Object",
    "status": "string",
    "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
                }
            }
        ]
    },
    "host_compliance_info": {
        "host_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
                    }
                }
            ]
        }
    },
    "errors": [
        {
            "path": "string",
            "display_path": [
                "string"
            ],
            "messages": [
                "Vapi.Std.LocalizableMessage Object"
            ]
        }
    ],
    "summary": "Vapi.Std.LocalizableMessage Object"
}

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.

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.

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.

display_name

Required

Display name of Cluster Solution.

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.

string

status

Required

This field indicates whether the Cluster Solution is compliant with the desired cluster configuration specified in #com.vmware.esx.settings.clusters.configuration.ConfigurationSpec. If COMPLIANT, no other information is available. If NON_COMPLAINT, drift information can be fetched from {#ComplianceInfo}

Possible values:

COMPLIANT: Solution is in compliance with Desired configuration.
NON_COMPLIANT: Solution is not in compliance with Desired configuration.
ERROR: Solution failed while checking for compliance.

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

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.

compliance_info

Optional

Settings compliance information generated by the CheckCompliance operation.

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 set only when the Esx.Settings.Clusters.Configuration.SolutionComplianceResult.status is NON_COMPLAINT

object

host_compliance_info

Optional

Map of host IDs to ComplianceInfo. Settings compliance information generated by the CheckCompliance operation for host-specific configurations of cluster solutions.

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 set only when the Esx.Settings.Clusters.Configuration.SolutionComplianceResult.status is NON_COMPLAINT

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: HostSystem. 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: HostSystem.

array of Esx.Settings.Clusters.Configuration.ValidationError

errors

Optional

List of validation errors returned by the Cluster solution. This is only set for Esx.Settings.Clusters.Configuration.SolutionComplianceResult.ComplianceStatus.ERROR case.

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 set only in case of solution plugin errors

summary

Required

Summarizing check compliance operation for the cluster solution.

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.