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.
Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online.
Required session ID, acquired from Create Session API under CIS product
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.
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.
com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated.
com.vmware.vapi.std.errors.not_found : If there is no depot associated with parameter depot in the system.
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.
com.vmware.vapi.std.errors.service_unavailable : If the service is not available.
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
PowerCLI Client SDK Example