Host V Storage Object Manager Host V Storage Object Create Disk From Snapshot Task

Creates a new Disk from given snapshot of a VStorageObject.

Required privileges: System.View

Request

URI

POST

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

string

release

Required

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

Request Body

HostVStorageObjectCreateDiskFromSnapshotRequestType of type(s) application/json

Required

Show optional properties

{
    "id": {
        "id": "string"
    },
    "datastore": {},
    "snapshotId": {
        "id": "string"
    },
    "name": "string"
}

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "snapshotId": {
        "_typeName": "string",
        "id": "string"
    },
    "name": "string",
    "profile": [
        {
            "_typeName": "string"
        }
    ],
    "crypto": {
        "_typeName": "string"
    },
    "path": "string",
    "provisioningType": "string"
}

Required

This data object type describes an identifier class which is globally unique to identify the associated object.

MoRefDatastore

datastore

Required

Reference to an instance of the Datastore managed object.

snapshotId

Required

This data object type describes an identifier class which is globally unique to identify the associated object.

string

name

Required

A user friendly name to be associated with the new disk.

array of VirtualMachineProfileSpec

profile

Optional

SPBM Profile requirement on the new virtual storage object. If not specified datastore default policy would be assigned.

CryptoSpec

crypto

Optional

This data object type encapsulates virtual machine or disk encryption settings.

string

path

Optional

Relative location in the specified datastore where disk needs to be created. If not specified disk gets created at defualt VStorageObject location on the specified datastore.

string

provisioningType

Optional

Provisioining type of the disk as specified in above mentioned profile. The list of supported values can be found in BaseConfigInfoDiskFileBackingInfoProvisioningTypeEnum

Since: vSphere API Release 8.0.0.1

Authentication

This operation uses the following authentication methods.

Session

Responses

200

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 while snapshotting the virtual storage object.

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

InvalidState: If the operation cannot be performed on the disk.

NotFound: If specified virtual storage object cannot be found.

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

Virtual Infrastructure Operations