Vcenter V Storage Object Manager Create Disk Task

Create a virtual disk, which is a storage object with *disk* as consumption type.

Create a virtual disk, which is a storage object with disk as consumption type.

Requires Datastore.FileManagement privilege on the datastore where the virtual disk object is created.

Required privileges: System.View

Request

URI

POST

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

string

release

Required

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

Request Body

CreateDiskRequestType of type(s) application/json

Required

Show optional properties

{
    "spec": {}
}

{
    "spec": {
        "_typeName": "string",
        "id": {
            "_typeName": "string",
            "id": "string"
        },
        "name": "string",
        "keepAfterDeleteVm": false,
        "backingSpec": {
            "_typeName": "string",
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "path": "string"
        },
        "capacityInMB": 0,
        "profile": [
            {
                "_typeName": "string"
            }
        ],
        "crypto": {
            "_typeName": "string"
        },
        "metadata": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ]
    }
}

spec

Required

The specification of the virtual storage object to be created.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor monitor the operation. The info.result property in the Task contains the newly created VStorageObject upon success.

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 when creating 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 '{"spec":"{}"}' https://{api_host}/sdk/vim25/{release}/VcenterVStorageObjectManager/{moId}/CreateDisk_Task

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations