Virtual Disk Manager Copy Virtual Disk Task

Copy a virtual disk, performing conversions as specified in the spec.

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, regardless of destSpec content.

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}/CopyVirtualDisk_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

CopyVirtualDiskRequestType of type(s) application/json

Required

{
    "sourceName": "string",
    "sourceDatacenter": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "destName": "string",
    "destDatacenter": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "destSpec": {
        "_typeName": "string",
        "diskType": "string",
        "adapterType": "string"
    },
    "force": false
}

string

sourceName

Required

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

MoRefDatacenter

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 virtual disk to be created.

MoRefDatacenter

destDatacenter

Optional

Reference to an instance of the Datacenter managed object.

VirtualDiskSpec

destSpec

Optional

Specification used to create or clone a virtual disk

boolean

force

Optional

The force flag is currently ignored. The FileAlreadyExists fault is thrown if the destination file already exists.

Authentication

This operation uses the following authentication methods.

Session

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

InvalidDatastore: if the operation cannot be performed on the source or destination datastore.

InvalidDiskFormat: if the destination's format is not supported.

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

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Disk Manager Operations

POST

Virtual Disk Manager Copy Virtual Disk Task