PowerCLI Reference

Disconnect-PIServer

Synopsis

This cmdlet closes the connection to a vCloud Air server.

Syntax

Disconnect-PIServer [[-Server] <PIServer[]>] [-User <String[]>] [-Force] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Connect-PIServer

Detailed Description

This cmdlet closes the connection to the vCloud Air servers specified by the -Server and -User parameters.

When no servers and no user name are specified, and if there is only one connected server in $DefaultPIServers variable, this server is disconnected. If there is no connected server, the cmdlet throws a terminating error.
When no servers are specified and a user name is specified, the cmdlet tries to find a connection to the vCloud Air server with this user name and if found, disconnects it. If no such connection is found, the cmdlet throws a terminating error.

This functionality is using the reference counting mechanism. For more information about the mechanism, see Connect-PIServer.

When there are no more active connections to the server it gets disconnected and then it is removed from the $DefaultPIServers variable. For more information about this variable, see Connect-PIServer.

If -Force is specified, the server is disconnected even if there is more than one connection to it.

Parameters

Name	Type	Description	Required?	Pipeline Input
Server	PIServer[]	Specifies the vCloud Air servers you want to disconnect from.	false	true (ByValue)
Confirm	SwitchParameter	If 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.	false	false
Force	SwitchParameter	Specifies that you want to remove all existing connections to the specified servers.	false	false
InformationAction	ActionPreference		false	false
InformationVariable	String		false	false
PipelineVariable	String		false	false
User	String[]	Specifies the user you want to disconnect from vCloud Air servers.	false	false
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Return Type

None

Notes

Examples

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

$myConnection = Connect-PIServer -User '[email protected]' -Password 'user_password'
Disconnect-PIServer $myConnection -Confirm:$false

Disconnects the specified vCloud Air connection without asking for confirmation.