Share via


sys.availability_group_listener_ip_addresses (Transact-SQL)

Returns a row for every IP address that is associated with any AlwaysOn availability group listener in the Windows Server Failover Clustering (WSFC) cluster.

Primary key:  listener_id + ip_address + ip_sub_mask

Column name

Data type

Description

listener_id

nvarchar(36)

Resource GUID from Windows Server Failover Clustering (WSFC) cluster.

ip_address

nvarchar(48)

Configured virtual IP address of the availability group listener. Returns a single IPv4 or IPv6 address.

ip_subnet_mask

nvarchar(15)

Configured IP subnet mask for the IPv4 address, if any, that is configured for the availability group listener.

NULL = IPv6 subnet

is_dhcp

bit

Whether the IP address is configured by DHCP, one of:

0 = IP address is not configured by DHCP.

1 = IP address is configured by DHCP

network_subnet_ip

nvarchar(48)

Network subnet IP address that specifies the subnet to which the IP address belongs.

network_subnet_prefix_length

int

Network subnet prefix length of the subnet to which the IP address belongs.

network_subnet_ipv4_mask

nvarchar(45)

Network subnet mask of the subnet to which the IP address belongs. network_subnet_ipv4_mask to specify the DHCP <network_subnet_option> options in a WITH DHCP clause of the CREATE AVAILABILITY GROUP or ALTER AVAILABILITY GROUP Transact-SQL statement.

NULL = IPv6 subnet

state

tinyint

IP resource ONLINE/OFFLINE state from the WSFC cluster, one of:

1 = Online. IP resource is online.

0 = Offline. IP resource is offline.

2 = Online Pending. IP resource is offline but is being brought online.

3 = Failed. IP resource was being brought online but failed.

state_desc

nvarchar(60)

Description of state, one of:

ONLINE

OFFLINE

ONLINE_PENDING

FAILED

Security

Permissions

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

See Also

Reference

Catalog Views (Transact-SQL)

Concepts

Querying the SQL Server System Catalog FAQ