Esx. Settings. Depots. Offline Delete
The task-based delete operation removes content of an imported offline depot from vLCM completely.
Note: The non task-based 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.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error 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.offline.
The delete spec.
This parameter was added in vSphere API 9.0.0.0.
This parameter is optional because it was added in a newer version than its parent node.
"Esx.Settings.Depots.Offline.DeleteSpec Object"
Success!
Vapi.Std.Errors.InvalidArgument If the given depot is system-defined. This error is applicable to the task-based delete operation only.
Vapi.Std.Errors.ResourceInUse If the content of depot to be deleted is used in some baseline or desired state. The value of the data property of Vapi.Std.Errors.Error will be the PrecheckResult schema that lists the information of affected baselines and desired states. This error is applicable to the task-based delete operation only.
"Vapi.Std.Errors.Error Object"
If the caller is not authenticated.
"Vapi.Std.Errors.Unauthenticated Object"
If there is no depot associated with parameter depot in the system.
"Vapi.Std.Errors.NotFound Object"
If there some unknown internal error. The accompanying error message will give more details about the failure. For task-based 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 property of Vapi.Std.Errors.Error will be the DeleteResult schema that lists all the errors encountered.
"Vapi.Std.Errors.Error Object"
If the service is not available.
"Vapi.Std.Errors.ServiceUnavailable Object"
curl -X DELETE -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/esx/settings/depots/offline/{depot}