vSphere PowerCLI Reference

Disconnect-VIServer

Synopsis

Disconnects from a vSphere server.

Syntax

Disconnect-VIServer [[-Server] <VIServer[]>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Connect-VIServer

Detailed Description

Disconnects from a vSphere server. In PowerCLI, you can have multiple connections to a server. In order to disconnect from a server, you must close all active connections to it. By default, Disconnect-VIServer closes only the last connection to the specified server. To close all active connections to a server, use the -Force parameter or run the cmdlet for each connection. When a server is disconnected, it is removed from the default servers list. For more information about default servers, see the description of Connect-VIServer.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
ServerVIServer[]Specify the vSphere servers you want to disconnect from.falsetrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse$true
ForceSwitchParameterIndicate that you want to close all active connections to the specified server and disconnect from it. If the value is $false, the cmdlet closes only the last connection to the specified server and you must run Disconnect-VIServer for each active connection to this server in order to disconnect from it.falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

None

Notes

Examples

-------------- Example 1 --------------

$Server = Connect-VIServer 10.23.112.235   Disconnect-VIServer -Server $Server

Connects to a server with an IP address 10.23.112.235 and saves the returned VIServer object in the $Server variable. Then disconnects from the specified server.

-------------- Example 2 --------------

Disconnect-VIServer -Server $global:DefaultVIServers -Force

Closes all connections to the default servers.

-------------- Example 3 --------------

Disconnect-VIServer -Server * -Force

Disconnects all server connections.


Copyright © 1998 - 2011 VMware, Inc. All rights reserved.