Virtual Disk Manager Extend Virtual Disk Task

Expand the capacity of a virtual disk to the new capacity.

Deprecated as of vSphere 6.5, use HostExtendDisk_Task instead.

Expand the capacity of a virtual disk to the new capacity.

If the eagerZero flag is not specified, - the extended disk region of a zerothick disk will be zeroedthick - the extended disk region of a eagerzerothick disk will be eagerzeroedthick - a thin-provisioned disk will always be extended as a thin-provisioned disk. If the eagerZero flag TRUE, the extended region of the disk will always be eagerly zeroed. If the eagerZero flag FALSE, the extended region of a zeroedthick or eagerzeroedthick the disk will not be eagerly zeroed. This condition has no effect on a thin source disk.

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 resides.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualDiskManager/{moId}/ExtendVirtualDisk_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.1.0.0 APIs.

Request Body

ExtendVirtualDiskRequestType of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "newCapacityKb": 0
}

{
    "name": "string",
    "datacenter": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "newCapacityKb": 0,
    "eagerZero": false
}

string

name

Required

The name of the disk, either a datastore path or a URL referring to the virtual disk whose capacity should be expanded.

datacenter

Optional

If name 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, name must be a URL.

integer As int64 As int64

newCapacityKb

Required

The new capacty of the virtual disk in Kb.

boolean

eagerZero

Optional

If true, the extended part of the disk will be explicitly filled with zeroes.

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 extending 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": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string","newCapacityKb":"integer"}' https://{api_host}/sdk/vim25/{release}/VirtualDiskManager/{moId}/ExtendVirtualDisk_Task

Deprecated

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST