Host Datastore System Query Vmfs Datastore Create Options

Host Datastore System Query Vmfs Datastore Create Options

Queries options for creating a new VMFS datastore for a disk.

See also devicePath.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostDatastoreSystem/{moId}/QueryVmfsDatastoreCreateOptions
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
Required
{
    "devicePath": "string",
    "vmfsMajorVersion": 0
}
string
devicePath
Required

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

integer As int32 As int32
vmfsMajorVersion
Optional

major version of VMFS to be used for formatting the datastore. If this parameter is not specified, then the highest supported VMFS major version for the host is used.

Authentication
This operation uses the following authentication methods.
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": {
            "_typeName": "string",
            "layout": {
                "_typeName": "string",
                "total": {
                    "_typeName": "string",
                    "blockSize": 0,
                    "block": 0
                },
                "partition": [
                    {
                        "_typeName": "string",
                        "partition": 0,
                        "type": "string",
                        "start": {
                            "_typeName": "string",
                            "blockSize": 0,
                            "block": 0
                        },
                        "end": {
                            "_typeName": "string",
                            "blockSize": 0,
                            "block": 0
                        }
                    }
                ]
            },
            "partitionFormatChange": false
        },
        "spec": {
            "_typeName": "string",
            "diskUuid": "string"
        }
    }
]

500

NotSupported: if the host is not an ESX Server.

NotFound: if the device is not found.

HostConfigFault: if unable to get the current partition information for the 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"
        }
    ]
}