File Manager Delete Datastore File Task
Deletes the specified file or folder from the datastore.
If a file of a virtual machine is deleted, it may corrupt that virtual machine. Folder deletes are always recursive. The datacenter parameter may be omitted if a URL is used to name the file or folder.
If the source is an extent of a virtual disk, this operation treats the extent as a file.
It is important to note that this operation will provide transactional guarantees only for a file. No guarantees are provided when deleting folders. If the intent is to delete a virtual machine registered in the inventory, please refer to Destroy_Task.
Requires Datastore.FileManagement privilege on the datastore.
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case FileManager/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"name": "string",
"datacenter": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
The name of the file or folder, either a URL or a datastore path referring to the file or folder to be deleted.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
InvalidDatastore: if the operation cannot be performed on the datastore. Typically, a specific subclass of this exception is thrown.
FileNotFound: if the file or folder specified by name is not found.
CannotDeleteFile: if the delete operation on the file or folder fails.
FileLocked: if the source file or folder is currently locked or in use.
FileFault: if there is a generic file error
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}