Vslm V Storage Object Manager Vslm Register Disk

Promote a virtual disk to a First Class Disk.

Requires Datastore.FileManagement privilege on the datastore where the virtual disk resides.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vslm/VslmVStorageObjectManager/{moId}/VslmRegisterDisk

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

string

release

Required

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

Request Body

VslmRegisterDiskRequestType of type(s) application/json

Required

Show optional properties

{
    "path": "string"
}

{
    "path": "string",
    "name": "string"
}

string

path

Required

URL path to the virtual disk.

string

name

Optional

The descriptive name of the disk object. If unset the name will be automatically determined from the path. @see vim.vslm.BaseConfigInfo.name

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The registered virtual storage object for the disk.

Returns VStorageObject of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "config": {
        "_typeName": "string",
        "id": {
            "_typeName": "string",
            "id": "string"
        },
        "name": "string",
        "createTime": "string",
        "keepAfterDeleteVm": false,
        "relocationDisabled": false,
        "nativeSnapshotSupported": false,
        "changedBlockTrackingEnabled": false,
        "backing": {
            "_typeName": "string",
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "metadata": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ],
        "vclock": {
            "_typeName": "string",
            "vClockTime": 0
        },
        "iofilter": [
            "string"
        ],
        "descriptorVersion": 0,
        "capacityInMB": 0,
        "consumptionType": [
            "string"
        ],
        "consumerId": [
            {
                "_typeName": "string",
                "id": "string"
            }
        ],
        "virtualDiskFormat": "string",
        "linkedCloneBasePath": "string",
        "linkedCloneParentId": {
            "_typeName": "string",
            "id": "string"
        }
    }
}

config

Required

Virtual storage object configuration

500

FileFault: If an error occurs while registering the virtual disk.

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

AlreadyExists: If disk is already registered as a virtual storage object.

VslmSyncFault: If an error occurs during datastore synchronization, implies the registerDisk completed successfully, however, there was an exception during datastore synchronization.

VslmFault: If a VSLM internal server error occurred.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_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"
        }
    ]
}

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"path":"string"}' https://{api_host}/sdk/vim25/{release}/vslm/VslmVStorageObjectManager/{moId}/VslmRegisterDisk

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Lifecycle Management Operations