Virtual Machine Terminate Fault Tolerant VM Task
Terminates the specified secondary virtual machine in a fault tolerant group.
This can be used to test fault tolerance on a given virtual machine, and should be used with care.
Required privileges: VirtualMachine.Interact.TerminateFaultTolerantVM
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 9.0.0.0 APIs.
"TerminateFaultTolerantVMRequestType Object"The secondary virtual machine specified will be terminated, allowing fault tolerance to activate. If no virtual machine is specified, all secondary virtual machines will be terminated. If vm is a primary, InvalidArgument exception is thrown. This field must specify a virtual machine that is part of the fault tolerant group that this virtual machine is currently associated with. It can only be invoked from the primary virtual machine in the group. If the primary virtual machine is terminated, an available secondary virtual machine will be promoted to primary. If no secondary exists, an exception will be thrown and the primary virtual machine will not be terminated. If a secondary virtual machine is terminated, it may be respawned on a potentially different host.
This method returns a Task object with which to monitor the operation.
"MoRefTask Object"VmFaultToleranceIssue: if any error is encountered with the fault tolerance configuration of the virtual machine. Typically, a more specific fault like InvalidOperationOnSecondaryVm is thrown.
TaskInProgress: if the virtual machine is busy.
InvalidState: if the host is in maintenance mode or if the virtual machine's configuration information is not available.
"VimFault Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/VirtualMachine/{moId}/TerminateFaultTolerantVM_Task