Get Depots Online
Gets the information about a currently configured online software depot. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/depots/online/{depot}
Path Parameters
Path Parameters
string
depot
Required
Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsDepotsOnlineInfo
of type application/json
Information of the currently configured online software depot.
{
"description": "string",
"enabled": false,
"location": "string",
"owner": "string",
"ownerdata": "string",
"system_defined": false
}
string
description
Required
Description of the depot. It will be an empty string if no description was provided during create.
boolean
enabled
Required
Flag indicating whether this depot is enabled or not.
string
location
Required
Location of the depot.
boolean
system_defined
Required
Flag to indicate if the depot is system defined. System defined depot can not be deleted.
string
owner
Optional
Name of the user creating the depot. This field is optional because it was added in a newer version than its parent node.
string
ownerdata
Optional
Private data saved by the Online.Info.owner of depot. It is opaque to vLCM. This field is optional because it was added in a newer version than its parent node.
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no depot with given identifier depot in the system.
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
Invoke-GetDepotOnline -Depot "MyDepot"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/online/{depot}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0
On This Page
Depots Online Operations
post
patch
delete
delete
