Virtual Machine Attach Disk Task

Attach an existing disk to this virtual machine.

A minimum virtual machine version of 'vmx-13' is required for this operation to succeed. If a compatible VM version is not satisfied, a DeviceUnsupportedForVmVersion fault will be thrown.

Required privileges: VirtualMachine.Config.AddExistingDisk

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/AttachDisk_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 VirtualMachine/{moId}.

string

release

Required

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

Request Body

AttachDiskRequestType of type(s) application/json

Required

Show optional properties

{
    "diskId": {
        "id": "string"
    },
    "datastore": {}
}

{
    "diskId": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "controllerKey": 0,
    "unitNumber": 0
}

diskId

Required

This data object type describes an identifier class which is globally unique to identify the associated object.

MoRefDatastore

datastore

Required

Reference to an instance of the Datastore managed object.

integer As int32 As int32

controllerKey

Optional

Key of the controller the disk will connect to. It can be unset if there is only one controller (SCSI or SATA) with the available slot in the virtual machine. If there are multiple SCSI or SATA controllers available, user must specify the controller; if there is no available controllers, a MissingController fault will be thrown.

integer As int32 As int32

unitNumber

Optional

The unit number of the attached disk on its controller. If unset, the next available slot on the specified controller or the only available controller will be assigned to the attached disk.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

NotFound: if the disk object cannot be found.

VmConfigFault: if the virtual machine's configuration is invalid.

FileFault: if there is a problem creating or accessing the virtual machine's files for this operation.

InvalidState: if the operation cannot be performed in the current state of the virtual machine. For example, because the virtual machine's configuration is not available.

InvalidDatastore: If the datastore cannot be found or inaccessible.

InvalidController: If the specified controller cannot be found or the specified unitNumber is already taken, or the controller has no free slots.

MissingController: If the virtual machine has no or more than one available controllers when controllerKey is unset.

DeviceUnsupportedForVmVersion: If the virtual machine's version is incompatible for the given device.

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 Infrastructure Operations