Virtual Machine Start Recording Task
Deprecated as of vsphere API 5.1.
Initiates a recording session on this virtual machine.
As a side effect, this operation creates a snapshot on the virtual machine, which in turn becomes the current snapshot.
This is an experimental interface that is not intended for use in production code.
Required privileges: VirtualMachine.Interact.Record
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}.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
"StartRecordingRequestType Object"The name for the snapshot associated with this recording. The name need not be unique for this virtual machine.
A description for the snapshot associated with this recording. If omitted, a default description may be provided.
This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the newly created VirtualMachineSnapshot associated with the recording on success.
"MoRefTask Object"TaskInProgress: if the virtual machine is busy.
NotSupported: if the host product does not support record functionality or if the virtual machine does not support this
VmConfigIncompatibleForRecordReplay: if the virtual machine configuration is incompatible for recording.
SnapshotFault: if an error occurs during the snapshot operation. Typically, a more specific fault like MultipleSnapshotsNotSupported is thrown.
InvalidName: if the specified snapshot name is invalid.
FileFault: if there is a problem with creating or accessing one or more files needed for this operation.
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.
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.
"VimFault Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/VirtualMachine/{moId}/StartRecording_Task