Virtual Machine Drop Connections
Force the virtual machine to drop the specified connections.
Attempt to drop the specified virtual machine connections. An attempt will be made to drop all of the specified connections before returning.
Since: vSphere API Release 7.0.1.0
Required privileges: VirtualMachine.Interact.ConsoleInteract
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.
{
"listOfConnections": [
{
"_typeName": "string",
"label": "string",
"client": "string",
"userName": "string"
}
]
}
true All of the specified connections have been dropped.
InvalidPowerState: If the virtual machine is not powered on. No connection drop actions will have been attempted if this is thrown.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}