powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Connect-CIServer



NAME
Connect-CIServer

SYNOPSIS
Connects to the specified servers.

SYNTAX
Connect-CIServer [-Server] [-Org ] [-Credential ] [-User ] [-Password ing>] [-Port ] [-NotDefault] [-SaveCredentials] [-WhatIf] [-Confirm] []

Connect-CIServer [-Server] [-SessionId] [-Port ] [-NotDefault] [-WhatIf] [-Confirm] [ mmonParameters>]

Connect-CIServer -Menu [-WhatIf] [-Confirm] []


DESCRIPTION
Connects 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 ob
ject which represents the existing connection.
PowerCLI for vCloud supports a list of default servers. If the target servers cannot be determined from the specif
ied parameters, the cmdlet runs against the servers in the default server list. All default servers are kept in a g
lobal array variable called $DefaultCIServers. When you connect to a server, the server is added at the beginning o
f the array, unless the NotDefault parameter is specified. When you disconnect from a server, the server is removed
from the $DefaultCIServers variable. You can modify the value of the $DefaultCIServers variable manually.


PARAMETERS
-Server
Specify the IP or DNS addresses of the cloud servers you want to connect to.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Org
Specify 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 pa
rameter.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Credential
Specify a PSCredential object that contains credentials for authenticating with the server. For more informatio
n about the server authentication logic of PowerCLI, run "help about_server_authentication".

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-User
Specify the user name you want to use for authenticating with the server. If the Credential parameter is also s
pecified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, ru
n "help about_server_authentication".

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Password
Specify the password you want to use for authenticating with the server. If the Credential parameter is also sp
ecified, this parameter is ignored. For more information about the server authentication logic of PowerCLI, run
"help about_server_authentication".

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Port
Specify the port on the server you want to use for the connection.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-NotDefault
Specify that you don't want to save the specified servers as default servers.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SaveCredentials
Indicate that you want to save the specified credentials in the local credential store.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SessionId
Specify the ID of an existing cloud server session you want to reestablish.

Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Menu
Indicate that you want to select a server from a list of recently connected servers. If Menu is set to $true, t
he cmdlet retrieves a list of the last visited servers and enters a nested command prompt, so that you can sele
ct a server from the list.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
CIServer


NOTES




-------------- Example 1 --------------

C:\PS>Connect-CIServer -Server cloud.example.com -Name admin -Password pass


Connects as a system administrator to a system organization.





-------------- Example 2 --------------

C:\PS>Connect-CIServer -Server cloud.example.com -Name Org1Admin -Password pass -Org Organization1


Connects as an organization user to the provided organization.





-------------- Example 3 --------------

C:\PS>Connect-CIServer -Server cloud.example.com -Org Organization1 -Credential $vappUserCredential


Connects to the provided organization by specifying a credential object.





-------------- Example 4 --------------

C:\PS>Connect-CIServer -Server cloud.example.com -SessionID $sessionID


Connects to a server by providing a server session ID.





-------------- Example 5 --------------

C:\PS>Connect-CIServer -Menu


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






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Connect-CIServer.html
Disconnect-CIServer