Delete Depots UMDs
The task-based Umds.delete operation removes content of the UMDS depot from vLCM completely. Note: The non task-based Umds.delete operation has been deprecated. It deletes only the record of UMDS depot from database, instead of removing the content of UMDS depot from vLCM. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleDepots.Delete.
Request
URLURL
https://{api_host}/api/esx/settings/depots/umds
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.
Errors
Errors
400
com.vmware.vapi.std.errors.resource_in_use : If the content of UMDS 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 Umds.delete operation only.
404
com.vmware.vapi.std.errors.not_found : If there is no UMDS depot configured 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 Umds.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.
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-DeleteDepotsUmds
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/umds
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 7.0.0.0
On This Page
Depots UMDs Operations
get
put
patch
delete
delete
