Delete Depots Online Task
The task-based Online.delete operation removes content of a user-imported online depot from vLCM completely. As a result, the URL of the user-imported online depot will also be removed. Note: 1. To remove content of system-defined online depots, use Online.flush operation. 2. The non task-based Online.delete operation has been deprecated. It only deletes the record of depot from the list of imported online software depots, instead of removing the depot’s content from the system. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.
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 system-defined. This error is applicable to the task-based Online.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 Online.delete operation only.
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. For task-based Online.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.
com.vmware.vapi.std.errors.service_unavailable : If the service is not available.
PowerCLI Client SDK Example