Name | Type | Description | Required? | Pipeline Input | Default Value |
---|
Server | String[] | Specifies the IP address or the DNS name of the vSphere server to which you want to connect. You can also specify a server by providing its IPv6 address enclosed in square brackets, for example [fe80::250:56ff:feb0:74bd%4]. | true | false |
AllLinked | SwitchParameter | Indicates whether you want to connect to vCenter Server in linked mode. If you specify $true for the AllLinked parameter and the server to which you want to connect is a part of a federation vCenter Server, you'll be connected to all members of the linked vCenter Server.
To use this option, PowerCLI must be configured to work in multiple servers connection mode. To configure PowerCLI to support multiple servers connection, specify Multiple for the DefaultVIServerMode parameter of the Set-PowerCLI Configuration cmdlet. | false | false |
Credential | PSCredential | Specifies a PSCredential object that contains credentials for authenticating with the server. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication". Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release. | false | true (ByValue) |
Force | SwitchParameter | Suppresses all user interface prompts during the cmdlet execution. Currently these include 'Multiple default servers' and 'Invalid certificate action'. | false | false |
Menu | SwitchParameter | Indicates that you want to select a connection server from a list of recently connected servers. If Menu is set to $true, the cmdlet retrieves a list of the last visited servers and enters a nested command prompt, so that you can select a server from the list. | true | false |
NotDefault | SwitchParameter | Indicates that you do not want to include the server to which you connect into the $defaultVIServers variable. | false | false |
Password | String | Specifies the password you want to use for authenticating with the server. If the Credential parameter is also specified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication".
Note: If the password contains special characters, enclose the entire string in single quotes ('). | false | false |
Port | Int32 | Specifies the port on the server you want to use for the connection. | false | false |
Protocol | String | Specifies the Internet protocol you want to use for the connection. It can be either http or https. | false | false |
SaveCredentials | SwitchParameter | Indicates that you want to save the specified credentials in the local credential store.
Note: This parameter is not supported on the Core edition of PowerShell. | false | false |
Session | String | Specifies the ID of an existing vCenter Server session you want to reestablish. | false | false |
User | String | Specifies the user name you want to use for authenticating with the server. If the Credential parameter is also specified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, run "help about_server_authentication". Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release.
Note: If the user name contains special characters, enclose the entire string in single quotes ('). | false | true (ByValue) |
-------------- Example 1 --------------
Connect-VIServer -Server 10.23.112.235 -Protocol https -User admin -Password pass
Connects to a vSphere server using the User and Password parameters.
-------------- Example 2 --------------
Connect-VIServer Server -Credential $myCredentialsObject -Port 1234
Connects to a vSphere server by using a credential object.
-------------- Example 3 --------------
Connect-VIServer "Server" -SessionId $sessionId
Connect by using a server session ID.
Once you connect to a server, you can save the session ID - $serverObject.SessionId, so that you can restore the existing server connection instead of reconnecting.
-------------- Example 4 --------------
Connect-VIServer Server
Connect 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 5 --------------
Connect-VIServer "Server" -User user -Password pass -SaveCredentials
Connect 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 6 --------------
Connect-VIServer -Menu
Connect to a server by choosing the server address from a list of previously connected servers.
-------------- Example 7 --------------
Connect-VIServer "Server" -AllLinked
Connect to a vSphere server which is a part of a federation vCenter Server. This will Connect you to all vSphere servers in the federation as well.