Host V Storage Object Manager Host Extend Disk Task

Expand the capacity of a virtual disk, which is a storage object with disk, to the new capacity.

If new capacity is smaller than current disk capacity, then operation fails due to invalid capacity. If new capacity is greater than current disk capacity, then operation proceeds. If new capacity is equal to current disk ccapcity, then operation succeeds without any actual extension. The extended disk region will be the same as the original disk: - For a zerothick disk, the extended disk region will be zeroedthick. - For an eagerzerothick disk, the extended disk region will be eagerzeroedthick - A thin-provisioned disk will always be extended as a thin-provisioned disk.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

Required privileges: System.View

Request

URI

POST

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

string

release

Required

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

Request Body

HostExtendDiskRequestType of type(s) application/json

Required

Show optional properties

{
    "id": {
        "id": "string"
    },
    "datastore": {},
    "newCapacityInMB": 0
}

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "newCapacityInMB": 0
}

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 int64 As int64

newCapacityInMB

Required

The new capacity of the virtual disk in MB.

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

NotFound: If the specified virtual storage object cannot be found.

InvalidDatastore: If the operation cannot be performed on the datastore.

InvalidState: If the operation cannot be performed on the disk. The disk may be consumed and cannot be extended.

TaskInProgress: If the virtual storage object is busy.

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