Edit

Share via


Get-NlbCluster

Gets information about the NLB cluster object that is queried by the caller.

Syntax

Default (Default)

Get-NlbCluster
    [[-HostName] <String>]
    [[-InterfaceName] <String>]
    [<CommonParameters>]

Description

The Get-NlbCluster cmdlet gets information about the Network Load Balancing (NLB) cluster. The information includes the properties, or attributes, that define the cluster and its status.

Examples

Example 1: Get a cluster object from the local NLB cluster

PS C:\>Get-NlbCluster
Name                IPAddress           SubnetMask          Mode
----                ---------           ----------          ----
cluster1            3.53.100.100        255.0.0.0           UNICAST

This command gets the cluster object for the local NLB cluster.

Example 2: Get a cluster object for the specified NLB cluster

PS C:\>Get-NlbCluster -HostName "Node01"
Name                IPAddress           SubnetMask          Mode
----                ---------           ----------          ----
cluster2            4.53.100.100        255.0.0.0           UNICAST

This command gets the cluster object for the NLB cluster that is named Node01.

Example 3: Get a cluster object for the specified NLB cluster using the specified interface

PS C:\>Get-NlbCluster -HostName "Node02" -InterfaceName "Vlan-2"
Name                IPAddress           SubnetMask          Mode
----                ---------           ----------          ----
cluster2            4.53.100.100        255.0.0.0           UNICAST

This command gets the cluster object for the NLB cluster that node named Node02 through the interface named Vlan-2.

Parameters

-HostName

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or a value of . is entered, then the local cluster is assumed.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Host, HN, H

Parameter sets

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

-InterfaceName

Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Interface, IN, I

Parameter sets

(All)
Position:1
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

None

Outputs

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster