| addgslbvserver |
Use this method to creates a global server load balancing (GSLB) virtual server. |
Syntax |
Parameters |
name |
Name for the GSLB virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed after the virtual server is created.
CLI Users:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my vserver" or 'my vserver'). This is mandatory parameter. |
servicetype |
Protocol used by services bound to the virtual server. This is mandatory parameter. |
dnsrecordtype |
DNS record type to associate with the GSLB virtual server's domain name. Default value = NSGSLB_A. |
lbmethod |
Load balancing method for the GSLB virtual server. Default value = PEMGMT_LB_LEASTCONNS. |
backuplbmethod |
Backup load balancing method. Becomes operational if the primary load balancing method fails or cannot be used. Valid only if the primary method is based on either round-trip time (RTT) or static proximity. |
netmask |
IPv4 network mask for use in the SOURCEIPHASH load balancing method. Default value = 0xFFFFFFFF. |
v6netmasklen |
Number of bits to consider, in an IPv6 source IP address, for creating the hash that is required by the SOURCEIPHASH load balancing method. Default value = 128. Minimum value = 1. Maximum value = 128. |
rule |
Expression, or name of a named expression, against which traffic is evaluated.
This field is applicable only if gslb method or gslb backup method are set to API.
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. Default value = "none". |
tolerance |
Tolerance in milliseconds. Tolerance value is used in deciding which sites in a GSLB configuration must be considered for implementing the RTT load balancing method. The sites having the RTT value less than or equal to the sum of the lowest RTT and tolerance value are considered. NetScaler implements the round robin method of global server load balancing among these considered sites. The sites that have RTT value greater than this value are not considered. The logic is applied for each LDNS and based on the LDNS, the sites that are considered might change. For example, a site that is considered for requests coming from LDNS1 might not be considered for requests coming from LDNS2. Maximum value = 100. |
persistencetype |
Use source IP address based persistence for the virtual server.
After the load balancing method selects a service for the first packet, the IP address received in response to the DNS query is used for subsequent requests from the same client. |
persistenceid |
The persistence ID for the GSLB virtual server. The ID is a positive integer that enables GSLB sites to identify the GSLB virtual server, and is required if source IP address based or spill over based persistence is enabled on the virtual server. Maximum value = 65535. |
persistmask |
The optional IPv4 network mask applied to IPv4 addresses to establish source IP address based persistence. Default value = 0xFFFFFFFF. |
v6persistmasklen |
Number of bits to consider in an IPv6 source IP address when creating source IP address based persistence sessions. Default value = 128. Minimum value = 1. Maximum value = 128. |
timeout |
Idle time, in minutes, after which a persistence entry is cleared. Default value = 2. Minimum value = 2. Maximum value = 1440. |
edr |
Send clients an empty DNS response when the GSLB virtual server is DOWN. Default value = DISABLED. |
ecs |
If enabled, respond with EDNS Client Subnet (ECS) option in the response for a DNS query with ECS. The ECS address will be used for persistence and spillover persistence (if enabled) instead of the LDNS address. Persistence mask is ignored if ECS is enabled. Default value = DISABLED. |
ecsaddrvalidation |
Validate if ECS address is a private or unroutable address and in such cases, use the LDNS IP. Default value = DISABLED. |
mir |
Include multiple IP addresses in the DNS responses sent to clients. Default value = DISABLED. |
disableprimaryondown |
Continue to direct traffic to the backup chain even after the primary GSLB virtual server returns to the UP state. Used when spillover is configured for the virtual server. Default value = DISABLED. |
dynamicweight |
Specify if the appliance should consider the service count, service weights, or ignore both when using weight-based load balancing methods. The state of the number of services bound to the virtual server help the appliance to select the service. Default value = DISABLED. |
state |
State of the GSLB virtual server. Default value = ENABLED. |
considereffectivestate |
If the primary state of all bound GSLB services is DOWN, consider the effective states of all the GSLB services, obtained through the Metrics Exchange Protocol (MEP), when determining the state of the GSLB virtual server. To consider the effective state, set the parameter to STATE_ONLY. To disregard the effective state, set the parameter to NONE.
The effective state of a GSLB service is the ability of the corresponding virtual server to serve traffic. The effective state of the load balancing virtual server, which is transferred to the GSLB service, is UP even if only one virtual server in the backup chain of virtual servers is in the UP state. Default value = NS_GSLB_DONOT_CONSIDER_BKPS. |
comment |
Any comments that you might want to associate with the GSLB virtual server. |
somethod |
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 GSLB virtual server exceeds the sum of the maximum client (Max Clients) settings for bound GSLB services. Do not specify a spillover threshold for this setting, because the threshold is implied by the Max Clients settings of the bound GSLB services.
* BANDWIDTH - Spillover occurs when the bandwidth consumed by the GSLB virtual server's incoming and outgoing traffic exceeds the threshold.
* HEALTH - Spillover occurs when the percentage of weights of the GSLB services that are UP drops below the threshold. For example, if services gslbSvc1, gslbSvc2, and gslbSvc3 are bound to a virtual server, with weights 1, 2, and 3, and the spillover threshold is 50%, spillover occurs if gslbSvc1 and gslbSvc3 or gslbSvc2 and gslbSvc3 transition to DOWN.
* NONE - Spillover does not occur. |
sopersistence |
If spillover occurs, maintain source IP address based persistence for both primary and backup GSLB virtual servers. Default value = DISABLED. |
sopersistencetimeout |
Timeout for spillover persistence, in minutes. Default value = 2. Minimum value = 2. Maximum value = 1440. |
sothreshold |
Threshold at which spillover occurs. Specify an integer for the CONNECTION spillover method, a bandwidth value in kilobits per second for the BANDWIDTH method (do not enter the units), or a percentage for the HEALTH method (do not enter the percentage symbol). Minimum value = 1. Maximum value = NS_MAX_BW_AND_CLIENT. |
sobackupaction |
Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists |
appflowlog |
Enable logging appflow flow information Default value = ENABLED. |
toggleorder |
Configure this option to toggle order preference Default value = LB_ORDER_ASCENDING. |
orderthreshold |
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. Default value = 0. Maximum value = 100. |
Return Value |
Returns simpleResult |
See Also |