Author | Viorel Ciucu (@viorelciucu) |
Availability | Windows, Linux, macOS |
Want to see the source code for this command? Check out Get-DbaAgListener on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaAgListener.
Retrieves availability group listener configurations including IP addresses and port numbers.
Retrieves availability group listener configurations from SQL Server instances, providing essential network details needed for client connections and troubleshooting. This function returns listener names, port numbers, IP configurations, and associated availability groups, which is crucial for validating listener setup and diagnosing connection issues. Use this when you need to document your AG infrastructure, verify listener configurations after setup, or troubleshoot client connectivity problems.
Get-DbaAgListener
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-AvailabilityGroup] <String[]>]
[[-Listener] <String[]>]
[[-InputObject] <AvailabilityGroup[]>]
[-EnableException]
[<CommonParameters>]
PS C:\> Get-DbaAgListener -SqlInstance sql2017a
Returns all listeners found on sql2017a
PS C:\> Get-DbaAgListener -SqlInstance sql2017a -AvailabilityGroup AG-a
Returns all listeners found on sql2017a on sql2017a for the availability group AG-a
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup OPP | Get-DbaAgListener
Returns all listeners found on sql2017a on sql2017a for the availability group OPP
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 |
Specifies which availability groups to include when retrieving listener information. Supports wildcards for pattern matching.
Use this when you only need listener details for specific availability groups rather than all groups on the instance.
Alias | |
Required | False |
Pipeline | false |
Default Value |
Specifies which availability group listeners to return by name. Accepts multiple listener names for filtering results.
Use this when you need to examine specific listeners during troubleshooting or when documenting particular AG configurations.
Alias | |
Required | False |
Pipeline | false |
Default Value |
Accepts availability group objects from Get-DbaAvailabilityGroup for pipeline operations.
Use this when chaining commands to get listener details for specific availability groups you've already retrieved.
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 |