Esx.Settings.Clusters.Configuration.ImportResult

This Esx.Settings.Clusters.Configuration.ImportResult schema contains properties that describe the result of importing a configuration document in the cluster.

This schema was added in vSphere API 8.0.1.0.

JSON Example

{
    "status": "string",
    "commit": "string",
    "errors": [
        {
            "path": "string",
            "display_path": [
                "string"
            ],
            "messages": [
                "Vapi.Std.LocalizableMessage Object"
            ]
        }
    ]
}

string

status

Required

Possible values:

RUNNING: The task is in-progress.
OK
ERROR
CANCELED

For more information see: Esx.Settings.Clusters.Configuration.ImportResult.Status.

This property was added in vSphere API 8.0.1.0.

string

commit

Optional

This identifier refers to the commit action of importing the desired configuration document. This identifier can be used in the apply API.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is Esx.Settings.Clusters.Configuration.ImportResult.Status.OK.

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

array of Esx.Settings.Clusters.Configuration.ValidationError

errors

Optional

Lists all validation errors identified in the configuration document.

This property was added in vSphere API 8.0.1.0.

This is set when #success is false.