| Author | Chrissy LeMaire (@cl), netnerds.net |
| Availability | Windows, Linux, macOS |
Want to see the source code for this command? Check out Remove-DbaAgListener on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaAgListener.
Removes a listener from an availability group on a SQL Server instance.
Removes a listener from an availability group on a SQL Server instance.
Remove-DbaAgListener
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-Listener] <String[]>]
[[-AvailabilityGroup] <String[]>]
[[-InputObject] <AvailabilityGroupListener[]>]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PS C:\> Remove-DbaAgListener -SqlInstance sqlserver2012 -AvailabilityGroup ag1, ag2 -Confirm:$false
Removes the ag1 and ag2 availability groups on sqlserver2012. Does not prompt for confirmation.
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2012 -AvailabilityGroup availabilitygroup1 | Remove-DbaAgListener
Removes the listeners returned from the Get-DbaAvailabilityGroup function. Prompts for confirmation.
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
The listener or listeners to remove.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Only remove listeners from specific availability groups.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Enables piping from Get-DbaListener
| Alias | |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |
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.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Shows what would happen if the command were to run. No actions are actually performed.
| Alias | wi |
| Required | False |
| Pipeline | false |
| Default Value |
Prompts you for confirmation before executing any changing operations within the command.
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |