Host Datastore System Query Vmfs Datastore Extend Options

Queries for options for increasing the capacity of an existing VMFS datastore by adding new extents using space from the specified disk.

See also devicePath.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostDatastoreSystem/{moId}/QueryVmfsDatastoreExtendOptions

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 HostDatastoreSystem/{moId}.

string

release

Required

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

Request Body

QueryVmfsDatastoreExtendOptionsRequestType of type(s) application/json

Required

{
    "datastore": {
        "type": "string",
        "value": "string"
    },
    "devicePath": "string",
    "suppressExpandCandidates": false
}

MoRefDatastore

datastore

Required

Reference to an instance of the Datastore managed object.

string

devicePath

Required

The devicePath of the disk on which datastore extension options are generated.

boolean

suppressExpandCandidates

Optional

Indicates whether to exclude options that can be used for extent expansion also. Free space can be used for adding an extent or expanding an existing extent. If this parameter is set to true, the list of options returned will not include free space that can be used for expansion.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

An array of VMFS datastore provisioning options that can be applied on a disk.

Returns Array of VmfsDatastoreOption of type(s) application/json

[
    {
        "_typeName": "string",
        "info": {
            "layout": {
                "total": {
                    "blockSize": 0,
                    "block": 0
                },
                "partition": [
                    {
                        "_typeName": "string",
                        "partition": 0,
                        "type": "string",
                        "start": {
                            "blockSize": 0,
                            "block": 0
                        },
                        "end": {
                            "blockSize": 0,
                            "block": 0
                        }
                    }
                ]
            },
            "partitionFormatChange": false
        },
        "spec": {
            "diskUuid": "string"
        }
    }
]

500

NotFound: if a datastore or device with the given name could not be found or if the datastore is unmounted.

HostConfigFault: if unable to get the current partition information for the device.

NotSupported: if the host is not an ESX Server.

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

Host Datastore System Operations