Virtual Machine Disable Secondary VM Task
Disables the specified secondary virtual machine in this fault tolerant group.
The specified secondary will not be automatically started on a subsequent power-on of the primary virtual machine. This operation could leave the primary virtual machine in a non-fault tolerant state.
Required privileges: VirtualMachine.Interact.DisableSecondary
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.
"DisableSecondaryVMRequestType Object"
The secondary virtual machine specified will be disabed. This field must specify a secondary 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.
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}/DisableSecondaryVM_Task