Delete Data Sets
Delete a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetDelete.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/data-sets/{data_set}
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.
string
data_set
Required
Identifier of the data set to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.
Query Parameters
Query Parameters
boolean
force
Optional
If true, delete the data set even if it is not empty. If unset a ResourceInUse error will be reported if the data set is not empty. This is the equivalent of passing the value false.
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.not_allowed_in_current_state : if the virtual machine is in a state that doesn’t allow modifications, for example suspended. | com.vmware.vapi.std.errors.resource_in_use : if the data set is not empty and force is not set. | com.vmware.vapi.std.errors.unsupported : if the virtual hardware version of the virtual machine does not support DataSets if the ESXi host version does not support DataSets
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. if the data set is not found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
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-DeleteVmDataSet -Vm "MyVm" -DataSet "MyDataSet" -Force $true
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/data-sets/{data_set}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 8.0.0.0
On This Page
Data Sets Operations
get
post
get
patch
delete
