Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-NlbCluster

Last Updated: 3/8/2017

SYNOPSIS

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

SYNTAX

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.

Type: String
Parameter Sets: (All)
Aliases: Host, HN, H

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

-InterfaceName

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

Type: String
Parameter Sets: (All)
Aliases: Interface, IN, I

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

None

OUTPUTS

Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

NOTES

New-NlbCluster

Remove-NlbCluster

Resume-NlbCluster

Set-NlbCluster

Start-NlbCluster

Stop-NlbCluster

Suspend-NlbCluster

© 2017 Microsoft