Get-DbaAgListener

Synopsis

Retrieves availability group listener configurations including IP addresses and port numbers.

Description

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.

Syntax

Get-DbaAgListener
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-AvailabilityGroup] <String[]>]
    [[-Listener] <String[]>]
    [[-InputObject] <AvailabilityGroup[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaAgListener -SqlInstance sql2017a

Returns all listeners found on sql2017a

Example: 2

PS C:\> Get-DbaAgListener -SqlInstance sql2017a -AvailabilityGroup AG-a

Returns all listeners found on sql2017a on sql2017a for the availability group AG-a

Example: 3

PS C:\> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup OPP | Get-DbaAgListener

Returns all listeners found on sql2017a on sql2017a for the availability group OPP

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.

-SqlCredential

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.

-AvailabilityGroup

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.

-Listener

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.

-InputObject

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.

-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.

Outputs

Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener

Returns one listener object per availability group listener found on the specified instance(s) or availability group(s).

Default display properties (via Select-DefaultView):

• ComputerName: The computer name of the SQL Server instance hosting the Availability Group
• InstanceName: The SQL Server instance name
• SqlInstance: The full SQL Server instance name (computer\instance)
• AvailabilityGroup: Name of the Availability Group that owns this listener
• Name: Network name of the listener that clients use for connections
• PortNumber: TCP port number for client connections (default 1433)
• ClusterIPConfiguration: WSFC cluster IP resource configuration details

Additional properties available (from SMO AvailabilityGroupListener object):

• AvailabilityGroupListenerIPAddresses: Collection of IP address configurations for this listener (one per subnet in multi-subnet scenarios)
• Urn: Unique resource name for programmatic identification
• State: SMO object state (Existing, Creating, Pending, etc.)
• Properties: Collection of object properties and their values All properties from the base SMO AvailabilityGroupListener object are accessible via Select-Object * even though only default properties are displayed by default.