Get-DbaWsfcNetwork

Chrissy LeMaire (@cl), netnerds.net

Windows, Linux, macOS

Synopsis

Retrieves network configuration details from Windows Server Failover Clustering for SQL Server high availability troubleshooting.

Retrieves detailed network information from Windows Server Failover Cluster nodes, including IP addresses, subnet masks, and network roles. This information is essential for diagnosing connectivity issues with SQL Server Failover Cluster Instances (FCIs) and Availability Groups, especially when troubleshooting network-related failures or validating cluster network configuration. The function returns comprehensive network details like IPv4/IPv6 addresses, prefix lengths, and quorum settings that help DBAs understand how cluster networks are configured and identify potential communication problems between nodes.

All Windows Server Failover Clustering (Wsfc) commands require local admin on each member node.

Syntax

Get-DbaWsfcNetwork
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaWsfcNetwork -ComputerName cluster01

Gets network information from the failover cluster cluster01

Optional Parameters

-ComputerName

Specifies the Windows Server Failover Cluster name or any cluster node name to retrieve network configuration from.
Use this to target a specific cluster when troubleshooting network connectivity issues with SQL Server FCIs or Availability Groups.
Accepts multiple cluster names for bulk network configuration analysis.

Property	Value
Alias
Required	False
Pipeline	true (ByValue)
Default Value	$env:COMPUTERNAME

-Credential

Allows you to login to the cluster using alternative credentials.

Property	Value
Alias
Required	False
Pipeline	false
Default Value

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

Property	Value
Alias
Required	False
Pipeline	false
Default Value	False

Outputs

PSCustomObject

Returns one object per cluster network found on the Windows Server Failover Cluster.

Properties:

ClusterName: The name of the Windows Server Failover Cluster
ClusterFqdn: The fully qualified domain name of the cluster
Name: The network name within the cluster configuration
Address: The network address (IP address or network identifier)
AddressMask: The subnet mask or network address mask
IPv4Addresses: Array of IPv4 addresses assigned to this cluster network
IPv4PrefixLengths: Array of IPv4 prefix lengths corresponding to IPv4Addresses
IPv6Addresses: Array of IPv6 addresses assigned to this cluster network
IPv6PrefixLengths: Array of IPv6 prefix lengths corresponding to IPv6Addresses
QuorumType: The quorum type indicator (numeric value)
QuorumTypeValue: The quorum type value representation
RequestReplyTimeout: The request/reply timeout value in milliseconds
Role: The role of the network in the cluster (cluster, client, etc.)