Get Depots Offline
Gets the information about an imported offline 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/offline/{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.offline.
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
SettingsDepotsOfflineInfo
of type application/json
Information about the imported offline software depot.
{
"create_time": "string",
"description": "string",
"file_id": "string",
"location": "string",
"owner": "string",
"ownerdata": "string",
"source_type": "PULL"
}
string
create_time
Required
Time when the depot was created.
string
description
Required
Description of the depot. If not set during import, it will be empty.
source_type
Required
The Offline.SourceType enumerated type defines possible values of sources for the offline depot.
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 enpoint present on vCenter appliance. This endpoint is present at https://VCENTERFQDN:9087/vum-fileupload URL.
Possible values are: PULL , PUSH
string
file_id
Optional
File identifier returned by the file upload endpoint after file is uploaded. This field is optional and it is only relevant when the value of Offline.Info.source-type is PUSH.
string
location
Optional
Location of the depot from which content is retrieved. This field is optional and it is only relevant when the value of Offline.Info.source-type is PULL.
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 Offline.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-GetDepotOffline -Depot "MyDepot"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/offline/{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.0
On This Page
Depots Offline Operations
delete
delete
