Configure access pool load balancing

Edit online

Configure load balancing on an existing access pool in the system.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Configure access pool load balancing API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online
POST /manager/api/{apiResponseType}/1.0/configureAccessPoolLoadBalancing.adm HTTP/1.1 Host:{manager.dsnet} 
    id={id-number}&loadBalancingEnabled=true&autonomousSystemNumber={system-number}
    &routerAutonomousSystemNumber={router-number}&automaticRemovalEnabled={true|false}
    &bfdEnabled={true|false}&bfdInterval={number-milliseconds}&bfdMultiplier={number-multiplier}
    &virtualIps={ip-numbers}&virtualIpMap[{map-ip-numbers]={add|remove}&routerIps={router-ip-numbers}
    &routerIpMap[{map-router-ip-numbers]={add|remove}

Curl method

Edit online
curl -u {admin}:{password} 
-k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/configureAccessPoolLoadBalancing.adm" 
-d "id={id-number}&loadBalancingEnabled=true&autonomousSystemNumber={system-number}
    &routerAutonomousSystemNumber={router-number}&automaticRemovalEnabled={true|false}
    &bfdEnabled={true|false}&bfdInterval={number-milliseconds}&bfdMultiplier={number-multiplier}
    &virtualIps={ip-numbers}&virtualIpMap[{map-ip-numbers]={add|remove}&routerIps={router-ip-numbers}
    &routerIpMap[{map-router-ip-numbers]={add|remove}"

Parameters

Edit online
Table 2. Request Parameters for Configure Access Pool Load Balancing (configureAccessPoolLoadBalancing) API method
Parameter Type Usage Default Description
id Long Required  

Manager-generated ID of an access pool.
loadBalancingEnabled Boolean Optional  

Enable load balancing on the access pool.
autonomousSystemNumber Integer Optional  

Autonomous System Number (ASN) for this access pool.
routerAutonomousSystemNumber Integer Optional  

Autonomous System Number (ASN) for the router.
automaticRemovalEnabled Boolean Optional  

Accesser removal from VIP type.
bfdEnabled Boolean Optional  

Enable bidirectional forwarding detection.
bfdInterval Integer Optional  

The bidirectional forwarding detection interval in milliseconds.
bfdMultiplier Integer Optional  

The bidirectional forwarding detection multiplier.
virtualIps List Optional  

A list of virtual IP addresses.
virtualIpMap Map Optional  

Map of virtual IP addresses, to either add or remove. This should not be provided along with virtualIps.
routerIps List Optional  

A list of router IP addresses.
routerIpMap Map Optional  

Map of router IP addresses, to either add or remove. This should not be provided along with routerIps.