Load Balancing

Get

Retrieve Parallels RAS LB Settings.

GET/api/LBSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

methodLBMethod (enum)

LBMethod

0 = ResourceBased,1 = RoundRobin

cpuCounterboolean

Whether the CPU counter is enabled or disabled.

memoryCounterboolean

Whether the Memory counter is enabled or disabled.

sessionsCounterboolean

Whether the Sessions counter is enabled or disabled.

reconnectDisconnectboolean

Whether the "Reconnect to disconnected sessions" option is enabled or disabled.

reconnectUsingIPOnlyboolean

Whether the "Reconnect sessions using client's IP address only" option is enabled or disabled.

reconnectUserboolean

Whether the "Limit user to one session per desktop" option is enabled or disabled.

disableRDSLBboolean

Whether the "Disable Microsoft RD Connection Broker" option is enabled or disabled.

deadTimeoutinteger (int32)

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

refreshTimeoutinteger (int32)

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

maxConnectionRequestsinteger (int32)

Maximum number of connection requests for an Agent.

replicateboolean

Whether the "Replicate settings" option (replicate settings to all sites) is enabled or disabled.

siteIdinteger (int32)

The site ID to which the RAS LB settings refer.

Request

JavaScriptCurlPython

const response = await fetch('/api/LBSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "method": [
    "0 = ResourceBased",
    "1 = RoundRobin"
  ],
  "cpuCounter": false,
  "memoryCounter": false,
  "sessionsCounter": false,
  "reconnectDisconnect": false,
  "reconnectUsingIPOnly": false,
  "reconnectUser": false,
  "disableRDSLB": false,
  "replicate": false
}

Update

Modify Parallels RAS LB Settings.

PUT/api/LBSettings

Query parameters

Body

application/json; api-version=1.0

LB settings.

methodLBMethod (enum)

LBMethod

0 = ResourceBased,1 = RoundRobin

cpuCounternullable boolean

Enable or disable the CPU counter.

memoryCounternullable boolean

Enable or disable the Memory counter.

sessionsCounternullable boolean

Enable or disable the Sessions counter.

reconnectDisconnectnullable boolean

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

reconnectUsingIPOnlynullable boolean

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

reconnectUsernullable boolean

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

disableRDSLBnullable boolean

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

deadTimeoutnullable integer (int32)

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

refreshTimeoutnullable integer (int32)

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

replicatenullable boolean

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

maxConnectionRequestsnullable integer (int32)

Maximum number of connection requests for an Agent.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/LBSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}