Virtual Machine Revert To Current Snapshot Task

Reverts the virtual machine to the current snapshot.

This is equivalent to doing snapshot.currentSnapshot.revert.

If no snapshot exists, then the operation does nothing, and the virtual machine state remains unchanged.

Required privileges: VirtualMachine.State.RevertToSnapshot

Request

URI

POST

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

string

release

Required

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

Request Body

RevertToCurrentSnapshotRequestType of type(s) application/json

Required

{
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "suppressPowerOn": false
}

MoRefHostSystem

host

Optional

Reference to an instance of the HostSystem managed object.

boolean

suppressPowerOn

Optional

(optional) If set to true, the virtual machine will not be powered on regardless of the power state when the current snapshot was created. Default to false.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

TaskInProgress: if the virtual machine is busy.

NotSupported: if the host product does not support snapshots.

InsufficientResourcesFault: if this operation would violate a resource usage policy.

SnapshotFault: if an error occurs during the snapshot operation. Typically, a more specific fault like InvalidSnapshotFormat is thrown.

InvalidPowerState: if the operation cannot be performed in the current power state of the virtual machine.

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 or if an OVF consumer is blocking the operation.

VmConfigFault: if a configuration issue prevents the power-on. Typically, a more specific fault, such as UnsupportedVmxLocation, is thrown.

FileFault: if there is a problem accessing the virtual machine on the filesystem.

NotFound: if the virtual machine does not have a current snapshot.

DisallowedOperationOnFailoverHost: if the virtual machine is being reverted to a powered on state and the host specified is a failover host. See ClusterFailoverHostAdmissionControlPolicy.

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 Machine Operations