Connect-VIServer

This cmdlet establishes a connection to a vCenter system. The cmdlet starts a new session or re-establishes a previous session with a vCenter system using the specified parameters.When you attempt to connect to a server, the server checks for valid certificates. To set the default behavior of VCF PowerCLI when no valid certificates are recognized, use the InvalidCertificateAction parameter of the Set-PowerCLIConfiguration cmdlet. For more information about invalid certificates, run 'Get-Help about_invalid_certificates'.You can have more than one connection to the same server. To disconnect from a server, you need to close all active connections to this server. VCF PowerCLI supports working with multiple default servers. If you select this option, every time when you connect to a different server by using the Connect-VIServer cmdlet, the new server connection is stored in an array variable together with the previously connected servers, unless the NotDefault parameter is set. This variable is named $DefaultVIServers and its initial value is an empty array. When you run a cmdlet and the target servers cannot be determined from the specified parameters, the cmdlet runs against all servers stored in the array variable. To remove a server from the $DefaultVIServers variable, you can either use the Disconnect-Server cmdlet to close all active connections to the server, or modify the value of $DefaultVIServers manually.If you choose to work with a single default server, when you run a cmdlet and the target servers cannot be determined from the specified parameters, the cmdlet runs against the last connected server. This server is stored in the $defaultVIServer variable, which is updated every time you establish a new connection.To switch between single and multiple default servers working mode, use the DefaultServerMode parameter of the Set-PowerCLIConfiguration cmdlet. Working with multiple default servers will be enabled by default in a future release.

Syntax

Output

Examples

Example 1

Connect-VIServer -Server 10.23.112.235 -Protocol https -User admin -Password pass

Connects to a vCenter system by using the User and Password parameters.

Example 2

Connect-VIServer Server -Credential $myCredentialsObject -Port 1234

Connects to a vCenter system by using a credential object.

Example 3

Connect-VIServer Server

Connects by using integrated authentication. In this case, the credentials you are logged on to your machine must be the same as those for the server.

Example 4

Connect-VIServer "Server" -User user -Password pass -SaveCredentials

Connects to a server and save the credentials in the credential store. After the credentials are stored, you can connect to the server without specifying them. To get a previously saved credential store item, use the Get-VICredentialStoreItem cmdlet.

Example 5

Connect-VIServer -Menu

Connects to a server by choosing the server address from a list of previously connected servers.

Example 6

Connect-VIServer "Server" -AllLinked

Connects to a vCenter system which is a part of a federation vCenter system. This will connect you to all vCenter systems in the federation as well.

Example 7

$oauthCtx = New-VcsOAuthSecurityContext -ApiToken "a3f35067-80b5-44f0-a0bc-e19f2bc17fb7"
$samlCtx = New-VISamlSecurityContext -VCenterServer "Server" -OAuthSecurityContext $oauthCtx
Connect-VIServer -Server "Server" -SamlSecurityContext $samlCtx

Connects to a vCenter system that runs in a VMware managed cloud using an API token from the VMware Cloud Services portal.

Example 8

$oauthCtx = New-VcfOAuthSecurityContext "Server" -ApiToken "a3f35067-80b5-44f0-a0bc-e19f2bc17fb7"
Connect-VIServer -Server "Server" -VcfOAuthSecurityContext $oauthCtx

Connects to a vCenter system which is federated with VCF SSO.

Example 9

Connect-VIServer -Server "Server" -VcfApiToken "a3f35067-80b5-44f0-a0bc-e19f2bc17fb7"

Connects to a vCenter system which is federated with VCF SSO.

Related Commands

VIServer

This cmdlet establishes a connection to a vCenter system.

This cmdlet closes the connection to a vCenter Server system.