Delete Depots Offline Task
The task-based Offline.delete operation removes content of an imported offline depot from vLCM completely. Note: The non task-based Offline.delete operation has been deprecated. It deletes only the record of depot from the list of imported offline software depots, instead of removing the depot’s content from vLCM. 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/offline/{depot}?vmw-task=true
Path Parameters
Path Parameters
string
depot
Required
Identifier of the depot to be removed. 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, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
204 No Content 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.
PowerCLI Client SDK Example
Invoke-DeleteDepotOfflineAsync -Depot "MyDepot"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/offline/{depot}?vmw-task=true
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the given depot is system-defined. This error is applicable to the task-based Offline.delete operation only. | com.vmware.vapi.std.errors.resource_in_use : If the content of depot to be deleted is used in some baseline or desired state. The value of the data field of Error will be the PrecheckResult structure that lists the information of affected baselines and desired states. This error is applicable to the task-based Offline.delete operation only.
404
com.vmware.vapi.std.errors.not_found : If there is no depot associated with parameter depot in the system.
500
com.vmware.vapi.std.errors.error : If there some unknown internal error. The accompanying error message will give more details about the failure. For task-based Offline.delete operation, once the task is started, it does NOT stop if encountering an error. Instead, it will continuously run to completion. In this case, the value of the data field of Error will be the DeleteResult structure that lists all the errors encountered.
Availability
Added in 7.0.0
On This Page
Depots Offline Operations
delete
delete
