Get-ClusterNetworkInterface
Get-ClusterNetworkInterface
Get information about one or more network adapters in a failover cluster.
Syntax
Get-ClusterNetworkInterface [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [-Network <StringCollection>] [-Node <StringCollection>] [<CommonParameters>]
InputObject
Name
Cluster
Network
Node
Detailed Description
A failover cluster requires network connectivity among nodes and between clients and nodes.
Parameters
Cluster
Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
InputObject
Specifies the cluster to enumerate cluster network interfaces on.
Default Value: **
Data Type: psobject
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Name
Specifies the name of the cluster network interface to get.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Network
Specifies the name of the cluster network to enumerate network interfaces for.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Node
Specifies the name of the cluster node to enumerate network interface on.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.FailoverClusters.PowerShell.Cluster, Microsoft.FailoverClusters.PowerShell.ClusterNetwork
Return Type
Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
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
Description
-----------
This command displays information about the network adapters used by the local cluster.
-------------------------- EXAMPLE 2 --------------------------
Command Prompt: C:\PS>
Get-ClusterNode node1 | Get-ClusterNetworkInterface
Name Node Network State
---- ---- ------- -----
node1 - Local A ... node1 Cluster Network 1 Up
node1 - Local A ... node1 Cluster Network 2 Up
Description
-----------
This command displays information about the network adapters used by node1 in the local cluster. It is equivalent to "Get-ClusterNetworkInterface -node node1".