Product Documentation

Support for Load Balancing Profile

Apr 27, 2017

A load balancing configuration has a large number of parameters, so setting the same parameters on a number of virtual servers can become tedious. From release 11.1, a load balancing (LB) profile makes this task easier. You can now set load balancing parameters in a profile and associate this profile with virtual servers, instead of setting these parameters on each virtual server.

The following parameters are presently supported in an LB profile:

  • HTTPonlyflag—Include the HttpOnly attribute in persistence cookies. The HttpOnly attribute limits the scope of a cookie to HTTP requests and helps mitigate the risk of cross-site scripting attacks.
  • UseSecuredPersistenceCookie—Encrypt the persistence cookie values by using a SHA2 hash algorithm.
  • Cookiepassphrase—Specify the passphrase used to generate a secured persistence cookie value.
  • DBS_LB—Enable database specific load balancing for MySQL and MSSQL service types.
  • Cl_process_local—Packets destined to a virtual server in a cluster are not steered. Enable option for single packet request response mode or when the upstream device is performing a proper RSS for connection based distribution.


You can set DBS_LB and Cl_process_local parameters on a virtual server and in the profile. If you enable these parameters on a virtual server and then set a profile to this virtual server, the parameters appear as disabled in the output of the "show lb vserver" command for that virtual server. Check the profile to see the actual status of these parameters. In addition, if you set and then unset a profile to a virtual server, the parameters  will be set with default values for that virtual server. 

To create an LB profile by using the NetScaler command line

At the command prompt, type:

add lb profile <lbprofilename> -dbsLb ( ENABLED | DISABLED ) -processLocal ( ENABLED | DISABLED ) -httpOnlyCookieFlag ( ENABLED | DISABLED ) -cookiePassphrase -useSecuredPersistenceCookieENABLED | DISABLED )

Example Copy

> add lb profile p1


> show lb profile p1

        LB Profile name:                 p1

        DBS LB : DISABLED        Process Local: DISABLED

        Persistence Cookie HttpOnly Flag: ENABLED

        Use Secured Persistence Cookie Flag: DISABLED

        No of vservers bound: 0


To create an LB profile by using the NetScaler GUI

Navigate to System > Profiles > LB Profile, and add a profile.

To associate an LB profile with an LB virtual server by using the NetScaler command line

At the command prompt, type:

set lb vserver <name> -lbprofilename <string>


Example Copy

> set lbvserver lbvip1 -lbprofile p1


> sh lb vserver lbvip1

        lbvip1 ( - HTTP       Type: ADDRESS

        State: UP

        Last state change was at Wed May 25 12:36:20 2016

        Time since last state change: 0 days, 00:01:26.140

        Effective State: UP  ARP:DISABLED

        Client Idle Timeout: 180 sec

        Down state flush: ENABLED

        Disable Primary Vserver On Down : DISABLED

        Appflow logging: ENABLED

        Port Rewrite : DISABLED

        No. of Bound Services :  2 (Total)       2 (Active)

        Configured Method: LEASTCONNECTION      BackupMethod: ROUNDROBIN

        Mode: IP

        Persistence: NONE

        Vserver IP and Port insertion: OFF

        Push: DISABLED  Push VServer:

        Push Multi Clients: NO

        Push Label Rule: none

        L2Conn: OFF

        Skip Persistency: None

        Listen Policy: NONE

        IcmpResponse: PASSIVE

        RHIstate: PASSIVE

        New Service Startup Request Rate: 0 PER_SECOND, Increment Interval: 0

        Mac mode Retain Vlan: DISABLED


        Process Local: DISABLED

        Traffic Domain: 0

        LB Profile: p1


To associate an LB profile with an LB virtual server by using the NetScaler GUI

  1. Navigate to Traffic Management > Load Balancing > Virtual Servers.
  2. Select a virtual server, and click Edit.
  3. In Advanced Settings, click Profiles.
  4. In the LB Profile list, select the profile to associate with this virtual server.