Table of Contents

Class AvailabilitySchema.AvailabilityGroupListener

Namespace
LinqToDB.Tools.DataProvider.SqlServer.Schemas
Assembly
linq2db.Tools.dll

sys.availability_group_listeners (Transact-SQL)

Applies to: √ SQL Server (all supported versions)

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.


See sys.availability_group_listeners.

[Table(Schema = "sys", Name = "availability_group_listeners", IsView = true)]
public class AvailabilitySchema.AvailabilityGroupListener
Inheritance
AvailabilitySchema.AvailabilityGroupListener
Extension Methods

Properties

DnsName

Configured network name (hostname) of the availability group listener.

[Column("dns_name")]
[Nullable]
public string? DnsName { get; set; }

Property Value

string

GroupID

Availability group ID (group_id) from sys.availability_groups.

[Column("group_id")]
[NotNull]
public Guid GroupID { get; set; }

Property Value

Guid

IpConfigurationStringFromCluster

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

[Column("ip_configuration_string_from_cluster")]
[Nullable]
public string? IpConfigurationStringFromCluster { get; set; }

Property Value

string

IsConformant

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 could not be configured by using SQL Server commands and, instead, was defined directly in the WSFC cluster.

[Column("is_conformant")]
[NotNull]
public bool IsConformant { get; set; }

Property Value

bool

ListenerID

GUID from the cluster resource ID.

[Column("listener_id")]
[Nullable]
public string? ListenerID { get; set; }

Property Value

string

Port

The TCP port number configured for the availability group listener.

NULL = Listener was configured outside SQL Server and its port number has not been added to the availability group. To add the port, pleaseuse the MODIFY LISTENER option of the ALTER AVAILABILITY GROUPTransact-SQL statement.

[Column("port")]
[Nullable]
public int? Port { get; set; }

Property Value

int?