Disconnect-AdtServer
Synopsis
Closes connections to adTempus servers.
Syntax
Connection (Default)
Disconnect-AdtServer [[-Connection] <AdtConnection[]>]
All
Disconnect-AdtServer -All
Description
Closes the specified connections, or the default connection if none is specified. Objects fetched through a closed connection can no longer be used.
Examples
Example 1
Disconnect-AdtServer
Closes the default connection.
Example 2
Get-AdtConnection | Where-Object Server -eq 'sched01' | Disconnect-AdtServer
Closes the connections to sched01.
Example 3
Disconnect-AdtServer -All
Closes all connections in the session.
Parameters
-All
Closes all connections.
| Type | SwitchParameter |
|---|---|
| Parameter sets | All |
| Required | True |
| Position | Named |
| Default value | False |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-Connection
The connections to close.
| Type | AdtConnection[] |
|---|---|
| Parameter sets | Connection |
| Required | False |
| Position | 0 |
| Default value | None |
| Accept pipeline input | True (ByValue) |
| Accept wildcard characters | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
ArcanaDevelopment.adTempus.PowerShell.AdtConnection[]
Connections from Get-AdtConnection.
Outputs
None
This cmdlet returns no output.
Notes
Connections stay open for the rest of the PowerShell session, or until they are closed with Disconnect-AdtServer. Objects fetched through a connection can be used only while it is open.