Remove-DbaCmConnection

Want to see the source code for this command? Check out Remove-DbaCmConnection on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaCmConnection.

Synopsis

Removes connection objects from the connection cache used for remote computer management.

Description

Removes connection objects from the connection cache used for remote computer management.

Syntax

Remove-DbaCmConnection
    [-ComputerName] <DbaCmConnectionParameter[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Remove-DbaCmConnection -ComputerName sql2014

Removes the cached connection to the server sql2014 from the cache.

Example: 2

PS C:\> Get-DbaCmConnection | Remove-DbaCmConnection

Clears the entire connection cache.

Required Parameters

-ComputerName

The target computer. Accepts both text as well as the output of Get-DbaCmConnection.

Optional Parameters

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.