Skip to main content

Connect-LXCO

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

Use the Disconnect-LXCO cmdlet to disconnect from XClarity Orchestrator server.

Note
You cannot pipe objects to this cmdlet.

Syntax​

Connect-LXCO  -HostUri String
              -Credential PSCredential
             [-Port Integer]
             [-ProxyUri String]
             [-ProxyCredential PSCredential]
             [-ProxyUseDefaultCredentials]
             [-Timeout Integer]
             [-SkipCertificateCheck]
             [CommonParameter]

Parameters​

-HostUri String
Specifies the HTTPS address (IP address or hostname) for the XClarity Orchestrator server.
-Credential PSCredential
Specifies a credential object that includes the credentials for logging in to the XClarity Orchestrator server.
Tip
To obtain the credential object, use the Get-Credential cmdlet.
-ProxyUri String
Specifies the IP address or hostname of a network proxy server of the proxy server to use instead of connecting directly to the internet.
-ProxyCredential PSCredential
Specifies a credential object for a user account that has permission to use the proxy server that is specified by the Proxy parameter.

This parameter is valid only when the -ProxyUri parameter is specified. You cannot use the -ProxyCredential and -ProxyUseDefaultCredentials parameters in the same command.

Tip: To obtain the credential object, use the Get-Credential cmdlet.

-ProxyUseDefaultCredentials
Indicates that the cmdlet uses the credentials of the current user to access the proxy server that is specified by the -ProxyUri parameter.

This parameter is valid only when the -ProxyUri parameter is specified. You cannot use the -ProxyCredential and -ProxyUseDefaultCredentials parameters in the same command.

-Port Int
Specifies the port on the XClarity Orchestrator server to be used for the connection. The default value is 443.
-Timeout Int
Specifies the number of seconds that the cmdlet waits for an HTTPS response from the XClarity Orchestrator 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 Orchestrator server contains a valid certificate that is signed by a trusted certification authority.
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​

Examples​

This cmdlet connects to an XClarity Orchestrator server.

$cred = Get-Credential
$connection = Connect-LXCO -HostUri 192.0.2.0 -Credential $cred