Esx.Settings.Depots.Offline.CreateSpec

The Esx.Settings.Depots.Offline.CreateSpec schema defines the information used to create a depot.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "authentication_spec": {
        "method": "string",
        "authentication_key": "string",
        "authentication_value": "string"
    },
    "description": "string",
    "source_type": "string",
    "location": "string",
    "file_id": "string",
    "ownerdata": "string"
}

authentication_spec

Optional

Describe the authentication to be used for connecting to the remote depot.

This property was added in vSphere API 9.0.0.0.

If missing or null, no authentication will be done.

string

description

Optional

Description of the depot.

This property was added in vSphere API 7.0.0.0.

If missing or null, the description will be empty.

string

source_type

Required

Type of the source from which offline bundle is obtained.

Possible values:

PULL: Content is pulled from the URL location. The URL scheme of the value in {@link CreateSpec#location) can be http, https or file.
PUSH: Content was previously uploaded using the file upload endpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/vum-fileupload URL.

For more information see: Esx.Settings.Depots.Offline.SourceType.

This property was added in vSphere API 7.0.0.0.

string As uri As uri

location

Optional

Location of the depot from which content should be retrieved.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of source_type is Esx.Settings.Depots.Offline.SourceType.PULL.

string

file_id

Optional

File identifier returned by the file upload endpoint after file is uploaded.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of source_type is Esx.Settings.Depots.Offline.SourceType.PUSH.

string

ownerdata

Optional

Private data saved by the Esx.Settings.Depots.Offline.Info.owner of the depot. It is opaque to vLCM.

This property was added in vSphere API 7.0.3.0.

If missing or null, no ownerdata will be saved.