Connect-CisServer
This cmdlet establishes a connection to the vSphere Automation SDK server specified by the -Server parameter.
Syntax
-Server <String[]>
[-Force]
[-NotDefault]
[-Port <Int32>]
[-SaveCredentials]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
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 |
|
String[] | named |
|
Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to. | optional |
|
SwitchParameter | named |
|
Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'. | optional |
|
SwitchParameter | named |
|
Specifies that you do not want to save the specified servers as default servers. | optional |
|
Int32 | named |
|
Specifies the port on the server you want to use for the connection. | optional |
|
SwitchParameter | named |
|
Indicates that you want to save the specified credentials in the local credential store. |
[-Force]
[-NotDefault]
[-Password <SecureString>]
[-Port <Int32>]
[-SaveCredentials]
[-User <String>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
String[] | named |
|
Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to. | optional |
|
SwitchParameter | named |
|
Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'. | optional |
|
SwitchParameter | named |
|
Specifies that you do not want to save the specified servers as default servers. | optional |
|
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 |
|
Int32 | named |
|
Specifies the port on the server you want to use for the connection. | optional |
|
SwitchParameter | named |
|
Indicates that you want to save the specified credentials in the local credential store. | optional |
|
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". |
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
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. |
-Server <String[]>
[-Force]
[-NotDefault]
[-Port <Int32>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
SamlSecurityContext | named |
|
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 |
|
String[] | named |
|
Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to. | optional |
|
SwitchParameter | named |
|
Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'. | optional |
|
SwitchParameter | named |
|
Specifies that you do not want to save the specified servers as default servers. | optional |
|
Int32 | named |
|
Specifies the port on the server you want to use for the connection. |
-SessionSecret <String>
[-Force]
[-NotDefault]
[-Port <Int32>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
String[] | named |
|
Specifies the IP or DNS addresses of the vSphere Automation SDK servers you want to connect to. | required |
|
String | named |
|
Specifies the ID of an existing vSphere Automation SDK session you want to reestablish. | optional |
|
SwitchParameter | named |
|
Suppresses all user interface prompts during the cmdlet execution. Currently, these include 'Multiple default servers' and 'Invalid certificate action'. | optional |
|
SwitchParameter | named |
|
Specifies that you do not want to save the specified servers as default servers. | optional |
|
Int32 | named |
|
Specifies the port on the server you want to use for the connection. |
Output
Examples
Example 1
Connects to a vSphere Automation SDK server by using the User and Password parameters.
Example 2
Connects to a vSphere Automation SDK server by using the Credential parameter.
Example 3
Connects to a vSphere Automation SDK server by using the SessionSecret parameter.
Example 4
Connects to a vSphere Automation SDK server and stores the credentials in the credential store.
Example 5
Connects to a vSphere Automation SDK server when a record for the specified user is available in the credential store.
Example 6
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