Virtual Machine Snapshot Export Snapshot

Obtains an export lease on this snapshot.

The export lease contains a list of URLs for the virtual disks for this snapshot, as well as a ticket giving access to the URLs.

See HttpNfcLease for information on how to use the lease.

Required privileges: VApp.Export

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachineSnapshot/{moId}/ExportSnapshot

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 VirtualMachineSnapshot/{moId}.

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The export lease on this VirtualMachineSnapshot. The export task continues running until the lease is completed by the caller.

Returns MoRefHttpNfcLease of type(s) application/json

This response body class contains all of the following: ManagedObjectReference

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

TaskInProgress: if the virtual machine is busy.

InvalidState: if the operation cannot be performed because of the virtual machine's current state. For example, if the virtual machine configuration information is not available.

FileFault: if there is an error accessing the virtual machine files.

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

Authentication

Response

200 Response Body

Errors

Virtual Machine Snapshot Operations

POST

Virtual Machine Snapshot Export Snapshot

GET