Get-NlbCluster

Get-NlbCluster

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

Syntax

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

Detailed Description

The Get-NlbCluster cmdlet retrieves information about the NLB cluster. The information includes the properties, or attributes, that define the cluster and its status.

Parameters

-HostName <string>

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or if "-HostName ." is used, the local cluster is assumed. [Alias: hn]

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

1

-InterfaceName <string>

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

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

2

-CommonParameter

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Examples

EXAMPLE 1

C:\PS>

Get-NlbCluster



Name                IPAddress           SubnetMask          Mode

----                ---------           ----------          ----

cluster1            3.53.100.100        255.0.0.0           UNICAST                        

Description

-----------

This command gets the cluster object for the local NLB cluster, that is, the cluster that this node is part of.

EXAMPLE 2

C:\PS>

Get-NlbCluster -HostName node1



Name                IPAddress           SubnetMask          Mode

----                ---------           ----------          ----

cluster2            4.53.100.100        255.0.0.0           UNICAST                        

Description

-----------

This command gets the cluster object for the NLB cluster that node node1 is part of.

EXAMPLE 3

C:\PS>

Get-NlbCluster -HostName node1 -InterfaceName vlan-2



Name                IPAddress           SubnetMask          Mode

----                ---------           ----------          ----

cluster2            4.53.100.100        255.0.0.0           UNICAST                        

Description

-----------

This command gets the cluster object for the NLB cluster that node node1 (interface vlan-2) is part of.

See Also

Reference

New-NlbCluster
Remove-NlbCluster
Resume-NlbCluster
Set-NlbCluster
Start-NlbCluster
Stop-NlbCluster
Suspend-NlbCluster