Esx.Settings.Depots.Offline.AuthenticationSpec

The Esx.Settings.Depots.Offline.AuthenticationSpec schema contains properties that describe the authentication to be used for connecting to the remote depot. Esx.Settings.Depots.Offline.CreateSpec operation.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "method": "string",
    "authentication_key": "string",
    "authentication_value": "string"
}

string

method

Required

Specifies what method of authentication (AuthenticationMethod) is to be used when connecting to remote depot.

Possible values:

HEADER_AUTH: HEADER_AUTH is intended to be used when connecting to a remote depot

For more information see: Esx.Settings.Depots.Offline.AuthenticationSpec.AuthenticationMethod.

This property was added in vSphere API 9.0.0.0.

string

authentication_key

Optional

Specifies the authentication key to be used during the POST /esx/settings/depots/offline PULL operation.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of method is Esx.Settings.Depots.Offline.AuthenticationSpec.AuthenticationMethod.HEADER_AUTH.

string

authentication_value

Optional

Specifies the authentication value of the authentication key to be used during the POST /esx/settings/depots/offline PULL operation.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of method is Esx.Settings.Depots.Offline.AuthenticationSpec.AuthenticationMethod.HEADER_AUTH.