Load Balancing

Get

get

Retrieve Parallels RAS LB Settings.

Query parameters
siteIdinteger · int32Optional

The Site ID for which to retrieve the Parallels RAS LB settings. (optional)

Responses
200

Success

application/json; api-version=1.0
get
/api/LBSettings

Update

put

Modify Parallels RAS LB Settings.

Query parameters
siteIdinteger · int32Optional

The Site ID for which to modify the Parallels RAS LB settings. (optional)

Body

Update the RAS Load Balancing settings

methodstring · enumOptional

LBMethod

Possible values:
cpuCounterboolean | nullableOptional

Enable or disable the CPU counter.

memoryCounterboolean | nullableOptional

Enable or disable the Memory counter.

sessionsCounterboolean | nullableOptional

Enable or disable the Sessions counter.

reconnectDisconnectboolean | nullableOptional

Enable or disable the "Reconnect to disconnected sessions" option.

reconnectUsingIPOnlyboolean | nullableOptional

Enable or disable the "Reconnect sessions using client's IP address only" option.

reconnectUserboolean | nullableOptional

Enable or disable the "Limit user to one session per desktop" option.

disableRDSLBboolean | nullableOptional

Enable or disable the "Disable Microsoft RD Connection Broker" option.

deadTimeoutinteger · int32 | nullableOptional

Set the value (number of seconds) of the "Declare Agent dead if not responding for" property.

refreshTimeoutinteger · int32 | nullableOptional

Set the value (number of seconds) of the "Agent Refresh Time" property.

replicateboolean | nullableOptional

Enable or disable the "Replicate settings" option (replicate settings to all sites).

enableCPULBboolean | nullableOptionalDeprecated

Enable or disable the "CPU Load Balancer" option. Deprecated: use 'Set-RASCPUOptimizationSettings -EnableCPUOptimization $true' to enable CPU Load Balancer.

maxConnectionRequestsinteger · int32 | nullableOptional

Maximum number of connection requests for an Agent.

Responses
put
/api/LBSettings

No content

Was this helpful?