Virtual Disk Manager Move Virtual Disk Task

Virtual Disk Manager Move Virtual Disk Task

Move a virtual disk and all related files from the source location specified by sourceName and sourceDatacenter to the destination location specified by destName and destDatacenter.

If source (or destination) name is specified as a URL, then the corresponding datacenter parameter may be omitted.

If source and destination resolve to the same file system location, the call has no effect.

Requires Datastore.FileManagement privilege on both source and destination datastores.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/VirtualDiskManager/{moId}/MoveVirtualDisk_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.2.0 APIs.


Request Body
MoveVirtualDiskRequestType of type(s) application/json
Required
{
    "sourceName": "string",
    "sourceDatacenter": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "destName": "string",
    "destDatacenter": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "force": false,
    "profile": [
        {
            "_typeName": "string"
        }
    ]
}
string
sourceName
Required

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

sourceDatacenter
Optional

Reference to an instance of the Datacenter managed object.

string
destName
Required

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

destDatacenter
Optional

Reference to an instance of the Datacenter managed object.

boolean
force
Optional

If true, overwrite any indentically named disk at the destination. If not specified, it is assumed to be false

profile
Optional

User can specify new set of profile when moving virtual disk.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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 renaming the virtual disk.

InvalidDatastore: if the operation cannot be performed on the source or destination 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"
        }
    ]
}