Virtual Machine Start Replaying Task

Deprecated as of vsphere API 5.1.

Starts a replay session on this virtual machine.

As a side effect, this operation updates the current snapshot of the virtual machine.

This is an experimental interface that is not intended for use in production code.

Required privileges: VirtualMachine.Interact.Replay

Request

URI

POST

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

StartReplayingRequestType of type(s) application/json

Required

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

MoRefVirtualMachineSnapshot

replaySnapshot

Required

Reference to an instance of the VirtualMachineSnapshot managed object.

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 record/replay functionality or if the virtual machine does not support this capability.

InvalidArgument: if replaySnapshot is not a valid snapshot associated with a recorded session on this virtual machine.

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

FileFault: if there is a problem with creating or accessing one or more files needed for this operation.

VmConfigIncompatibleForRecordReplay: if the virtual machine configuration is incompatible for replaying.

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, the virtual machine configuration information is not available.

NotFound: if replaySnapshot is no longer present.

RecordReplayDisabled: if the record/replay config flag has not been enabled for this virtual machine.

HostIncompatibleForRecordReplay: if the virtual machine is located on a host that does not support record/replay.

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