CreateDiskFromSnapshotRequestType

CreateDiskFromSnapshotRequestType
CreateDiskFromSnapshotRequestType

The parameters of CreateDiskFromSnapshot_Task.

JSON Example
{
    "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",
    "isLinkedClone": false,
    "targetId": {
        "_typeName": "string",
        "id": "string"
    },
    "targetDatastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
id
Required

The ID of the virtual storage object.

datastore
Required

The datastore where the source virtual storage object is located.

snapshotId
Required

The ID of the snapshot of the virtual storage object.

string
name
Required

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

profile
Optional

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

crypto
Optional

Crypto information of the new disk. If unset and if profile contains an encryption iofilter and if snapshto is unencrypted, then crypto will be of type CryptoSpecEncrypt, and filled with keyId that is automatically generated and keyProviderId that is the default kms cluster. If unset and if profile is a default policy and if snapshot is unenrypted, then crypto is treated as CryptoSpecNoOp. If unset and if profile contains an encryption iofilter and if snapshot is encrypted, then crypto is treated as CryptoSpecNoOp. If unset and if profile is a default policy and if snapshot is encrypted, then crypto is treated as CryptoSpecDecrypt. To recrypt the disk during creating disk, crypto has to be present.

string
path
Optional

Relative location where disk has to be created, used in targetDatastore and datastore parameters. If not specified disk gets created at default VStorageObject location of targetDatastore or datastore.

boolean
isLinkedClone
Optional

Indicates whether a linkedClone Disk needs to be created from the snapshot.

Since: vSphere API Release 9.1.0.0

targetId
Optional

The ID of the target virtual storage object. For each new request, the ID should be a unique ID complying to RFC4122V4 (generated randomly). For retry requests with the same ID, all the other input parameters are expected to remain same. If not specified, a system generated ID will be assigned to the newly created virtual storage object.

Since: vSphere API Release 9.1.0.0

targetDatastore
Optional

The target datastore where the new disk needs to be created. if not specified, the new disk will be created where the source virtual storage object is located.

Since: vSphere API Release 9.1.0.0