Snapservice. Clusters. Virtual Machines Revert$ Task

Revert the virtual machine to a given snapshot point. The system takes an additional snapshot to preserve the state prior to performing a revert. The system snapshot does not preserve the in-memory state of the virtual machine. The virtual machine will be left in a powered off state after the revert operation.

This operation was added in vSphere API 8.0.3.0.

Returns an authorization error if you do not have all of the privileges described as follows:

The resource ClusterComputeResource referenced by the parameter cluster requires Host.Config.Storage.
The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.State.RevertToSnapshot and VirtualMachine.Interact.PowerOff.

Request

URI

POST

https://{host}/api/snapservice/clusters/{cluster}/virtual-machines/{vm}?action=revert&vmw-task=true

COPY

Path Parameters

string

cluster

Required

Identifier of the Cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

string

Required

Identifier of the virtual machine.

The parameter must be an identifier for the resource type: VirtualMachine.

Request Body

specification for the revert operation.

Snapservice.Clusters.VirtualMachines.RevertSpec of type(s) application/json

Required

"Snapservice.Clusters.VirtualMachines.RevertSpec Object"

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

202

Success!

Returns string of type(s) application/json

Operation doesn't return any data structure

400

Vapi.Std.Errors.InvalidArgument If validation of the spec fails.

Vapi.Std.Errors.NotAllowedInCurrentState If the virtual machine has moved to another cluster or if there are more than max allowed revert operations in-progress.

Returns Vapi.Std.Errors.Error of type(s) application/json

"Vapi.Std.Errors.Error Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json

"Vapi.Std.Errors.Unauthenticated Object"

403

If the caller is not authorized to perform the operation.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json

"Vapi.Std.Errors.Unauthorized Object"

404

If there is no cluster associated with cluster or no virtual machine associated with vm is found in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json

"Vapi.Std.Errors.NotFound Object"

500

If there is unknown internal error.

Returns Vapi.Std.Errors.Error of type(s) application/json

"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json

"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/snapservice/clusters/{cluster}/virtual-machines/{vm}?action=revert&vmw-task=true

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Snapservice.clusters.virtual Machines Operations

GET

Snapservice. Clusters. Virtual Machines List