Get-ClusterNetwork
Get-ClusterNetwork
Get information about one or more networks in a failover cluster.
Syntax
Get-ClusterNetwork [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [<CommonParameters>]
InputObject
Name
Cluster
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 networks 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 to get.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
true |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.FailoverClusters.PowerShell.Cluster
Return Type
Microsoft.FailoverClusters.PowerShell.ClusterNetwork
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Get-ClusterNetwork
Name State
---- -----
Cluster Network 1 Up
Cluster Network 2 Up
Cluster Network 3 Up
Description
-----------
This command gets information about the networks used by the local cluster.