Connect-CisServer

Syntax

• Credential
• Default
• Manual
• SamlSecurityContext
• SessionSecret

Connect-CisServer

-Credential  <PSCredential>
-Server  <String[]>
[-Force]
[-NotDefault]
[-Port  <Int32>]
[-SaveCredentials]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Credential	PSCredential	named		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".
required	Server	String[]	named		Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to.
optional	Force	SwitchParameter	named		Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'.
optional	NotDefault	SwitchParameter	named		Specifies that you do not want to save the specified servers as default servers.
optional	Port	Int32	named		Specifies the port on the server you want to use for the connection.
optional	SaveCredentials	SwitchParameter	named		Indicates that you want to save the specified credentials in the local credential store.

Connect-CisServer

-Server  <String[]>
[-Force]
[-NotDefault]
[-Password  <SecureString>]
[-Port  <Int32>]
[-SaveCredentials]
[-User  <String>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Server	String[]	named		Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to.
optional	Force	SwitchParameter	named		Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'.
optional	NotDefault	SwitchParameter	named		Specifies that you do not want to save the specified servers as default servers.
optional	Password	SecureString	named		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".
optional	Port	Int32	named		Specifies the port on the server you want to use for the connection.
optional	SaveCredentials	SwitchParameter	named		Indicates that you want to save the specified credentials in the local credential store.
optional	User	String	named		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".

Connect-CisServer

-Menu
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Menu	SwitchParameter	named		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.

Connect-CisServer

-SamlSecurityContext  <SamlSecurityContext>
-Server  <String[]>
[-Force]
[-NotDefault]
[-Port  <Int32>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	SamlSecurityContext	SamlSecurityContext	named	pipeline	Specifies the SAML2 security context for the vCenter Server system. For more information about security contexts, see the about_security_context (about_security_context.html)article.
required	Server	String[]	named		Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to.
optional	Force	SwitchParameter	named		Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'.
optional	NotDefault	SwitchParameter	named		Specifies that you do not want to save the specified servers as default servers.
optional	Port	Int32	named		Specifies the port on the server you want to use for the connection.

Connect-CisServer

-Server  <String[]>
-SessionSecret  <String>
[-Force]
[-NotDefault]
[-Port  <Int32>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Server	String[]	named		Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to.
required	SessionSecret	String	named		Specifies the ID of an existing vSphere Automation SDK session you want to reestablish.
optional	Force	SwitchParameter	named		Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'.
optional	NotDefault	SwitchParameter	named		Specifies that you do not want to save the specified servers as default servers.
optional	Port	Int32	named		Specifies the port on the server you want to use for the connection.

Output

Examples

---

Example 1

Connect-CisServer -Server $serverAddress -User $user -Password $pass

Connects to a vSphere Automation SDK server by using the User and Password parameters.

Example 2

$credential = Get-Credential

Connect-CisServer -Server $serverAddress -Credential $credential

Connects to a vSphere Automation SDK server by using the Credential parameter.

Example 3

$serverConnection = Connect-CisServer -Server $serverAddress -User $user -Password $pass

Connect-CisServer -Server $serverAddress -SessionSecret $serverConnection.SessionSecret

Connects to a vSphere Automation SDK server by using the SessionSecret parameter.

Example 4

Connect-CisServer -Server $serverAddress -Credential -User $user -Password $pass -SaveCredential

Connects to a vSphere Automation SDK server and stores the credentials in the credential store.

Example 5

Connect-CisServer -Server $serverAddress -User $user

Connects to a vSphere Automation SDK server when a record for the specified user is available in the credential store.

Example 6

$oauthCtx = New-VcsOAuthSecurityContext -ApiToken "a3f35067-80b5-44f0-a0bc-e19f2bc17fb7"

$samlCtx = New-VISamlSecurityContext -VCenterServer $serverAddress -OAuthSecurityContext $oauthCtx

Connect-CisServer -Server $serverAddress -SamlSecurityContext $samlCtx

Connects to a vSphere Automation SDK server that runs in a VMware managed cloud using an API token from the VMware Cloud Services portal.

Related Commands