VStorage Object Manager Base V Storage Object Delete Snapshot Ex Task

VStorage Object Manager Base V Storage Object Delete Snapshot Ex Task

Deletes a given snapshot of a 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}/VStorageObjectManagerBase/{moId}/VStorageObjectDeleteSnapshotEx_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 VStorageObjectManagerBase/{moId}.

string
release
Required

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

Request Body
VStorageObjectDeleteSnapshotExRequestType of type(s) application/json
Required

Show optional properties

{
    "id": {
        "id": "string"
    },
    "datastore": {},
    "snapshotId": {
        "id": "string"
    }
}
{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "snapshotId": {
        "_typeName": "string",
        "id": "string"
    }
}
ID
id
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.

ID
snapshotId
Required

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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

Availability
Added in vSphere API Release 8.0.2.0
On This Page
Virtual Infrastructure Operations
POST
VStorage Object Manager Base Rename V Storage Object Ex
POST
VStorage Object Manager Base Revert V Storage Object Ex Task
POST
VStorage Object Manager Base V Storage Object Create Snapshot Ex Task
POST
VStorage Object Manager Base V Storage Object Delete Snapshot Ex Task
POST
VStorage Object Manager Base V Storage Object Extend Disk Ex Task