Export (0) Print
Expand All
Expand Minimize

Get-RemoteAccessLoadBalancer

Windows Server 2012 R2 and Windows 8.1

Updated: September 24, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-RemoteAccessLoadBalancer

Displays load balanced cluster settings.

Syntax

Parameter Set: Get0
Get-RemoteAccessLoadBalancer [[-EntrypointName] <String> ] [-AsJob] [-Brief] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-RemoteAccessLoadBalancer cmdlet displays the following:
-- A list of servers in the cluster.
-- The status of each server.
-- The VPN IP address range for each server, if VPN is enabled.
-- A list of the internal and external virtual IP addresses (VIPs) in the cluster.
-- The status of the third-party load balancer.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Brief

Indicates that the cmdlet suppresses retrieving node status. If you specify this parameter, the cmdlet returns only the host name of each node.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

Specifies the IPv4 or IPv6 address, or host name, of the server on which the cmdlet runs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EntrypointName<String>

Specifies the name of the entry point in the multi-site deployment for which the load balancing configuration should be retrieved.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

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

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#RemoteAccessLoadBalancer

    The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
    The RemoteAccessLoadBalancer object consists of the following properties:
    The list of nodes in the cluster and the following properties for each node:
    -- IPv4 or IPv6 address or host name of the node.
    -- The load balancing status of each node.
    -- IPv4 address ranges configured on each node for the VPN static pool address assignment.
    -- Status of third party load balancer: Enabled or Disabled.
    -- The list of internet virtual IP addresses.
    -- The list of internal virtual IP addresses.


Examples

EXAMPLE 1

This example retrieves the NLB status of the site named Edge1_Site.


PS C:\> Get-RemoteAccessLoadBalancer –EntryPointName Edge1_Site
NlbNodeStatus               : edge.corp.contoso.com 

ThirdPartyLoadBalancer      : Disabled 

InternetVirtualIPAddress    : {131.107.0.2/255.255.255.0} 

InternalVirtualIPAddress    : {2006:2005:1::2/64} 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft