Skip to main content

Connect-LXCA

This cmdlet creates a connection to the Lenovo XClarity Administrator server that can be used by other cmdlets.

Use the Disconnect-LXCA cmdlet to disconnect from XClarity Administrator server.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Connect-LXCA  -Host String
              -Credential PSCredential
             [-Port Int]
             [-Proxy WebProxy]
             [-Timeout Int]
             [-SkipCertificateCheck]
             [-ChangeExpiredPassword]
             [CommonParameter]

Parameters​

-Host String
Specifies the HTTPS address (IP address or hostname) for the XClarity Administrator server.
-Credential PSCredential
Specifies a credential object that includes the credentials for logging in to the XClarity Administrator server.
Tip
To obtain the credential object, use the Get-Credential cmdlet.
-Port Int
Specifies the port on the XClarity Administrator server to be used for the connection. The default value is 443.
-Proxy WebProxy
Specifies a Web service proxy object that includes proxy connection and authentication information.
Tip
To obtain a proxy object, use the New-WebServiceProxy cmdlet.
-Timeout Int
Specifies the number of seconds that the cmdlet waits for an HTTPS response from the XClarity Administrator server. By default, the time-out value is 600 seconds.
-SkipCertificateCheck
If specified, this cmdlet does not check for server certificates. Otherwise, the connection is made only if the XClarity Administrator server contains a valid certificate that is signed by a trusted certification authority.
-ChangeExpiredPassword
If specified and the password is expired, this cmdlet prompts for the current password, new password, and confirm password.
CommonParameters
This cmdlet supports the following common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable, -OutBuffer, -PipelineVariable, -OutVariable. For detailed information about each common parameter, see the Microsoft PowerShell Common Parameters webpage.

Results​

This cmdlet returns an LXCAConnection class object that contains the information for the XClarity Administrator server connection.

Examples​

The following example retrieves the credentials that are then passed to this cmdlet to connect to the XClarity Administrator server with IP address 192.0.2.0.
$cred = Get-Credential
$connection = Connect-LXCA -Host 192.0.2.0 -Credential $cred
The following example changes the expired password.
$lxcaIP = "192.0.2.0"

# get credential for user with expired password
$cred = Get-Credential

Connect-LXCA -Host $lxcaIP -Credential $cred -SkipCertificateCheck -ChangeExpiredPassword