Connect-CIServer

This cmdlet establishes a connection to the specified cloud servers. The cmdlet starts a new session or re-establishes a previous session with a cloud server using the specified parameters. If a connection to a server already exists, the cmdlet returns an object which represents the existing connection.

Syntax

-Server  <String[]>
[-Credential  <PSCredential>]
[-NotDefault]
[-Org  <String>]
[-Password  <String>]
[-Port  <Int32>]
[-SaveCredentials]
[-User  <String>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Server
String[] named
  • wildcards
  • Specifies the IP or DNS addresses of the cloud servers you want to connect to.
    optional
    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".
    optional
    NotDefault
    SwitchParameter named Specifies that you do not want to save the specified servers as default servers.
    optional
    Org
    String named
  • wildcards
  • Specifies the name of the organization you want to manage. By default, it is the System organization to which you must connect to. The value of the Org parameter overrides the domain part of the value provided to the User parameter.
    optional
    Password
    String 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
  • wildcards
  • 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".

    [-PIDatacenter]  <CIServerRelatedObject>
    [-NotDefault]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    PIDatacenter
    CIServerRelatedObject 1
  • pipeline
  • Specifies a vCloud Air datacenter, which can be retrieved by using the Get-PIDatacenter cmdlet or PIComputeInstance, which can be retrieved by using the Get-PIComputeInstance cmdlet.
    optional
    NotDefault
    SwitchParameter named Specifies that you do not want to save the specified servers as default servers.

    -Menu
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Menu
    SwitchParameter named Indicates that you want to select a 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.

    [-SessionId]  <String>
    -Server  <String[]>
    [-NotDefault]
    [-Port  <Int32>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    SessionId
    String 1 Specifies the ID of an existing cloud server session you want to reestablish.
    required
    Server
    String[] named
  • wildcards
  • Specifies the IP or DNS addresses of the cloud servers you want to connect to.
    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

    VMware.VimAutomation.Cloud.Types.V1.CIServer

    Examples


    Example 1

    Connect-CIServer -Server cloud.example.com -User Org1Admin -Password pass -Org Organization1

    Connects as an organization user to the provided organization.

    Example 2

    Connect-CIServer -Server cloud.example.com -User admin -Password pass

    Connects as a system administrator to a system organization.

    Example 3

    Connect-CIServer -Server cloud.example.com -Org Organization1 -Credential $vappUserCredential

    Connects to the provided organization by specifying a credential object.

    Example 4

    Connect-CIServer -Server cloud.example.com -SessionID $sessionID

    Connects to a server by providing a server session ID.

    Example 5

    Connect-CIServer -Menu

    Connects to a server from the list of recently connected servers.

    Example 6

    $vCloudAirConnection = Connect-PIServer -User myUser@vmware.com -Password 'pass'
    $myDatacenter = Get-PIDatacenter 'myDatacenter'
    Connect-CIServer -PIDatacenter $myDatacenter

    Connects to a vCloud Air datacenter.

    Related Commands

    Feedback

    Was this page helpful?