Get-DbaWsfcNetworkInterface

Chrissy LeMaire (@cl), netnerds.net

Windows, Linux, macOS

Synopsis

Retrieves network interface configuration from Windows Server Failover Cluster nodes.

Retrieves detailed network adapter information from all nodes in a Windows Server Failover Cluster, including IP addresses, DHCP settings, and network assignments. This information is essential for troubleshooting SQL Server Failover Cluster Instance connectivity issues and verifying cluster network configuration.

Use this command to identify network misconfigurations that could impact SQL Server availability, document cluster network topology for compliance, or diagnose connectivity problems between cluster nodes.

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

Syntax

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

Examples

Example: 1

PS C:\> Get-DbaWsfcNetworkInterface -ComputerName cluster01

Gets network interface information from the failover cluster cluster01

Example: 2

PS C:\> Get-DbaWsfcNetworkInterface -ComputerName cluster01 | Select-Object *

Shows all network interface values, including the ones not shown in the default view

Optional Parameters

-ComputerName

Specifies the Windows Server Failover Cluster name or any cluster node name to query for network interface information.
Use this when troubleshooting SQL Server FCI connectivity issues or documenting cluster network topology.
Accepts cluster names, node names, or IP addresses of cluster resources.

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

System.Management.ManagementObject

Returns one network interface object per adapter found on cluster nodes queried. Each object represents a network interface configuration with IP address and DHCP settings.

Default display properties (via Select-DefaultView):

ClusterName: The name of the Windows Server Failover Cluster
ClusterFqdn: The fully qualified domain name of the cluster
Name: The name of the network interface
Network: The name or identifier of the network this interface belongs to
Node: The name of the cluster node this interface is assigned to
Adapter: The network adapter identifier or friendly name
Address: The IP address assigned to this interface
DhcpEnabled: Boolean indicating if DHCP is enabled for this interface
IPv4Addresses: String array of IPv4 addresses configured on this interface
IPv6Addresses: String array of IPv6 addresses configured on this interface

*Additional properties available via Select-Object :

All properties from the MSCluster_NetworkInterface WMI class, including network role, state, and adapter-level details.