Share via


SetByDisableLoadBalancing method of the PS_RemoteAccessLoadBalancer class

This cmdlet does the following1. Configures load balancing clusters on the internal and Internet interfaces (in case of double NIC) or on a single interface (in case of single NIC) for remote access and adds the current server to the cluster. Current server refers to the server on which this cmdlet is run. 2. Enables/disables usage of 3rd party load balancer.

Syntax

uint32 SetByDisableLoadBalancing(
  [in]  boolean                  Disable,
  [in]  string                   ComputerName,
  [in]  boolean                  Force,
  [in]  boolean                  PassThru,
  [out] RemoteAccessLoadBalancer cmdletOutput
);

Parameters

Disable [in]

When specified this switch parameter indicates that all forms of load balancing should be disabled all together.

ComputerName [in]

IPv4/IPv6 address or hostname of the machine on which the remote access server machine specific tasks should be executed. If ComputerName is specified then this remote access server is added to the load balancing cluster that is created.

Force [in]

Switch parameter used to suppress user confirmation prompts for the following conditions. When suppressed the cmdlet assumes user confirmation for the below mentioned changes 1. Disabling load balancing disables high availability capabilities for the Remote Access deployment.

PassThru [in]

Returns the remote access load balancer configuration object. By default this cmdlet does not generate any output.

cmdletOutput [out]

  1. List of nodes in the cluster.
  2. Status of each node.
  3. VPN IP address range for each node (if applicable).
  4. Virtual IPs of the cluster.
  5. Status of third-party load balancer.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\RemoteAccess
MOF
RAMgmtPSProvider.mof
DLL
RAMgmtPSProvider.dll

See also

PS_RemoteAccessLoadBalancer