Virtual Disk Manager Delete Virtual Disk Task

Virtual Disk Manager Delete Virtual Disk Task

Deprecated as of vSphere 6.5, use HostDeleteVStorageObject_Task instead.

Delete a virtual disk.

All files relating to the disk will be deleted.

Deletion of virtual disk is prohibited if it is attached to VMs.

The datacenter parameter may be omitted if a URL is used to name the disk.

Requires Datastore.FileManagement privilege on the datastore where the virtual disk is removed.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/VirtualDiskManager/{moId}/DeleteVirtualDisk_Task
COPY
Path Parameters
string
moId
Required

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 VirtualDiskManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body
DeleteVirtualDiskRequestType of type(s) application/json
Required

Show optional properties

{
    "name": "string"
}
{
    "name": "string",
    "datacenter": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
string
name
Required

The name of the disk, either a datastore path or a URL referring to the virtual disk to be deleted.

MoRefDatacenter
datacenter
Optional

Reference to an instance of the Datacenter managed object.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject 
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

FileFault: if an error occurs deleting the virtual disk.

InvalidDatastore: if the operation cannot be performed on the datastore.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Infrastructure Operations
POST
Virtual Disk Manager Copy Virtual Disk Task
POST
Virtual Disk Manager Create Virtual Disk Task
POST
Virtual Disk Manager Defragment Virtual Disk Task
POST
Virtual Disk Manager Delete Virtual Disk Task
POST
Virtual Disk Manager Eager Zero Virtual Disk Task
POST
Virtual Disk Manager Extend Virtual Disk Task
POST
Virtual Disk Manager Import Unmanaged Snapshot
POST
Virtual Disk Manager Inflate Virtual Disk Task
POST
Virtual Disk Manager Move Virtual Disk Task
POST
Virtual Disk Manager Query Virtual Disk Fragmentation
POST
Virtual Disk Manager Query Virtual Disk Geometry
POST
Virtual Disk Manager Query Virtual Disk Uuid
POST
Virtual Disk Manager Release Managed Snapshot
POST
Virtual Disk Manager Set Virtual Disk Uuid
POST
Virtual Disk Manager Shrink Virtual Disk Task
POST
Virtual Disk Manager Zero Fill Virtual Disk Task