Flush Depots Online Task
The task-based Online.flush operation removes content of a system-defined online depot from vLCM completely. As a result, the system-defined online depot will be disabled. Note: To remove content of user-imported online depots, use the task-based Online.delete operation.
Request
URLURL
https://{api_host}/api/esx/settings/depots/online/{depot}?action=flush&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.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
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.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the given depot is NOT system-defined. | 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.
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. Online.flush is a task-based 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 FlushResult structure that lists all the errors encountered.
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-FlushDepotOnlineAsync -Depot "MyDepot"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/online/{depot}?action=flush&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: flush_task
Availability
Added in 7.0.0.0
On This Page
Depots Online Operations
post
delete
patch
delete
