Host Datastore System Create Vmfs Datastore

Creates a new VMFS datastore.

Required privileges: Host.Config.Storage

Request

URI

POST

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

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

CreateVmfsDatastoreRequestType of type(s) application/json

Required

{
    "spec": {
        "partition": {
            "partitionFormat": "string",
            "chs": {
                "cylinder": 0,
                "head": 0,
                "sector": 0
            },
            "totalSectors": 0,
            "partition": [
                {
                    "_typeName": "string",
                    "partition": 0,
                    "startSector": 0,
                    "endSector": 0,
                    "type": "string",
                    "guid": "string",
                    "logical": false,
                    "attributes": 0,
                    "partitionAlignment": 0
                }
            ]
        },
        "vmfs": {
            "extent": {
                "diskName": "string",
                "partition": 0
            },
            "blockSizeMb": 0,
            "majorVersion": 0,
            "volumeName": "string",
            "blockSize": 0,
            "unmapGranularity": 0,
            "unmapPriority": "string",
            "unmapBandwidthSpec": {
                "policy": "string",
                "fixedValue": 0,
                "dynamicMin": 0,
                "dynamicMax": 0
            }
        },
        "extent": [
            {
                "_typeName": "string",
                "diskName": "string",
                "partition": 0
            }
        ]
    }
}

VmfsDatastoreCreateSpec

spec

Required

This data object type is used when creating a new VMFS datastore, to create a specification for the VMFS datastore.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The newly created datastore.

Returns MoRefDatastore of type(s) application/json

This response body class contains all of the following: MoRefManagedEntity

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

500

DuplicateName: if a datastore with the same name already exists.

InvalidArgument: if the datastore name is invalid, or the spec is invalid.

NotSupported: if the host is not an ESX Server system.

HostConfigFault: if unable to format the VMFS volume or gather information about the created volume.

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

POST

Host Datastore System Configure Datastore Principal