About load balancers

Access Gatewayis most often deployed in a high availability scenario using a load balancer.

Typical Access Gateway Load Balancer Architecture



Load Balancer Configuration

Load balancers:

  • Sticky Sessions, or session affinity: Any load balancer used with Access Gateway must support and enable session affinity or sticky sessions. Session affinity refers to the feature of most load balancing solutions such that second and subsequent requests for a particular session are routed to the same Access Gateway node.
  • Load Balancer Strategy: The preferred strategy for an Access Gateway load balancer is round-robin or weighted round-robin.


When configuring a load balancer, the Admin Access Gateway node is typically not included as part of the worker pool.

Node Health Check


Load balancers must be able to determine if Access Gateway cluster members are healthy.
To perform a health check send an HTTP request with:

Protocol HTTPS
Request GET
IP IP Address of each worker node
With header Host:Your gateway's host

For example:

curl -X GET -v -k -H 'Host:gw.yourhost.com'

  • -X GET - Make a get request
  • -v - Verbose (not require for production)
  • -k - Insecure
  • -H 'Host:gw.{yourgateway.tld}

Which will return a status of 200 on success, 400 or timeout on error.

To determine the value for the Host header variable:

  1. Sign into the Access Gateway Admin Console.
  2. Select Settings
  3. Select the Access Gateway sub-tab.
  4. In the System Configuration section, examine the value of the Access Gateway Hostname field.
    Access Gateway Hostname

Cluster Upgrades and Load Balancers

When upgrading Access Gateway the typical process is:

  1. Backup the configuration.
    For more information see About backup and restore
  2. Secure shell (ssh oag-mgmt@gw.gateway.tld) into the Command Line Management Console for the Admin instance.
  3. Follow the process for upgrading the Access Gateway appliance.
    For more information see Upgrade Access Gateway.
  4. For each Worker node in the Access Gateway High Availability Cluster.
    1. Take the worker node out of the load balancer rotation.
    2. Update the worker node.
    3. Return the worker node to the load balancer rotation.