Get-ClusterNetworkInterface
Get-ClusterNetworkInterface
Gets information about one or more network adapters in a failover cluster.
Syntax
Parameter Set: InputObject
Get-ClusterNetworkInterface [[-Name] <StringCollection> ] [-Cluster <String> ] [-InputObject <PSObject> ] [-Network <StringCollection> ] [-Node <StringCollection> ] [ <CommonParameters>]
Detailed 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.
Parameters
-Cluster<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<PSObject>
Specifies the cluster on which to enumerate the cluster network interfaces.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<StringCollection>
Specifies the name of the cluster network interface to get.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Network<StringCollection>
Specifies the name of the cluster network for which to enumerate the network interfaces.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Node<StringCollection>
Specifies the name of the cluster node on which to enumerate the network interfaces.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Microsoft.FailoverClusters.PowerShell.Cluster
- Microsoft.FailoverClusters.PowerShell.ClusterNetwork
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface
Examples
EXAMPLE 1
This example displays information about the physical network adapters used by the local cluster.
PS C:\> Get-ClusterNetworkInterface
EXAMPLE 2
This example displays information about the physical network adapters used by node1 in the local cluster. This cmdlet is equivalent to Get-ClusterNetworkInterface -Node node1node1
.
PS C:\> Get-ClusterNode –Name node1 | Get-ClusterNetworkInterface