addgslbservice

Use this method to creates a global server load balancing (GSLB) service.

Syntax



Parameters

servicename

Name for the GSLB service. 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 GSLB service is created. CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my gslbsvc" or 'my gslbsvc').
This is mandatory parameter.

cnameentry

Canonical name of the GSLB service. Used in CNAME-based GSLB.

ip

IP address for the GSLB service. Should represent a load balancing, content switching, or VPN virtual server on the Citrix ADC, or the IP address of another load balancing device.

servername

Name of the server hosting the GSLB service.

servicetype

Type of service to create.
Default value = NSSVC_SERVICE_UNKNOWN.

port

Port on which the load balancing entity represented by this GSLB service listens.
Minimum value = 1.
Range 1 - 65535.

publicip

The public IP address that a NAT device translates to the GSLB service's private IP address. Optional.

publicport

The public port associated with the GSLB service's public IP address. The port is mapped to the service's private port number. Applicable to the local GSLB service. Optional.

maxclient

The maximum number of open connections that the service can support at any given time. A GSLB service whose connection count reaches the maximum is not considered when a GSLB decision is made, until the connection count drops below the maximum.
Maximum value = NS_MAX_MAXCLIENT.

healthmonitor

Monitor the health of the GSLB service.
Default value = YES.

sitename

Name of the GSLB site to which the service belongs.
This is mandatory parameter.

state

Enable or disable the service.
Default value = ENABLED.

cip

In the request that is forwarded to the GSLB service, insert a header that stores the client's IP address. Client IP header insertion is used in connection-proxy based site persistence.
Default value = DISABLED.

cipheader

Name for the HTTP header that stores the client's IP address. Used with the Client IP option. If client IP header insertion is enabled on the service and a name is not specified for the header, the Citrix ADC uses the name specified by the cipHeader parameter in the set ns param method or, in the GUI, the Client IP Header parameter in the Configure HTTP Parameters dialog box.

sitepersistence

Use cookie-based site persistence. Applicable only to HTTP and SSL GSLB services.

cookietimeout

Timeout value, in minutes, for the cookie, when cookie based site persistence is enabled.
Maximum value = 1440.

siteprefix

The site's prefix string. When the service is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound service-domain pair by concatenating the site prefix of the service and the name of the domain. If the special string NONE is specified, the site-prefix string is unset. When implementing HTTP redirect site persistence, the Citrix ADC redirects GSLB requests to GSLB services by using their site domains.

clttimeout

Idle time, in seconds, after which a client connection is terminated. Applicable if connection proxy based site persistence is used.
Maximum value = 31536000.

svrtimeout

Idle time, in seconds, after which a server connection is terminated. Applicable if connection proxy based site persistence is used.
Maximum value = 31536000.

maxbandwidth

Integer specifying the maximum bandwidth allowed for the service. A GSLB service whose bandwidth reaches the maximum is not considered when a GSLB decision is made, until its bandwidth consumption drops below the maximum.

downstateflush

Flush all active transactions associated with the GSLB service when its state transitions from UP to DOWN. Do not enable this option for services that must complete their transactions. Applicable if connection proxy based site persistence is used.

maxaaausers

Maximum number of SSL VPN users that can be logged on concurrently to the VPN virtual server that is represented by this GSLB service. A GSLB service whose user count reaches the maximum is not considered when a GSLB decision is made, until the count drops below the maximum.
Maximum value = 65535.

monthreshold

Monitoring threshold value for the GSLB service. If the sum of the weights of the monitors that are bound to this GSLB service and are in the UP state is not equal to or greater than this threshold value, the service is marked as DOWN.
Maximum value = 65535.

hashid

Unique hash identifier for the GSLB service, used by hash based load balancing methods.
Minimum value = 1.

comment

Any comments that you might want to associate with the GSLB service.

appflowlog

Enable logging appflow flow information
Default value = ENABLED.

naptrreplacement

The replacement domain name for this NAPTR.

naptrorder

An integer specifying the order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of Rules. The ordering is from lowest to highest
Default value = 1.
Minimum value = 1.
Maximum value = 65535.

naptrservices

Service Parameters applicable to this delegation path.

naptrdomainttl

Modify the TTL of the internally created naptr domain
Default value = 3600.
Minimum value = 1.

naptrpreference

An integer specifying the preference of this NAPTR among NAPTR records having same order. lower the number, higher the preference.
Default value = 1.
Minimum value = 1.
Maximum value = 65535.

Return Value

Returns simpleResult

See Also