Home > Configuration > Load Balancing

Use this method to creates an LB action which specifies a selection order for the given client request.

Use this method to adds lb group entity

Use this method to creates a metric table for load monitoring.

Use this method to creates a monitor that you can bind to load balancing services. The monitor periodically sends probes to those services to test their availability.

Use this method to creates an LB policy which specifies requests for which LB decision is taken based on order sequence specified in corresponding LB action

Use this method to creates a user-defined LB policy label, to which you can bind policies.
A policy label is a tool for evaluating a set of policies in a specified order.

Use this method to creates a LB profile.

Use this method to bind the route VIP to the route structure.

Use this method to bind the route VIP to the route structure.

Use this method to creates a load balancing virtual server.

Use this method to add a Work Load Manager.
NOTE: This method is deprecated.
WLM feature has been deprecated from Kos onwards as classic build is not supported.

Use this method to bind policy to lb global.

Use this method to bind vserver to lb group.

Use this method to bind metric to lb metricTable.

Use this method to bind certkey to lb monitor.

Use this method to bind metric to lb monitor.

Use this method to bind servicegroup to lb monitor.

Use this method to bind service to lb monitor.

Use this method to bind policy to lb policylabel.

Use this method to bind analyticsprofile to lb vserver.

Use this method to bind order to lb vserver.

Use this method to bind policy to lb vserver.

Use this method to bind servicegroup to lb vserver.

Use this method to bind service to lb vserver.

Use this method to bind vserver to lb wlm.

Use this method to use this method to clear/flush persistent sessions

Use this method to disable the monitor for a service. If the monitor name is not specified, all monitors bound to the service are disabled.

Use this method to disables a virtual server.

Use this method to enable the monitor that is bound to a specific service. If no monitor name is specified, all monitors bound to the service are enabled.

Use this method to enables a virtual server.

Use this method to get the current settings for the specified LB action.

Use this method to get the list of policies bound to the specified LB global bind point.

Use this method to get the virtual servers bound to the specified group.

Use this method to get the parameters of the specified metric table. If no metric table name is specified, a list of all configured metric tables is displayed.

Use this method to get the services to which this monitor is bound

Use this method to get the parameters of all the monitors configured on the appliance, or the parameters of the specified monitor.

Use this method to get the global load balancing parameters.

Use this method to get all vserver persistent sessions

Use this method to get the current settings for the specified LB policy.',

Use this method to get the current settings for the specified LB policylabel.

Use this method to get the list of lb profile/s in the device

Use this method to get the names of the routes associated to the route structure using the addlbroute method.

Use this method to get the names of the routes associated to the route structure using the addlbroute6 method.

Use this method to get the global SIP parameters.

Use this method to get the statistical data collected for a load balancing virtual server.

Use this method to get Work Load Manager details
NOTE: This method is deprecated.
WLM feature has been deprecated from Kos onwards as classic build is not supported.

Use this method to renames an LB action.

Use this method to renames a load balancing virtual server group.

Use this method to renames the specified LB policy.

Use this method to renames the specified LB policy label.

Use this method to renames a load balancing virtual server.

Use this method to removes the specified LB action.

Use this method to removes the lb group

Use this method to removes a metric table.

Use this method to removes a monitor or a response code for an HTTP monitor. If you do not specify any response codes, the monitor is removed. If you provide any or all of the HTTP response codes that are configured for the monitor, only those specified response codes are removed; the monitor is not removed. Built-in monitors cannot be removed.

Use this method to removes the specified LB policy.

Use this method to removes the specified LB policy label.

Use this method to removes a LB profile from the device.

Use this method to remove the route VIP from the route structure.

Use this method to remove the route VIP from the route structure.

Use this method to removes a virtual server from the Citrix ADC.

Use this method to removes a Work Load Manager.
NOTE: This method is deprecated.
WLM feature has been deprecated from Kos onwards as classic build is not supported.

Use this method to set comment. Any type of information about this LB action.

Use this method to set the selection order list used during lb/gslb decision. Preference of services during lb/gslb decision is as follows - services corresponding to first order specified in the sequence is considered first, services corresponding to second order specified in the sequence is considered next and so on. For example, if -value 2 1 3 is specified here and service-1 bound to a vserver with order 1, service-2 bound to a vserver with order 2 and service-3 bound to a vserver with order 3. Then preference of selecting services in LB decision is as follows: service-2, service-1, service-3.

Use this method to set time period, in minutes, for which backup persistence is in effect.

Use this method to set domain attribute for the HTTP cookie.

Use this method to set use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

Use this method to set when USE_VSERVER_PERSISTENCE is enabled, one can use this setting to designate a member vserver as master which is responsible to create the persistence sessions

Use this method to set type of backup persistence for the group.

Use this method to set type of persistence for the group. Available settings function as follows:
* SOURCEIP - Create persistence sessions based on the client IP.
* COOKIEINSERT - Create persistence sessions based on a cookie in client requests. The cookie is inserted by a Set-Cookie directive from the server, in its first response to a client.
* RULE - Create persistence sessions based on a user defined rule.
* NONE - Disable persistence for the group.

Use this method to set persistence mask to apply to source IPv4 addresses when creating source IP based persistence sessions.

Use this method to set expression, or name of a named expression, against which traffic is evaluated.

The following requirements apply only to the Citrix ADC CLI:
* If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
* If the expression itself includes double quotation marks, escape the quotations by using the \ character.
* Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

Use this method to set time period for which a persistence session is in effect.

Use this method to set use this parameter to enable vserver level persistence on group members. This allows member vservers to have their own persistence, but need to be compatible with other members persistence rules. When this setting is enabled persistence sessions created by any of the members can be shared by other member vservers.

Use this method to set persistence mask to apply to source IPv6 addresses when creating source IP based persistence sessions.

Use this method to set list of Acct-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring message.

Use this method to set action to perform when the response to an inline monitor (a monitor of type HTTP-INLINE) indicates that the service is down. A service monitored by an inline monitor is considered DOWN if the response code is not one of the codes that have been specified for the Response Code parameter.
Available settings function as follows:
* NONE - Do not take any action. However, the show service method and the show lb monitor method indicate the total number of responses that were checked and the number of consecutive error responses received after the last successful probe.
* LOG - Log the event in NSLOG or SYSLOG.
* DOWN - Mark the service as being down, and then do not direct any traffic to the service until the configured down time has expired. Persistent connections to the service are terminated as soon as the service is marked as DOWN. Also, log the event in NSLOG or SYSLOG.

Use this method to set number of consecutive probe failures after which the appliance generates an SNMP trap called monProbeFailed.

Use this method to set name of the application used to determine the state of the service. Applicable to monitors of type CITRIX-XML-SERVICE.

Use this method to set attribute to evaluate when the LDAP server responds to the query. Success or failure of the monitoring probe depends on whether the attribute exists in the response. Optional.

Use this method to set list of Auth-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring CER message.

Use this method to set the base distinguished name of the LDAP service, from where the LDAP server can begin the search for the attributes in the monitoring query. Required for LDAP service monitoring.

Use this method to set the distinguished name with which an LDAP monitor can perform the Bind operation on the LDAP server. Optional. Applicable to LDAP monitors.

Use this method to set custom header string to include in the monitoring probes.

Use this method to set name of the database to connect to during authentication.

Use this method to set iP address of the service to which to send probes. If the parameter is set to 0, the IP address of the server to which the monitor is bound is considered the destination IP address.

Use this method to set tCP or UDP port to which to send the probe. If the parameter is set to 0, the port number of the service to which the monitor is bound is considered the destination port. For a monitor of type USER, however, the destination port is the port number that is included in the HTTP request sent to the dispatcher. Does not apply to monitors of type PING.

Use this method to set time value added to the learned average response time in dynamic response time monitoring (DRTM). When a deviation is specified, the appliance learns the average response time of bound services and adds the deviation to the average. The final value is then continually adjusted to accommodate response time variations over time. Specified in milliseconds, seconds, or minutes.

Use this method to set iP address of the dispatcher to which to send the probe.

Use this method to set port number on which the dispatcher listens for the monitoring probe.

Use this method to set domain in which the XenDesktop Desktop Delivery Controller (DDC) servers or Web Interface servers are present. Required by CITRIX-XD-DDC and CITRIX-WI-EXTENDED monitors for logging on to the DDC servers and Web Interface servers, respectively.

Use this method to set time duration for which to wait before probing a service that has been marked as DOWN. Expressed in milliseconds, seconds, or minutes.

Use this method to set expression that evaluates the database server's response to a MYSQL-ECV or MSSQL-ECV monitoring query. Must produce a Boolean result. The result determines the state of the server. If the expression returns TRUE, the probe succeeds.
For example, if you want the appliance to evaluate the error message to determine the state of the server, use the rule MYSQL.RES.ROW(10) .TEXT_ELEM(2).EQ("MySQL").

Use this method to set number of retries that must fail, out of the number specified for the Retries parameter, for a service to be marked as DOWN. For example, if the Retries parameter is set to 10 and the Failure Retries parameter is set to 6, out of the ten probes sent, at least six probes must fail if the service is to be marked as DOWN. The default value of 0 means that all the retries must fail if the service is to be marked as DOWN.

Use this method to set name of a file on the FTP server. The appliance monitors the FTP service by periodically checking the existence of the file on the server. Applicable to FTP-EXTENDED monitors.

Use this method to set filter criteria for the LDAP query. Optional.

Use this method to set firmware-Revision value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Use this method to set name of a newsgroup available on the NNTP service that is to be monitored. The appliance periodically generates an NNTP query for the name of the newsgroup and evaluates the response. If the newsgroup is found on the server, the service is marked as UP. If the newsgroup does not exist or if the search fails, the service is marked as DOWN. Applicable to NNTP monitors.

Use this method to set option to enable or disable gRPC health check service.

Use this method to set option to specify gRPC service name on which gRPC health check need to be performed

Use this method to set gRPC status codes for which to mark the service as UP. The default value is 12(health check unimplemented). If the gRPC status code 0 is received from the backend this configuration is ignored.

Use this method to set host-IP-Address value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. If Host-IP-Address is not specified, the appliance inserts the mapped IP (MIP) address or subnet IP (SNIP) address from which the CER request (the monitoring probe) is sent.

Use this method to set hostname in the FQDN format (Example: porche.cars.org). Applicable to STOREFRONT monitors.
NOTE: This attribute is deprecated.

Use this method to set hTTP request to send to the server (for example, "HEAD /file.html").

Use this method to set inband-Security-Id for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Use this method to set time interval between two successive probes. Must be greater than the value of Response Time-out.

Use this method to set set of IP addresses expected in the monitoring response from the DNS server, if the record type is A or AAAA. Applicable to DNS monitors.

Use this method to set send the monitoring probe to the service through an IP tunnel. A destination IP address must be specified.

Use this method to set kCD Account used by MSSQL monitor

Use this method to set version number of the Citrix Advanced Access Control Logon Agent. Required by the CITRIX-AAC-LAS monitor.

Use this method to set name of the logon point that is configured for the Citrix Access Gateway Advanced Access Control software. Required if you want to monitor the associated login page or Logon Agent. Applicable to CITRIX-AAC-LAS and CITRIX-AAC-LOGINPAGE monitors.

Use this method to set calculate the least response times for bound services. If this parameter is not enabled, the appliance does not learn the response times of the bound services. Also used for LRTM load balancing.

Use this method to set maximum number of hops that the SIP request used for monitoring can traverse to reach the server. Applicable only to monitors of type SIP-UDP.

Use this method to set metric name in the metric table, whose setting is changed. A value zero disables the metric and it will not be used for load calculation

Use this method to set metric table to which to bind metrics.

Use this method to set client id to be used in Connect method

Use this method to set version of MQTT protocol used in connect message, default is version 3.1.1 [4]

Use this method to set version of MSSQL server that is to be monitored.

Use this method to set name of the network profile.

Use this method to set name of the service identifier that is used to connect to the Oracle database during authentication.

Use this method to set origin-Host value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Use this method to set origin-Realm value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Use this method to set password that is required for logging on to the RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC-ECV or CITRIX-XDM server. Used in conjunction with the user name specified for the User Name parameter.

Use this method to set product-Name value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Use this method to set domain name to resolve as part of monitoring the DNS service (for example, example.com).

Use this method to set type of DNS record for which to send monitoring queries. Set to Address for querying A records, AAAA for querying AAAA records, and Zone for querying the SOA record.

Use this method to set account Session ID to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

Use this method to set account Type to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

Use this method to set called Station Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

Use this method to set source ip with which the packet will go out . Applicable to monitors of type RADIUS_ACCOUNTING.

Use this method to set authentication key (shared secret text string) for RADIUS clients and servers to exchange. Applicable to monitors of type RADIUS and RADIUS_ACCOUNTING.

Use this method to set calling Stations Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

Use this method to set nAS-Identifier to send in the Access-Request packet. Applicable to monitors of type RADIUS.

Use this method to set network Access Server (NAS) IP address to use as the source IP address when monitoring a RADIUS server. Applicable to monitors of type RADIUS and RADIUS_ACCOUNTING.

Use this method to set string expected from the server for the service to be marked as UP. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.

Use this method to set response codes for which to mark the service as UP. For any other response code, the action performed depends on the monitor type. HTTP monitors and RADIUS monitors mark the service as DOWN, while HTTP-INLINE monitors perform the action indicated by the Action parameter.

Use this method to set amount of time for which the appliance must wait before it marks a probe as FAILED. Must be less than the value specified for the Interval parameter.

Note: For UDP-ECV monitors for which a receive string is not configured, response timeout does not apply. For UDP-ECV monitors with no receive string, probe failure is indicated by an ICMP port unreachable error received from the service.

Use this method to set response time threshold, specified as a percentage of the Response Time-out parameter. If the response to a monitor probe has not arrived when the threshold is reached, the appliance generates an SNMP trap called monRespTimeoutAboveThresh. After the response time returns to a value below the threshold, the appliance generates a monRespTimeoutBelowThresh SNMP trap. For the traps to be generated, the "MONITOR-RTO-THRESHOLD" alarm must also be enabled.

Use this method to set maximum number of probes to send to establish the state of a service for which a monitoring probe failed.

Use this method to set mark a service as DOWN, instead of UP, when probe criteria are satisfied, and as UP instead of DOWN when probe criteria are not satisfied.

Use this method to set rTSP request to send to the server (for example, "OPTIONS *").

Use this method to set string of arguments for the script. The string is copied verbatim into the request.

Use this method to set path and name of the script to execute. The script must be available on the Citrix ADC, in the /nsconfig/monitors/ directory.

Use this method to set secondary password that users might have to provide to log on to the Access Gateway server. Applicable to CITRIX-AG monitors.

Use this method to set use a secure SSL connection when monitoring a service. Applicable only to TCP based monitors. The secure option cannot be used with a CITRIX-AG monitor, because a CITRIX-AG monitor uses a secure connection by default.

Use this method to set list of arguments for the script which should be secure

Use this method to set string to send to the service. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.

Use this method to set sIP method to use for the query. Applicable only to monitors of type SIP-UDP.

Use this method to set sIP URI string to send to the service (for example, sip:sip.test). Applicable only to monitors of type SIP-UDP.

Use this method to set uRL of the logon page. For monitors of type CITRIX-WEB-INTERFACE, to monitor a dynamic page under the site path, terminate the site path with a slash (/). Applicable to CITRIX-WEB-INTERFACE, CITRIX-WI-EXTENDED and CITRIX-XDM monitors.

Use this method to set community name for SNMP monitors.

Use this method to set sNMP OID for SNMP monitors.

Use this method to set threshold for SNMP monitors.

Use this method to set sNMP version to be used for SNMP monitors.

Use this method to set sQL query for a MYSQL-ECV or MSSQL-ECV monitor. Sent to the database server after the server authenticates the connection.

Use this method to set sSL Profile associated with the monitor

Use this method to set state of the monitor. The DISABLED setting disables not only the monitor being configured, but all monitors of the same type, until the parameter is set to ENABLED. If the monitor is bound to a service, the state of the monitor is not taken into account when the state of the service is determined.

Use this method to set store the database list populated with the responses to monitor probes. Used in database specific load balancing if MSSQL-ECV/MYSQL-ECV monitor is configured.

Use this method to set enable/Disable probing for Account Service. Applicable only to Store Front monitors. For multi-tenancy configuration users my skip account service

Use this method to set this option will enable monitoring of services running on storefront server. Storefront services are monitored by probing to a Windows service that runs on the Storefront server and exposes details of which storefront services are running.

Use this method to set store Name. For monitors of type STOREFRONT, STORENAME is an optional argument defining storefront service store name. Applicable to STOREFRONT monitors.

Use this method to set number of consecutive successful probes required to transition a service's state from DOWN to UP.

Use this method to set list of Supported-Vendor-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum eight of these AVPs are supported in a monitoring message.

Use this method to set probe the service by encoding the destination IP address in the IP TOS (6) bits.

Use this method to set the TOS ID of the specified destination IP. Applicable only when the TOS parameter is set.

Use this method to set the monitor is bound to a transparent device such as a firewall or router. The state of a transparent device depends on the responsiveness of the services behind it. If a transparent device is being monitored, a destination IP address must be specified. The probe is sent to the specified IP address by using the MAC address of the transparent device.

Use this method to set code expected when the server is under maintenance

Use this method to set string expected from the server for the service to be marked as trofs. Applicable to HTTP-ECV/TCP-ECV monitors.

Use this method to set user name with which to probe the RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC or CITRIX-XDM server.

Use this method to set validate the credentials of the Xen Desktop DDC server user. Applicable to monitors of type CITRIX-XD-DDC.

Use this method to set vendor-Id value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Use this method to set vendor-Id to use in the Vendor-Specific-Application-Id grouped attribute-value pair (AVP) in the monitoring CER message. To specify Auth-Application-Id or Acct-Application-Id in Vendor-Specific-Application-Id, use vendorSpecificAuthApplicationIds or vendorSpecificAcctApplicationIds, respectively. Only one Vendor-Id is supported for all the Vendor-Specific-Application-Id AVPs in a CER monitoring message.

Use this method to set this is used, to enable/disable the option of svc/svcgroup removal, if it is bound to one or more vserver. If it is enabled, the svc/svcgroup can be removed, even if it bound to vservers. If disabled, an error will be thrown, when the user tries to remove a svc/svcgroup without unbinding from its vservers.

Use this method to set computedADCCookieAttribute accepts ns variable as input in form of string starting with $ (to understand how to configure ns variable, please check man add ns variable). policies can be configured to modify this variable for every transaction and the final value of the variable after policy evaluation will be appended as attribute to Citrix ADC cookie (for example: LB cookie persistence , GSLB sitepersistence, CS cookie persistence, LB group cookie persistence). Only one of ComputedADCCookieAttribute, LiteralADCCookieAttribute can be set.

Sample usage -
add ns variable lbvar -type TEXT(100) -scope Transaction
add ns assignment lbassign -variable $lbvar -set "\\";SameSite=Strict\\""
add rewrite policy lbpol lbassign
bind rewrite global lbpol 100 next -type RES_OVERRIDE
set lb param -ComputedADCCookieAttribute "$lbvar"
For incoming client request, if above policy evaluates TRUE, then SameSite=Strict will be appended to ADC generated cookie

Use this method to set to find the service with the fewest connections, the virtual server uses the consolidated connection statistics from all the packet engines. The NO setting allows consideration of only the number of connections on the packet engine that received the new connection.

Use this method to set use this parameter to specify the passphrase used to generate secured persistence cookie value. It specifies the passphrase with a maximum of 31 characters.

Use this method to set specify the TTL for DNS record for domain based service. The default value of ttl is 0 which indicates to use the TTL received in DNS response for monitors

Use this method to set when this option is enabled, MQTT messages of length greater than 64k will be dropped and the client/server connections will be reset.

Use this method to set 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.

Use this method to set this option dictates the hashing algorithm used for hash based LB methods (URLHASH, DOMAINHASH, SOURCEIPHASH, DESTINATIONIPHASH, SRCIPDESTIPHASH, SRCIPSRCPORTHASH, TOKEN, USER_TOKEN, CALLIDHASH).

Use this method to set this option is used to specify the number of fingers to be used in PRAC and JARH algorithms for hash based LB methods. Increasing the number of fingers might give better distribution of traffic at the expense of additional memory

Use this method to set string configured as LiteralADCCookieAttribute will be appended as attribute for Citrix ADC cookie (for example: LB cookie persistence , GSLB site persistence, CS cookie persistence, LB group cookie persistence).

Sample usage -
set lb parameter -LiteralADCCookieAttribute ";SameSite=None"

Use this method to set maximum number of concurrent requests to allow on a single client connection, which is identified by the - tuple. This parameter is applicable to ANY service type and all UDP service types (except DNS) and only when "svrTimeout" is set to zero. A value of 0 (zero) applies no limit to the number of concurrent requests allowed on a single client connection

Use this method to set close monitoring connections by sending the service a connection termination message with the specified bit set.

Use this method to set when a monitor initiates a connection to a service, do not check to determine whether the number of connections to the service has reached the limit specified by the service's Max Clients setting. Enables monitoring to continue even if the service has reached its connection limit.

Use this method to set perform route lookup for traffic received by the Citrix ADC, and forward the traffic according to configured routes. Do not set this parameter if you want a wildcard virtual server to direct packets received by the appliance to an intermediary device, such as a firewall, even if their destination is directly connected to the appliance. Route lookup is performed after the packets have been processed and returned by the intermediary device.

Use this method to set use the ADC location instead of client IP for static proximity LB or GSLB decision.

Use this method to set if enabled, NetScaler will verify the message authenticator and also generate message authenticator if not present.

Use this method to set this option is used to retain the original state of service or servicegroup member when an enable server method is issued.

Use this method to set number of requests, per service, for which to apply the round robin load balancing method before switching to the configured load balancing method, thus allowing services to ramp up gradually to full load. Until the specified number of requests is distributed, the Citrix ADC is said to be implementing the slow start mode (or startup round robin). Implemented for a virtual server when one of the following is true:
* The virtual server is newly created.
* One or more services are newly bound to the virtual server.
* One or more services bound to the virtual server are enabled.
* The load balancing method is changed.
This parameter applies to all the load balancing virtual servers configured on the Citrix ADC, except for those virtual servers for which the virtual server-level slow start parameters (New Service Startup Request Rate and Increment Interval) are configured. If the global slow start parameter and the slow start parameters for a given virtual server are not set, the appliance implements a default slow start for the virtual server, as follows:
* For a newly configured virtual server, the appliance implements slow start for the first 100 requests received by the virtual server.
* For an existing virtual server, if one or more services are newly bound or newly enabled, or if the load balancing method is changed, the appliance dynamically computes the number of requests for which to implement startup round robin. It obtains this number by multiplying the request rate by the number of bound services (it includes services that are marked as DOWN). For example, if the current request rate is 20 requests/s and ten services are bound to the virtual server, the appliance performs startup round robin for 200 requests.
Not applicable to a virtual server for which a hash based load balancing method is configured.

Use this method to set this option allows to store the MQTT clientid and username in transactional logs

Use this method to set action to perform when policy evaluation creates an UNDEF condition. Available settings function as follows:
* NOLBACTION - Does not consider LB action in making LB decision.
* RESET - Reset the request and notify the user, so that the user can resend the request.
* DROP - Drop the request without sending a response to the user.

Use this method to set encode persistence cookie values using SHA2 hash.

Use this method to set include the port number of the service when creating a hash for hash based load balancing methods. With the NO setting, only the IP address of the service is considered when creating a hash.

Use this method to set encode persistence cookie values using SHA2 hash.
NOTE: This attribute is deprecated.
This method is decrepricated in 12.0, instead use UseEncryptedPersistenceCookie

Use this method to set allow a MAC-mode virtual server to accept traffic returned by an intermediary device, such as a firewall, to which the traffic was previously forwarded by another MAC-mode virtual server. The second virtual server can then distribute that traffic across the destination server farm. Also useful when load balancing Branch Repeater appliances.
Note: The second virtual server can also send the traffic to another set of intermediary devices, such as another set of firewalls. If necessary, you can configure multiple MAC-mode virtual servers to pass traffic successively through multiple sets of intermediary devices.

Use this method to set name of action to use if the request matches this LB policy.

Use this method to set any type of information about this LB policy.

Use this method to set name of the messagelog action to use for requests that match this policy.

Use this method to set expression against which traffic is evaluated.

Use this method to set action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Available settings function as follows:
* NOLBACTION - Does not consider LB actions in making LB decision.
* RESET - Reset the request and notify the user, so that the user can resend the request.
* DROP - Drop the request without sending a response to the user.

Use this method to set computedADCCookieAttribute accepts ns variable as input in form of string starting with $ (to understand how to configure ns variable, please check man add ns variable). policies can be configured to modify this variable for every transaction and the final value of the variable after policy evaluation will be appended as attribute to Citrix ADC cookie (for example: LB cookie persistence , GSLB sitepersistence, CS cookie persistence, LB group cookie persistence). Only one of ComputedADCCookieAttribute, LiteralADCCookieAttribute can be set.

Sample usage -
add ns variable lbvar -type TEXT(100) -scope Transaction
add ns assignment lbassign -variable $lbvar -set "\\";SameSite=Strict\\""
add rewrite policy lbpol lbassign
bind rewrite global lbpol 100 next -type RES_OVERRIDE
add lb profile lbprof -ComputedADCCookieAttribute "$lbvar"
For incoming client request, if above policy evaluates TRUE, then SameSite=Strict will be appended to ADC generated cookie

Use this method to set use this parameter to specify the passphrase used to generate secured persistence cookie value. It specifies the passphrase with a maximum of 31 characters.

Use this method to set enable database specific load balancing for MySQL and MSSQL service types.

Use this method to set 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.

Use this method to set this option dictates the hashing algorithm used for hash based LB methods (URLHASH, DOMAINHASH, SOURCEIPHASH, DESTINATIONIPHASH, SRCIPDESTIPHASH, SRCIPSRCPORTHASH, TOKEN, USER_TOKEN, CALLIDHASH).

Use this method to set this option is used to specify the number of fingers to be used in PRAC and JARH algorithms for hash based LB methods. Increasing the number of fingers might give better distribution of traffic at the expense of additional memory.

Use this method to set string configured as LiteralADCCookieAttribute will be appended as attribute for Citrix ADC cookie (for example: LB cookie persistence , GSLB site persistence, CS cookie persistence, LB group cookie persistence).

Sample usage -
add lb profile lbprof -LiteralADCCookieAttribute ";SameSite=None"

Use this method to set by turning on this option packets destined to a vserver in a cluster will not under go any steering. Turn this option for single pa
cket request response mode or when the upstream device is performing a proper RSS for connection based distribution.

Use this method to set use the ADC location instead of client IP for static proximity LB or GSLB decision.

Use this method to set this option allows to store the MQTT clientid and username in transactional logs

Use this method to set encode persistence cookie values using SHA2 hash.

Use this method to set encode persistence cookie values using SHA2 hash.
NOTE: This attribute is deprecated.
This method is decrepricated in 12.0, instead use UseEncryptedPersistenceCookie

Use this method to set add the rport parameter to the VIA headers of SIP requests that virtual servers receive from clients or servers.

Use this method to set time, in seconds, for which a client must wait before initiating a connection after receiving a 503 Service Unavailable response from the SIP server. The time value is sent in the "Retry-After" header in the 503 response.

Use this method to set port number with which to match the destination port in server-initiated SIP traffic. The rport parameter is added, without a value, to SIP packets that have a matching destination port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.

Use this method to set port number with which to match the destination port in server-initiated SIP over SSL traffic. The rport parameter is added, without a value, to SIP packets that have a matching destination port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.

Use this method to set port number with which to match the source port in server-initiated SIP over SSL traffic. The rport parameter is added, without a value, to SIP packets that have a matching source port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.

Use this method to set port number with which to match the source port in server-initiated SIP traffic. The rport parameter is added, without a value, to SIP packets that have a matching source port number, and CALL-ID based persistence is implemented for the responses received by the virtual server.

Use this method to set maximum number of 503 Service Unavailable responses to generate, once every 10 milliseconds, when a SIP virtual server becomes unavailable.

Use this method to set name of the adfsProxy profile to be used to support ADFSPIP protocol for ADFS servers.

Use this method to set the API profile where one or more API specs are bounded to.

Use this method to set apply AppFlow logging to the virtual server.

Use this method to set enable or disable user authentication.

Use this method to set fully qualified domain name (FQDN) of the authentication virtual server to which the user must be redirected for authentication. Make sure that the Authentication parameter is set to ENABLED.

Use this method to set enable or disable user authentication with HTTP 401 responses.

Use this method to set name of the authentication profile to be used when authentication is turned on.

Use this method to set name of an authentication virtual server with which to authenticate users.

Use this method to set time period for which backup persistence is in effect.

Use this method to set name of the backup virtual server to which to forward requests if the primary virtual server goes DOWN or reaches its spillover threshold.

Use this method to set if this option is enabled while resolving DNS64 query AAAA queries are not sent to back end dns server

Use this method to set route cacheable requests to a cache redirection virtual server. The load balancing virtual server can forward requests only to a transparent cache redirection virtual server that has an IP address and port combination of *:80, so such a cache redirection virtual server must be configured on the appliance.

Use this method to set idle time, in seconds, after which a client connection is terminated.

Use this method to set any comments that you might want to associate with the virtual server.

Use this method to set mode in which the connection failover feature must operate for the virtual server. After a failover, established TCP connections and UDP packet flows are kept active and resumed on the secondary appliance. Clients remain connected to the same servers. Available settings function as follows:
* STATEFUL - The primary appliance shares state information with the secondary appliance, in real time, resulting in some runtime processing overhead.
* STATELESS - State information is not shared, and the new primary appliance tries to re-create the packet flow on the basis of the information contained in the packets it receives.
* DISABLED - Connection failover does not occur.

Use this method to set use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

Use this method to set length of the token to be extracted from the data segment of an incoming packet, for use in the token method of load balancing. The length of the token, specified in bytes, must not be greater than 24 KB. Applicable to virtual servers of type TCP.

Use this method to set offset to be considered when extracting a token from the TCP payload. Applicable to virtual servers, of type TCP, using the token method of load balancing. Must be within the first 24 KB of the TCP payload.

Use this method to set name of the DB profile whose settings are to be applied to the virtual server.

Use this method to set enable database specific load balancing for MySQL and MSSQL service types.

Use this method to set if the primary virtual server goes down, do not allow it to return to primary status until manually enabled.

Use this method to set this argument is for enabling/disabling the dns64 on lbvserver

Use this method to set this option is used to enable/disable DNS over HTTPS (DoH) processing.

Use this method to set name of the DNS profile to be associated with the VServer. DNS profile properties will be applied to the transactions processed by a VServer. This parameter is valid only for DNS and DNS-TCP VServers.

Use this method to set flush all active transactions associated with a virtual server whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Use this method to set threshold in percent of active services below which vserver state is made down. If this threshold is 0, vserver state will be up even if one bound service is up.

Use this method to set name of the HTTP profile whose settings are to be applied to the virtual server.

Use this method to set uRL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected.

Use this method to set how the Citrix ADC responds to ping requests received for an IP address that is common to one or more virtual servers. Available settings function as follows:
* If set to PASSIVE on all the virtual servers that share the IP address, the appliance always responds to the ping requests.
* If set to ACTIVE on all the virtual servers that share the IP address, the appliance responds to the ping requests if at least one of the virtual servers is UP. Otherwise, the appliance does not respond.
* If set to ACTIVE on some virtual servers and PASSIVE on the others, the appliance responds if at least one virtual server with the ACTIVE setting is UP. Otherwise, the appliance does not respond.
Note: This parameter is available at the virtual server level. A similar parameter, ICMP Response, is available at the IP address level, for IPv4 addresses of type VIP. To set that parameter, use the add ip method in the CLI or the Create IP dialog box in the GUI.

Use this method to set insert an HTTP header, whose value is the IP address and port number of the virtual server, before forwarding a request to the server. The format of the header is : _, where vipHeader is the name that you specify for the header. If the virtual server has an IPv6 address, the address in the header is enclosed in brackets ([ and ]) to separate it from the port number. If you have mapped an IPv4 address to a virtual server's IPv6 address, the value of this parameter determines which IP address is inserted in the header, as follows:
* VIPADDR - Insert the IP address of the virtual server in the HTTP header regardless of whether the virtual server has an IPv4 address or an IPv6 address. A mapped IPv4 address, if configured, is ignored.
* V6TOV4MAPPING - Insert the IPv4 address that is mapped to the virtual server's IPv6 address. If a mapped IPv4 address is not configured, insert the IPv6 address.
* OFF - Disable header insertion.

Use this method to set iPv4 or IPv6 address to assign to the virtual server.

Use this method to set iP mask, in dotted decimal notation, for the IP Pattern parameter. Can have leading or trailing non-zero octets (for example, 255.255.240.0 or 0.0.255.255). Accordingly, the mask specifies whether the first n bits or the last n bits of the destination IP address in a client request are to be matched with the corresponding bits in the IP pattern. The former is called a forward mask. The latter is called a reverse mask.

Use this method to set iP address pattern, in dotted decimal notation, for identifying packets to be accepted by the virtual server. The IP Mask parameter specifies which part of the destination IP address is matched against the pattern. Mutually exclusive with the IP Address parameter.
For example, if the IP pattern assigned to the virtual server is 198.51.100.0 and the IP mask is 255.255.240.0 (a forward mask), the first 20 bits in the destination IP addresses are matched with the first 20 bits in the pattern. The virtual server accepts requests with IP addresses that range from 198.51.96.1 to 198.51.111.254. You can also use a pattern such as 0.0.2.2 and a mask such as 0.0.255.255 (a reverse mask).
If a destination IP address matches more than one IP pattern, the pattern with the longest match is selected, and the associated virtual server processes the request. For example, if virtual servers vs1 and vs2 have the same IP pattern, 0.0.100.128, but different IP masks of 0.0.255.255 and 0.0.224.255, a destination IP address of 198.51.100.128 has the longest match with the IP pattern of vs1. If a destination IP address matches two or more virtual servers to the same extent, the request is processed by the virtual server whose port number matches the port number in the request.

Use this method to set the list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current lb vserver

Use this method to set use Layer 2 parameters (channel number, MAC address, and VLAN ID) in addition to the 4-tuple (::::) that is used to identify a connection. Allows multiple TCP and non-TCP connections with the same 4-tuple to co-exist on the Citrix ADC.

Use this method to set load balancing method. The available settings function as follows:
* ROUNDROBIN - Distribute requests in rotation, regardless of the load. Weights can be assigned to services to enforce weighted round robin distribution.
* LEASTCONNECTION (default) - Select the service with the fewest connections.
* LEASTRESPONSETIME - Select the service with the lowest average response time.
* LEASTBANDWIDTH - Select the service currently handling the least traffic.
* LEASTPACKETS - Select the service currently serving the lowest number of packets per second.
* CUSTOMLOAD - Base service selection on the SNMP metrics obtained by custom load monitors.
* LRTM - Select the service with the lowest response time. Response times are learned through monitoring probes. This method also takes the number of active connections into account.
Also available are a number of hashing methods, in which the appliance extracts a predetermined portion of the request, creates a hash of the portion, and then checks whether any previous requests had the same hash value. If it finds a match, it forwards the request to the service that served those previous requests. Following are the hashing methods:
* URLHASH - Create a hash of the request URL (or part of the URL).
* DOMAINHASH - Create a hash of the domain name in the request (or part of the domain name). The domain name is taken from either the URL or the Host header. If the domain name appears in both locations, the URL is preferred. If the request does not contain a domain name, the load balancing method defaults to LEASTCONNECTION.
* DESTINATIONIPHASH - Create a hash of the destination IP address in the IP header.
* SOURCEIPHASH - Create a hash of the source IP address in the IP header.
* TOKEN - Extract a token from the request, create a hash of the token, and then select the service to which any previous requests with the same token hash value were sent.
* SRCIPDESTIPHASH - Create a hash of the string obtained by concatenating the source IP address and destination IP address in the IP header.
* SRCIPSRCPORTHASH - Create a hash of the source IP address and source port in the IP header.
* CALLIDHASH - Create a hash of the SIP Call-ID header.
* USER_TOKEN - Same as TOKEN LB method but token needs to be provided from an extension.

Use this method to set name of the LB profile which is associated to the vserver

Use this method to set expression identifying traffic accepted by the virtual server. Can be either an expression (for example, CLIENT.IP.DST.IN_SUBNET(192.0.2.0/24) or the name of a named expression. In the above example, the virtual server accepts all requests whose destination IP address is in the 192.0.2.0/24 subnet.

Use this method to set integer specifying the priority of the listen policy. A higher number specifies a lower priority. If a request matches the listen policies of more than one virtual server the virtual server whose listen policy has the highest priority (the lowest priority number) accepts the request.

Use this method to set redirection mode for load balancing. Available settings function as follows:
* IP - Before forwarding a request to a server, change the destination IP address to the server's IP address.
* MAC - Before forwarding a request to a server, change the destination MAC address to the server's MAC address. The destination IP address is not changed. MAC-based redirection mode is used mostly in firewall load balancing deployments.
* IPTUNNEL - Perform IP-in-IP encapsulation for client IP packets. In the outer IP headers, set the destination IP address to the IP address of the server and the source IP address to the subnet IP (SNIP). The client IP packets are not modified. Applicable to both IPv4 and IPv6 packets.
* TOS - Encode the virtual server's TOS ID in the TOS field of the IP header.
You can use either the IPTUNNEL or the TOS option to implement Direct Server Return (DSR).

Use this method to set this option is used to retain vlan information of incoming packet when macmode is enabled

Use this method to set maximum number of members expected to be present when vserver is used in Autoscale.

Use this method to set minimum number of members expected to be present when vserver is used in Autoscale.

Use this method to set for a load balancing virtual server of type MSSQL, the Microsoft SQL Server version. Set this parameter if you expect some clients to run a version different from the version of the database. This setting provides compatibility between the client-side and server-side connections by ensuring that all communication conforms to the server's version.

Use this method to set character set that the virtual server advertises to clients.

Use this method to set mySQL protocol version that the virtual server advertises to clients.

Use this method to set server capabilities that the virtual server advertises to clients.

Use this method to set mySQL server version string that the virtual server advertises to clients.

Use this method to set name of the network profile to associate with the virtual server. If you set this parameter, the virtual server uses only the IP addresses in the network profile as source IP addresses when initiating connections with servers.

Use this method to set number of requests, or percentage of the load on existing services, by which to increase the load on a new service at each interval in slow-start mode. A non-zero value indicates that slow-start is applicable. A zero value indicates that the global RR startup parameter is applied. Changing the value to zero will cause services currently in slow start to take the full traffic as determined by the LB method. Subsequently, any new services added will use the global RR factor.

Use this method to set interval, in seconds, between successive increments in the load on a new service or a service whose state has just changed from DOWN to UP. A value of 0 (zero) specifies manual slow start.

Use this method to set oracle server version

Use this method to set this option is used to to specify the threshold of minimum number of services to be UP in an order, for it to be considered in Lb decision.

Use this method to set persist AVP number for Diameter Persistency.
In case this AVP is not defined in Base RFC 3588 and it is nested inside a Grouped AVP,
define a sequence of AVP numbers (max 3) in order of parent to child. So say persist AVP number X
is nested inside AVP Y which is nested in Z, then define the list as Z Y X

Use this method to set backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails.

Use this method to set type of persistence for the virtual server. Available settings function as follows:
* SOURCEIP - Connections from the same client IP address belong to the same persistence session.
* COOKIEINSERT - Connections that have the same HTTP Cookie, inserted by a Set-Cookie directive from a server, belong to the same persistence session.
* SSLSESSION - Connections that have the same SSL Session ID belong to the same persistence session.
* CUSTOMSERVERID - Connections with the same server ID form part of the same session. For this persistence type, set the Server ID (CustomServerID) parameter for each service and configure the Rule parameter to identify the server ID in a request.
* RULE - All connections that match a user defined rule belong to the same persistence session.
* URLPASSIVE - Requests that have the same server ID in the URL query belong to the same persistence session. The server ID is the hexadecimal representation of the IP address and port of the service to which the request must be forwarded. This persistence type requires a rule to identify the server ID in the request.
* DESTIP - Connections to the same destination IP address belong to the same persistence session.
* SRCIPDESTIP - Connections that have the same source IP address and destination IP address belong to the same persistence session.
* CALLID - Connections that have the same CALL-ID SIP header belong to the same persistence session.
* RTSPSID - Connections that have the same RTSP Session ID belong to the same persistence session.
* FIXSESSION - Connections that have the same SenderCompID and TargetCompID values belong to the same persistence session.
* USERSESSION - Persistence session is created based on the persistence parameter value provided from an extension.

Use this method to set persistence mask for IP based persistence types, for IPv4 virtual servers.

Use this method to set citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring

Use this method to set citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck

Use this method to set by turning on this option packets destined to a vserver in a cluster will not under go any steering. Turn this option for single packet request response mode or when the upstream device is performing a proper RSS for connection based distribution.

Use this method to set process traffic with the push virtual server that is bound to this load balancing virtual server.

Use this method to set expression for extracting a label from the server's response. Can be either an expression or the name of a named expression.

Use this method to set allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates.

Use this method to set name of the load balancing virtual server, of type PUSH or SSL_PUSH, to which the server pushes updates received on the load balancing virtual server that you are configuring.

Use this method to set name of the QUIC Bridge profile whose settings are to be applied to the virtual server.

Use this method to set name of QUIC profile which will be attached to the VServer.

Use this method to set when set to YES, this option causes the DNS replies from this vserver to have the RA bit turned on. Typically one would set this option to YES, when the vserver is load balancing a set of DNS servers thatsupport recursive queries.

Use this method to set port number for the virtual server, from which we absorb the traffic for http redirect

Use this method to set rewrite the port and change the protocol to ensure successful HTTP redirects from services.

Use this method to set uRL to which to redirect traffic if the virtual server becomes unavailable.
WARNING! Make sure that the domain in the URL does not match the domain specified for a content switching policy. If it does, requests are continuously redirected to the unavailable virtual server.

Use this method to set expression specifying which part of a server's response to use for creating rule based persistence sessions (persistence type RULE). Can be either an expression or the name of a named expression.
Example:
HTTP.RES.HEADER("setcookie").VALUE(0).TYPECAST_NVLIST_T('=',';').VALUE("server1").

Use this method to set this option enables you to retain existing connections on a node joining a Cluster system or when a node is being configured for passive timeout. By default, this option is disabled.

Use this method to set route Health Injection (RHI) functionality of the NetSaler appliance for advertising the route of the VIP address associated with the virtual server. When Vserver RHI Level (RHI) parameter is set to VSVR_CNTRLD, the following are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE) settings on the virtual servers associated with the VIP address:
* If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always advertises the route for the VIP address.
* If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state.
* If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state.

Use this method to set use network address translation (NAT) for RTSP data connections.

Use this method to set expression, or name of a named expression, against which traffic is evaluated.
The following requirements apply only to the Citrix ADC CLI:
* If the expression includes one or more spaces, enclose the entire expression in double quotation marks.
* If the expression itself includes double quotation marks, escape the quotations by using the \ character.
* Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

Use this method to set service to bind to the virtual server.

Use this method to set perform load balancing on a per-packet basis, without establishing sessions. Recommended for load balancing of intrusion detection system (IDS) servers and scenarios involving direct server return (DSR), where session information is unnecessary.

Use this method to set this argument decides the behavior incase the service which is selected from an existing persistence session has reached threshold.

Use this method to set action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists

Use this method to set type of threshold that, when exceeded, triggers spillover. Available settings function as follows:
* CONNECTION - Spillover occurs when the number of client connections exceeds the threshold.
* DYNAMICCONNECTION - Spillover occurs when the number of client connections at the virtual server exceeds the sum of the maximum client (Max Clients) settings for bound services. Do not specify a spillover threshold for this setting, because the threshold is implied by the Max Clients settings of bound services.
* BANDWIDTH - Spillover occurs when the bandwidth consumed by the virtual server's incoming and outgoing traffic exceeds the threshold.
* HEALTH - Spillover occurs when the percentage of weights of the services that are UP drops below the threshold. For example, if services svc1, svc2, and svc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover threshold is 50%, spillover occurs if svc1 and svc3 or svc2 and svc3 transition to DOWN.
* NONE - Spillover does not occur.

Use this method to set if spillover occurs, maintain source IP address based persistence for both primary and backup virtual servers.

Use this method to set timeout for spillover persistence, in minutes.

Use this method to set port number for external TCP probe. NetScaler provides support for external TCP health check of the vserver status over the selected port. This option is only supported for vservers assigned with an IPAddress or ipset.
NOTE: This attribute is deprecated.
The functionality is intact, but we advise to use -probePort and -probeProtocol options

Use this method to set name of the TCP profile whose settings are to be applied to the virtual server.

Use this method to set time period for which a persistence session is in effect.

Use this method to set configure this option to toggle order preference

Use this method to set tOS ID of the virtual server. Applicable only when the load balancing redirection mode is set to TOS.

Use this method to set when value is ENABLED, Trofs persistence is honored. When value is DISABLED, Trofs persistence is not honored.

Use this method to set persistence mask for IP based persistence types, for IPv6 virtual servers.

Use this method to set the idle time period after which Citrix ADC would probe the WLM. The value ranges from 1 to 1440 minutes.

Use this method to unbind policy from lb global.

Use this method to unbind vserver from lb group.

Use this method to unbind metric from lb metricTable.

Use this method to unbind certkey from lb monitor.

Use this method to unbind metric from lb monitor.

Use this method to unbind servicegroup from lb monitor.

Use this method to unbind service from lb monitor.

Use this method to unbind policy from lb policylabel.

Use this method to unbind analyticsprofile from lb vserver.

Use this method to unbind policy from lb vserver.

Use this method to unbind priority from lb vserver.

Use this method to unbind servicegroup from lb vserver.

Use this method to unbind service from lb vserver.

Use this method to unbind vserver from lb wlm.

Remove lb action comment setting.

Remove lb group backuppersistencetimeout setting.

Remove lb group cookiedomain setting.

Remove lb group cookie setting.

Remove lb group mastervserver setting.

Remove lb group persistencebackup setting.

Remove lb group persistencetype setting.

Remove lb group persistmask setting.

Remove lb group rule setting.

Remove lb group timeout setting.

Remove lb group usevserverpersistency setting.

Remove lb group v6persistmasklen setting.

Remove lb monitor acctapplicationid setting.

Remove lb monitor action setting.

Remove lb monitor alertretries setting.

Remove lb monitor attribute setting.

Remove lb monitor authapplicationid setting.

Remove lb monitor basedn setting.

Remove lb monitor binddn setting.

Remove lb monitor customheaders setting.

Remove lb monitor database setting.

Remove lb monitor destip setting.

Remove lb monitor destport setting.

Remove lb monitor deviation setting.

Remove lb monitor dispatcherip setting.

Remove lb monitor dispatcherport setting.

Remove lb monitor domain setting.

Remove lb monitor downtime setting.

Remove lb monitor failureretries setting.

Remove lb monitor file setting.

Remove lb monitor filter setting.

Remove lb monitor firmwarerevision setting.

Remove lb monitor group setting.

Remove lb monitor grpchealthcheck setting.

Remove lb monitor grpcservice setting.

Remove lb monitor grpcstatuscode setting.

Remove lb monitor hostipaddress setting.

Remove lb monitor httprequest setting.

Remove lb monitor inbandsecurityid setting.

Remove lb monitor interval setting.

Remove lb monitor ipaddress setting.

Remove lb monitor iptunnel setting.

Remove lb monitor kcdaccount setting.

Remove lb monitor lasversion setting.

Remove lb monitor logonpoint setting.

Remove lb monitor lrtm setting.

Remove lb monitor maxforwards setting.

Remove lb monitor metrictable setting.

Remove lb monitor mqttclientidentifier setting.

Remove lb monitor mqttversion setting.

Remove lb monitor mssqlprotocolversion setting.

Remove lb monitor netprofile setting.

Remove lb monitor oraclesid setting.

Remove lb monitor originhost setting.

Remove lb monitor originrealm setting.

Remove lb monitor password setting.

Remove lb monitor product setting.

Remove lb monitor query setting.

Remove lb monitor querytype setting.

Remove lb monitor radaccountsession setting.

Remove lb monitor radaccounttype setting.

Remove lb monitor radapn setting.

Remove lb monitor radframedip setting.

Remove lb monitor radkey setting.

Remove lb monitor radmsisdn setting.

Remove lb monitor radnasid setting.

Remove lb monitor radnasip setting.

Remove lb monitor recv setting.

Remove lb monitor respcode setting.

Remove lb monitor resptimeout setting.

Remove lb monitor resptimeoutthresh setting.

Remove lb monitor retries setting.

Remove lb monitor reverse setting.

Remove lb monitor rtsprequest setting.

Remove lb monitor scriptargs setting.

Remove lb monitor script setting.

Remove lb monitor secondarypassword setting.

Remove lb monitor secure setting.

Remove lb monitor secureargs setting.

Remove lb monitor send setting.

Remove lb monitor sipmethod setting.

Remove lb monitor sipreguri setting.

Remove lb monitor snmpcommunity setting.

Remove lb monitor snmpoid setting.

Remove lb monitor snmpthreshold setting.

Remove lb monitor snmpversion setting.

Remove lb monitor sqlquery setting.

Remove lb monitor sslprofile setting.

Remove lb monitor state setting.

Remove lb monitor storedb setting.

Remove lb monitor successretries setting.

Remove lb monitor supportedvendorids setting.

Remove lb monitor tos setting.

Remove lb monitor tosid setting.

Remove lb monitor transparent setting.

Remove lb monitor trofscode setting.

Remove lb monitor trofsstring setting.

Remove lb monitor user setting.

Remove lb monitor validatecred setting.

Remove lb monitor vendorid setting.

Remove lb monitor vendorspecificacctapplicationids setting.

Remove lb monitor vendorspecificauthapplicationids setting.

Remove lb monitor vendorspecificvendorid setting.

Remove lb parameter allowboundsvcremoval setting.

Remove lb parameter computedadccookieattribute setting.

Remove lb parameter consolidatedlconn setting.

Remove lb parameter cookiepassphrase setting.

Remove lb parameter dbsttl setting.

Remove lb parameter dropmqttjumbomessage setting.

Remove lb parameter httponlycookieflag setting.

Remove lb parameter lbhashalgorithm setting.

Remove lb parameter lbhashfingers setting.

Remove lb parameter literaladccookieattribute setting.

Remove lb parameter maxpipelinenat setting.

Remove lb parameter monitorconnectionclose setting.

Remove lb parameter monitorskipmaxclient setting.

Remove lb parameter preferdirectroute setting.

Remove lb parameter proximityfromself setting.

Remove lb parameter radiusmessageauthenticator setting.

Remove lb parameter retainservicestate setting.

Remove lb parameter startuprrfactor setting.

Remove lb parameter storemqttclientidanduser setting.

Remove lb parameter undefaction setting.

Remove lb parameter useencryptedpersistencecookie setting.

Remove lb parameter useportforhashlb setting.

Remove lb parameter usesecuredpersistencecookie setting.

Remove lb parameter vserverspecificmac setting.

Remove lb policy comment setting.

Remove lb policy logaction setting.

Remove lb policy undefaction setting.

Remove lb profile computedadccookieattribute setting.

Remove lb profile cookiepassphrase setting.

Remove lb profile dbslb setting.

Remove lb profile httponlycookieflag setting.

Remove lb profile lbhashalgorithm setting.

Remove lb profile lbhashfingers setting.

Remove lb profile literaladccookieattribute setting.

Remove lb profile processlocal setting.

Remove lb profile proximityfromself setting.

Remove lb profile storemqttclientidanduser setting.

Remove lb profile useencryptedpersistencecookie setting.

Remove lb profile usesecuredpersistencecookie setting.

Remove lb sipParameters addrportvip setting.

Remove lb sipParameters retrydur setting.

Remove lb sipParameters rnatdstport setting.

Remove lb sipParameters rnatsecuredstport setting.

Remove lb sipParameters rnatsecuresrcport setting.

Remove lb sipParameters rnatsrcport setting.

Remove lb sipParameters sip503ratethreshold setting.

Remove lb vserver adfsproxyprofile setting.

Remove lb vserver apiprofile setting.

Remove lb vserver appflowlog setting.

Remove lb vserver authentication setting.

Remove lb vserver authenticationhost setting.

Remove lb vserver authn401 setting.

Remove lb vserver authnprofile setting.

Remove lb vserver authnvs setting.

Remove lb vserver backuplbmethod setting.

Remove lb vserver backuppersistencetimeout setting.

Remove lb vserver backupvserver setting.

Remove lb vserver cacheable setting.

Remove lb vserver clttimeout setting.

Remove lb vserver comment setting.

Remove lb vserver connfailover setting.

Remove lb vserver cookie setting.

Remove lb vserver datalength setting.

Remove lb vserver dataoffset setting.

Remove lb vserver dbprofile setting.

Remove lb vserver dbslb setting.

Remove lb vserver disableprimaryondown setting.

Remove lb vserver dnsoverhttps setting.

Remove lb vserver dnsprofile setting.

Remove lb vserver downstateflush setting.

Remove lb vserver hashlength setting.

Remove lb vserver healththreshold setting.

Remove lb vserver httpprofile setting.

Remove lb vserver httpsredirecturl setting.

Remove lb vserver icmpvsrresponse setting.

Remove lb vserver insertvserveripport setting.

Remove lb vserver ipset setting.

Remove lb vserver l2conn setting.

Remove lb vserver lbmethod setting.

Remove lb vserver lbprofile setting.

Remove lb vserver listenpolicy setting.

Remove lb vserver listenpriority setting.

Remove lb vserver m setting.

Remove lb vserver macmoderetainvlan setting.

Remove lb vserver maxautoscalemembers setting.

Remove lb vserver minautoscalemembers setting.

Remove lb vserver mssqlserverversion setting.

Remove lb vserver mysqlcharacterset setting.

Remove lb vserver mysqlprotocolversion setting.

Remove lb vserver mysqlservercapabilities setting.

Remove lb vserver mysqlserverversion setting.

Remove lb vserver netmask setting.

Remove lb vserver netprofile setting.

Remove lb vserver newservicerequest setting.

Remove lb vserver newservicerequestincrementinterval setting.

Remove lb vserver newservicerequestunit setting.

Remove lb vserver oracleserverversion setting.

Remove lb vserver orderthreshold setting.

Remove lb vserver persistavpno setting.

Remove lb vserver persistencebackup setting.

Remove lb vserver persistencetype setting.

Remove lb vserver persistmask setting.

Remove lb vserver probeprotocol setting.

Remove lb vserver probesuccessresponsecode setting.

Remove lb vserver push setting.

Remove lb vserver pushlabel setting.

Remove lb vserver pushmulticlients setting.

Remove lb vserver pushvserver setting.

Remove lb vserver quicbridgeprofile setting.

Remove lb vserver quicprofile setting.

Remove lb vserver recursionavailable setting.

Remove lb vserver redirectfromport setting.

Remove lb vserver redirectportrewrite setting.

Remove lb vserver redirecturl setting.

Remove lb vserver redirecturl setting.

Remove lb vserver resrule setting.

Remove lb vserver retainconnectionsoncluster setting.

Remove lb vserver rhistate setting.

Remove lb vserver rtspnat setting.

Remove lb vserver rule setting.

Remove lb vserver service setting.

Remove lb vserver sessionless setting.

Remove lb vserver skippersistency setting.

Remove lb vserver sobackupaction setting.

Remove lb vserver somethod setting.

Remove lb vserver sopersistence setting.

Remove lb vserver sopersistencetimeout setting.

Remove lb vserver sothreshold setting.

Remove lb vserver tcpprobeport setting.

Remove lb vserver tcpprofile setting.

Remove lb vserver timeout setting.

Remove lb vserver toggleorder setting.

Remove lb vserver tosid setting.

Remove lb vserver trofspersistence setting.

Remove lb vserver v6netmasklen setting.

Remove lb vserver v6persistmasklen setting.

Remove lb vserver vipheader setting.

Remove lb wlm katimeout setting.