Get-ClusterNetwork

Gets information about one or more networks in a failover cluster.

Syntax

Get-ClusterNetwork
   [[-Name] <StringCollection>]
   [-InputObject <PSObject>]
   [-Cluster <String>]
   [<CommonParameters>]

Description

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

Examples

Example 1

PS C:\> Get-ClusterNetwork
Name                                                                      State 
----                                                                      ----- 
Cluster Network 1                                                            Up 
Cluster Network 2                                                            Up 
Cluster Network 3                                                            Up

This example gets information about the networks used by the local cluster.

Example 2

PS C:\> (Get-ClusterNetwork -Name "Cluster Network 1").Name = "Cluster Network 3"

This example renames Cluster Network 1 to Cluster Network 3.

Optional 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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Specifies the cluster on which to enumerate the cluster networks.

Type:PSObject
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

Specifies the name of the cluster network to get.

Type:StringCollection
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.Cluster

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterNetwork