sys.availability_group_listeners (Transact-SQL)

Applies to: SQL Server

For each Always On availability group, returns either zero rows indicating that no network name is associated with the availability group, or returns a row for each availability-group listener configuration in the Windows Server Failover Clustering (WSFC) cluster. This view displays the real-time configuration gathered from cluster.

Note

This catalog view does not describe details of an IP configuration, that was defined in the WSFC cluster.

Column name Data type Description
group_id uniqueidentifier Availability group ID (group_id) from sys.availability_groups.
listener_id nvarchar(36) GUID from the cluster resource ID.
dns_name nvarchar(63) Configured network name (hostname) of the availability group listener.
port int The TCP port number configured for the availability group listener.

NULL = Listener was configured outside SQL Server and its port number hasn't been added to the availability group. To add the port, use the MODIFY LISTENER option of the ALTER AVAILABILITY GROUPTransact-SQL statement.
is_conformant bit Whether this IP configuration is conformant, one of:

1 = Listener is conformant. Only "OR" relations exist among its Internet Protocol (IP) addresses. Conformant encompasses every an IP configuration that was created by the CREATE AVAILABILITY GROUPTransact-SQL statement. In addition, if an IP configuration that was created outside of SQL Server, for example by using the WSFC Failover Cluster Manager, but can be modified by the ALTER AVAILABILITY GROUP tsql statement, the IP configuration qualifies as conformant.

0 = Listener is nonconformant. Typically, this indicates an IP address that couldn't be configured by using SQL Server commands and, instead, was defined directly in the WSFC cluster.
ip_configuration_string_from_cluster nvarchar(max) Cluster IP configuration strings, if any, for this listener. NULL = Listener has no virtual IP addresses. For example:

IPv4 address: 65.55.39.10.

IPv6 address: 2001::4898:23:1002:20f:1fff:feff:b3a3
is_distributed_network_name bit Applies to: SQL Server 2019 (15.x) CU8 and later, SQL Server 2017 (14.x) CU25 and later, SQL Server 2016 (13.x) SP3 and later

This column indicates the listener is a distributed network name (DNN) listener if value set to 1. For more information, see Configure a DNN listener for an availability group

Security

Permissions

The visibility of the metadata in catalog views is limited to securables that a user either owns, or on which the user was granted some permission. For more information, see Metadata Visibility Configuration.

See also