Virtual Machine Make Primary VM Task
Makes the specified secondary virtual machine from this fault tolerant group as the primary virtual machine.
Required privileges: VirtualMachine.Interact.MakePrimary
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.
{
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}