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

Creates a snapshot of a given VStorageObject.

Requires Datastore.FileManagement privilege.

Since: vSphere API Release 8.0.2.0

Required privileges: System.View

Request

URI

POST

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

string

release

Required

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

Request Body

VStorageObjectCreateSnapshotExRequestType of type(s) application/json

Required

Show optional properties

{
    "id": {},
    "datastore": {},
    "description": "string"
}

{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "description": "string",
    "snapshotId": {
        "_typeName": "string",
        "id": "string"
    }
}

Required

The ID of the virtual storage object.

datastore

Required

The datastore where the source virtual storage object is located.

string

description

Required

A short description to be associated with the snapshot.

snapshotId

Optional

The ID of the snapshot of the 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 random system generated snapshot ID will be assigned to the snapshot.

Since: vSphere API Release 9.1.0.0

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"id":"{}","datastore":"{}","description":"string"}' https://{api_host}/sdk/vim25/{release}/VcenterVStorageObjectManager/{moId}/VStorageObjectCreateSnapshotEx_Task

Availability

Added in vSphere API Release 8.0.2.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations