Virtual Machine Stop Recording Task
Deprecated as of vsphere API 5.1.
Stops a currently active recording session on this virtual machine.
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.3.0 APIs.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
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.
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.
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 does not have an active recording session.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}