Vcenter V Storage Object Manager Register Disk

Vcenter V Storage Object Manager Register Disk

Promote a virtual disk to a First Class Disk.

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

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VcenterVStorageObjectManager/{moId}/RegisterDisk

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 8.0.2.0 APIs.

Request Body

RegisterDiskRequestType of type(s) application/json

Required

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

VStorageObjectConfigInfo

config

Required

Data object specifies 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.

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

Request

Path Parameters

200 Response Body

Errors

Vcenter Vstorage Object Manager Operations

Vcenter V Storage Object Manager Attach Tag To V Storage Object

Vcenter V Storage Object Manager Clear V Storage Object Control Flags

Vcenter V Storage Object Manager Clone V Storage Object Task

Vcenter V Storage Object Manager Create Disk Task

Vcenter V Storage Object Manager Create Disk From Snapshot Task

Vcenter V Storage Object Manager Delete Snapshot Task

Vcenter V Storage Object Manager Delete V Storage Object Task

Vcenter V Storage Object Manager Delete V Storage Object Ex Task

Vcenter V Storage Object Manager Detach Tag From V Storage Object

Vcenter V Storage Object Manager Extend Disk Task

Vcenter V Storage Object Manager Inflate Disk Task

Vcenter V Storage Object Manager List Tags Attached To V Storage Object

Vcenter V Storage Object Manager List V Storage Object

Vcenter V Storage Object Manager List V Storage Objects Attached To Tag

Vcenter V Storage Object Manager Reconcile Datastore Inventory Task

Vcenter V Storage Object Manager Register Disk

Vcenter V Storage Object Manager Relocate V Storage Object Task

Vcenter V Storage Object Manager Rename V Storage Object

Vcenter V Storage Object Manager Rename V Storage Object Ex

Vcenter V Storage Object Manager Retrieve Snapshot Details

Vcenter V Storage Object Manager Retrieve Snapshot Info

Vcenter V Storage Object Manager Retrieve V Storage Infrastructure Object Policy

Vcenter V Storage Object Manager Retrieve V Storage Object

Vcenter V Storage Object Manager Retrieve V Storage Object Associations

Vcenter V Storage Object Manager Retrieve V Storage Object State

Vcenter V Storage Object Manager Revert V Storage Object Task

Vcenter V Storage Object Manager Revert V Storage Object Ex Task

Vcenter V Storage Object Manager Schedule Reconcile Datastore Inventory

Vcenter V Storage Object Manager Set V Storage Object Control Flags

Vcenter V Storage Object Manager Update V Storage Infrastructure Object Policy Task

Vcenter V Storage Object Manager Update V Storage Object Crypto Task

Vcenter V Storage Object Manager Update V Storage Object Policy Task

Vcenter V Storage Object Manager V Center Update V Storage Object Metadata Ex Task

Vcenter V Storage Object Manager V Storage Object Create Snapshot Task

Vcenter V Storage Object Manager V Storage Object Create Snapshot Ex Task

Vcenter V Storage Object Manager V Storage Object Delete Snapshot Ex Task

Vcenter V Storage Object Manager V Storage Object Extend Disk Ex Task

Vcenter V Storage Object Manager Vstorage Object V Center Query Changed Disk Areas