Create Depots Offline Task
Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no offline depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
Request
URLURL
https://{api_host}/api/esx/settings/depots/offline?vmw-task=true
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
SettingsDepotsOfflineCreateSpec of mimetype application/json
Required
Specification to import an offline depot.
{
"source_type": "PULL"
}
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
description
Optional
Description of the depot. If unset, the description will be empty.
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.CreateSpec.source-type is PUSH.
string
location
Optional
Location of the depot from which content should be retrieved. This field is optional and it is only relevant when the value of Offline.CreateSpec.source-type is PULL.
string
ownerdata
Optional
Private data saved by the Offline.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
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. Identifier of the imported depot as part of result structure.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If an invalid Offline.CreateSpec.location is provided. | com.vmware.vapi.std.errors.already_exists : If the depot content already exists. The value of the data field of Error will be a structure that contains existing depot identifier as part of depot field defined in Offline.CreateResult.
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
$SettingsDepotsOfflineCreateSpec = Initialize-SettingsDepotsOfflineCreateSpec -SourceType "PULL"
Invoke-CreateDepotsOfflineAsync -SettingsDepotsOfflineCreateSpec $SettingsDepotsOfflineCreateSpec
PowerCLI Client SDK All Parameters Example
$SettingsDepotsOfflineCreateSpec = Initialize-SettingsDepotsOfflineCreateSpec -Description "MyDescription" -SourceType "PULL" -Location "MyLocation" -FileId "MyFileId" -Ownerdata "MyOwnerdata"
Invoke-CreateDepotsOfflineAsync -SettingsDepotsOfflineCreateSpec $SettingsDepotsOfflineCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","file_id":"string","location":"string","ownerdata":"string","source_type":"PULL"}' https://{api_host}/api/esx/settings/depots/offline?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_task
Availability
Added in 7.0.0.0
On This Page
Depots Offline Operations
delete
delete
