Edit

Share via


Get-ClusterNetworkInterface

Gets information about one or more network adapters in a failover cluster.

Syntax

Default (Default)

Get-ClusterNetworkInterface
    [[-Name] <StringCollection>]
    [-Node <StringCollection>]
    [-Network <StringCollection>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

Description

The Get-ClusterNetworkInterface cmdlet gets information about one or more network adapters in a failover cluster. A failover cluster requires network connectivity among nodes and between clients and nodes.

Examples

Example 1

PS C:\> Get-ClusterNetworkInterface
Name                Node                Network                           State
----                ----                -------                           -----
node1 - Local A ...  node1               Cluster Network 1                    Up
node2 - Local A ...  node2               Cluster Network 1                    Up
node1 - Local A ...  node1               Cluster Network 2                    Up
node2 - Local A ...  node2               Cluster Network 2                    Up

This example displays information about the physical network adapters used by the local cluster.

Example 2

PS C:\> Get-ClusterNode -Name node1 | Get-ClusterNetworkInterface
Name                Node                Network                           State
----                ----                -------                           -----
node1 - Local A ...  node1               Cluster Network 1                    Up
node1 - Local A ...  node1               Cluster Network 2                    Up

This example displays information about the physical network adapters used by node1 in the local cluster. This cmdlet is equivalent to Get-ClusterNetworkInterface -Node node1.

Parameters

-Cluster

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specifies the cluster on which to enumerate the cluster network interfaces.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the cluster network interface to get.

Parameter properties

Type:StringCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Network

Specifies the name of the cluster network for which to enumerate the network interfaces.

Parameter properties

Type:StringCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Node

Specifies the name of the cluster node on which to enumerate the network interfaces.

Parameter properties

Type:StringCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Microsoft.FailoverClusters.PowerShell.ClusterNetwork

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface