Esx.Settings.Hosts.Configuration.DraftImportResult

Esx.Settings.Hosts.Configuration.DraftImportResult
Esx.Settings.Hosts.Configuration.DraftImportResult

The Esx.Settings.Hosts.Configuration.DraftImportResult schema contains properties that describe the result of importing the desired configuration for a standalone host into a draft.

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.

JSON Example
{
    "status": "string",
    "draft": "string",
    "error": "Vapi.Std.LocalizableMessage Object",
    "warnings": [
        "Vapi.Std.LocalizableMessage Object"
    ]
}
string
status
Required

Status of importing desired configuration.

Possible values:

  • RUNNING: The task is in-progress.
  • OK: Desired configuration imported successfully.
  • ERROR: Desired configuration import failed with error.
  • CANCELED: Import operation was canceled

For more information see: Esx.Settings.Hosts.Configuration.DraftImportResult.Status.

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
draft
Optional

This identifier refers to the commit action of importing the desired configuration document.

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 property is optional and it is only relevant when the value of status is Esx.Settings.Hosts.Configuration.DraftImportResult.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.draft. 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.draft.

error
Optional

Localized message describing the error encountered while importing desired configuration. The import operation will fail if the configuration document is an invalid JSON.

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 property is optional and it is only relevant when the value of status is Esx.Settings.Hosts.Configuration.DraftImportResult.Status.ERROR.

array of Vapi.Std.LocalizableMessage
warnings
Optional

Any issues found during the import are reported in this list.

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.