Disconnect-LXCO
This cmdlet disconnects from the Lenovo Lenovo XClarity Orchestrator server. If jobs are running the background, the connection is not terminated unless the -Force parameter is specified.
Syntax
Disconnect-LXCO [-Connection LXCOConnection]
[-Force]
[CommonParameter]
Disconnect-LXCO -All
[-Force]
[LXCOConnection]
Parameters
- -Connection LXCAConnection
- Specifies the connection to the Lenovo XClarity Orchestrator server. If no connection is specified, the result from the last Connect-LXCO cmdlet is used.
- -Force
- Terminates the connection to the XClarity Orchestrator server, even if PowerShell background jobs that are assigned to this connection are running in the background.
- -All
- Deletes all connections that exists in current PowerShell session.
- 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
- Lenovo.XClarityOrchestrator.PowerShell.Data.Lenovo.LXCOConnection
If a connections was successfully terminated, this cmdlet returns an LXCOConnection class object that contains information about the XClarity Orchestrator server connection that was terminated
- Lenovo.XClarityOrchestrator.PowerShell.Data.Lenovo.RequestStatusMessage
If an error occurred, this cmdlet returns a RequestStatusMessage object that contains information about the reason of the failure.
Examples
The following example terminates the last connection that was created to an XClarity Orchestrator server.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred
#Other actions
Disconnect-LXCO
The following example terminates a specified connection, even if there are running background jobs that are assigned to the connection.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred
#Other actions
Disconnect-LXCO -Connection $connection -Force
The following example terminates all connections in current PowerShell session, even if there are running background jobs that are assigned to these connections.
$cred = Get-Credential
Connect-LXCO -HostUri 192.0.2.0 -Credential $cred
#Other actions
Disconnect-LXCO -All -Force