Host V Storage Object Manager Host Register Disk

Host V Storage Object Manager Host 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}/HostVStorageObjectManager/{moId}/HostRegisterDisk
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 HostVStorageObjectManager/{moId}.

string
release
Required

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

Request Body
HostRegisterDiskRequestType of type(s) application/json
Required 
{
    "path": "string",
    "name": "string",
    "modifyControlFlags": false
}
string
path
Required

URL or datastore 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

boolean
modifyControlFlags
Optional

Optional Parameter describing if the control Flags should be changed to default values

Since: vSphere API Release 8.0.2.0

Authentication
This operation uses the following authentication methods.
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": {
        "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
Host Vstorage Object Manager Operations
POST
Host V Storage Object Manager Host Clear V Storage Object Control Flags
POST
Host V Storage Object Manager Host Clone V Storage Object Task
POST
Host V Storage Object Manager Host Create Disk Task
POST
Host V Storage Object Manager Host Delete V Storage Object Task
POST
Host V Storage Object Manager Host Delete V Storage Object Ex Task
POST
Host V Storage Object Manager Host Extend Disk Task
POST
Host V Storage Object Manager Host Inflate Disk Task
POST
Host V Storage Object Manager Host List V Storage Object
POST
Host V Storage Object Manager Host Reconcile Datastore Inventory Task
POST
Host V Storage Object Manager Host Register Disk
POST
Host V Storage Object Manager Host Relocate V Storage Object Task
POST
Host V Storage Object Manager Host Rename V Storage Object
POST
Host V Storage Object Manager Host Retrieve V Storage Infrastructure Object Policy
POST
Host V Storage Object Manager Host Retrieve V Storage Object
POST
Host V Storage Object Manager Host Retrieve V Storage Object Metadata
POST
Host V Storage Object Manager Host Retrieve V Storage Object Metadata Value
POST
Host V Storage Object Manager Host Retrieve V Storage Object State
POST
Host V Storage Object Manager Host Schedule Reconcile Datastore Inventory
POST
Host V Storage Object Manager Host Set V Storage Object Control Flags
POST
Host V Storage Object Manager Host Update V Storage Object Metadata Task
POST
Host V Storage Object Manager Host Update V Storage Object Metadata Ex Task
POST
Host V Storage Object Manager Host V Storage Object Create Disk From Snapshot Task
POST
Host V Storage Object Manager Host V Storage Object Create Snapshot Task
POST
Host V Storage Object Manager Host V Storage Object Delete Snapshot Task
POST
Host V Storage Object Manager Host V Storage Object Retrieve Snapshot Info
POST
Host V Storage Object Manager Host V Storage Object Revert Task
POST
Host V Storage Object Manager Rename V Storage Object Ex
POST
Host V Storage Object Manager Revert V Storage Object Ex Task
POST
Host V Storage Object Manager V Storage Object Create Snapshot Ex Task
POST
Host V Storage Object Manager V Storage Object Delete Snapshot Ex Task
POST
Host V Storage Object Manager V Storage Object Extend Disk Ex Task