Virtual Disk Manager Copy Virtual Disk Task

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://{api_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 9.0.0.0 APIs.

Request Body
CopyVirtualDiskRequestType of type(s) application/json
Required 
"CopyVirtualDiskRequestType Object"
string
sourceName
Required

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

sourceDatacenter
Optional

If sourceName is a datastore path, the datacenter for that datastore path. Not needed when invoked directly on ESX. If not specified on a call to VirtualCenter, sourceName must be a URL.

string
destName
Required

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

destDatacenter
Optional

If destName is a datastore path, the datacenter for that datastore path. Not needed when invoked directly on ESX. If not specified on a call to VirtualCenter, it is assumed that the destination path belongs to the source datacenter.

destSpec
Optional

The specification of the virtual disk to be created. If not specified, a preallocated format and busLogic adapter type is assumed.

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.
Responses
200

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

Returns MoRefTask of type(s) application/json 
"MoRefTask Object"

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: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/VirtualDiskManager/{moId}/CopyVirtualDisk_Task
On This Page
Virtual Infrastructure Operations
POST
Virtual Disk Manager Copy Virtual Disk Task
POST
Virtual Disk Manager Create Virtual Disk Task
Deprecated
POST
Virtual Disk Manager Defragment Virtual Disk Task
Deprecated
POST
Virtual Disk Manager Delete Virtual Disk Task
Deprecated
POST
Virtual Disk Manager Eager Zero Virtual Disk Task
POST
Virtual Disk Manager Extend Virtual Disk Task
Deprecated
POST
Virtual Disk Manager Import Unmanaged Snapshot
POST
Virtual Disk Manager Inflate Virtual Disk Task
Deprecated
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
Deprecated
POST
Virtual Disk Manager Release Managed Snapshot
POST
Virtual Disk Manager Set Virtual Disk Uuid
Deprecated
POST
Virtual Disk Manager Shrink Virtual Disk Task
Deprecated
POST
Virtual Disk Manager Zero Fill Virtual Disk Task