< Back
Remove-DbaAgListener
Post
NAME Remove-DbaAgListener
SYNOPSIS
Removes a listener from an availability group on a SQL Server instance.
SYNTAX
Remove-DbaAgListener [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Listener] <System.String[]>] [[-AvailabilityGroup] <System.String[]>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Removes a listener from an availability group on a SQL Server instance.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
Only remove listeners from specific availability groups.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener[]>]
Enables piping from Get-DbaListener
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Listener [<System.String[]>]
The listener or listeners to remove.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
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.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAvailabilityGroup -SqlInstance sqlserver2012 -AvailabilityGroup availabilitygroup1 |
Remove-DbaAgListener
Removes the listeners returned from the Get-DbaAvailabilityGroup function. Prompts for confirmation.
RELATED LINKS
https://dbatools.io/Remove-DbaAgListener
SYNOPSIS
Removes a listener from an availability group on a SQL Server instance.
SYNTAX
Remove-DbaAgListener [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Listener] <System.String[]>] [[-AvailabilityGroup] <System.String[]>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Removes a listener from an availability group on a SQL Server instance.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
Only remove listeners from specific availability groups.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener[]>]
Enables piping from Get-DbaListener
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Listener [<System.String[]>]
The listener or listeners to remove.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
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.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaAvailabilityGroup -SqlInstance sqlserver2012 -AvailabilityGroup availabilitygroup1 |
Remove-DbaAgListener
Removes the listeners returned from the Get-DbaAvailabilityGroup function. Prompts for confirmation.
RELATED LINKS
https://dbatools.io/Remove-DbaAgListener