Create Depots Online
Adds a new online software depot to the list of currently configured online software depots. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
Request
URLURL
https://{api_host}/api/esx/settings/depots/online
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
{
"location": "string"
}
string
location
Required
Location of the depot. It should be the location to the index.xml for the depot.
string
description
Optional
Description of the depot. If unset, the description will be empty.
boolean
enabled
Optional
Flag indicating whether this depot is enabled or not. Disabling the depot doesn’t delete its cached metadata and payloads. It will not be refreshed next time depots are re-synced. If unset, the depot will be enabled.
string
ownerdata
Optional
Private data saved by the Online.Info.owner of the depot. It is opaque to vLCM. If unset, no ownerdata will be saved.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
Identifier of the currently configured online depot. The result will be an identifier for the resource type: com.vmware.esx.settings.depots.online.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If an invalid location is provided. | com.vmware.vapi.std.errors.already_exists : If depot with given location already exists.
500
com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$SettingsDepotsOnlineCreateSpec = Initialize-SettingsDepotsOnlineCreateSpec -Location "MyLocation"
Invoke-CreateDepotsOnline -SettingsDepotsOnlineCreateSpec $SettingsDepotsOnlineCreateSpec
PowerCLI Client SDK All Parameters Example
$SettingsDepotsOnlineCreateSpec = Initialize-SettingsDepotsOnlineCreateSpec -Description "MyDescription" -Location "MyLocation" -Enabled $false -Ownerdata "MyOwnerdata"
Invoke-CreateDepotsOnline -SettingsDepotsOnlineCreateSpec $SettingsDepotsOnlineCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","enabled":false,"location":"string","ownerdata":"string"}' https://{api_host}/api/esx/settings/depots/online
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.0.0
On This Page
Depots Online Operations
post
patch
delete
delete
