Skip to content

gslb-service

The following operations can be performed on "gslb-service":

rm| unset| stat| rename| add| bind| show| unbind| set|

rm gslb service

Removes a global server load balancing (GSLB) service configured on the appliance.

Synopsis

rm gslb service

Arguments

serviceName Name of the GSLB service.

Example

rm gslb service sj_svc

unset gslb service

Use this command to remove gslb service settings.Refer to the set gslb service command for meanings of the arguments.

Synopsis

unset gslb service [-publicIP] [-publicPort] [-cip] [-cipHeader] [-sitePersistence] [-sitePrefix] [-maxClient] [-healthMonitor] [-maxBandwidth] [-downStateFlush] [-maxAAAUsers] [-monThreshold] [-hashId] [-comment] [-appflowLog] [-naptrOrder] [-naptrPreference] [-naptrServices] [-naptrReplacement] [-naptrDomainTTL]

stat gslb service

Displays the statistical data collected for a global server load balancing (GSLB) service.

Synopsis

stat gslb service [] [-detail] [-fullValues] [-ntimes ] [-logFile ] [-clearstats ( basic | full )]

Arguments

serviceName Name of the GSLB service.

detail Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0

logFile The name of the log file to be used as input.

clearstats Clear the statsistics / counters

Possible values: basic, full

Output

count devno stateflag

Counters

Current Client Est connections (ClntEstConn) Number of client connections in ESTABLISHED state.

IP address (IP) The IP address on which the service is running.

Port (port) The port on which the service is running.

Service type (Type) The service type of this service.Possible values are ADNS, DNS, MYSQL, RTSP, SSL_DIAMETER, ADNS_TCP, DNS_TCP, NNTP, SIP_UDP, SSL_TCP, ANY, FTP, RADIUS, SNMP, TCP, DHCPRA, HTTP, RDP, SSL, TFTP, DIAMETER, MSSQL, RPCSVR, SSL_BRIDGE, UDP

State Current state of the server. There are seven possible values: UP(7), DOWN(1), UNKNOWN(2), BUSY(3), OFS(Out of Service)(4), TROFS(Transition Out of Service)(5), TROFS_DOWN(Down When going Out of Service)(8)

Request bytes (Reqb) Total number of request bytes received on this service or virtual server.

Response bytes (Rspb) Number of response bytes received by this service or virtual server.

Current load on the service (Load) Load on the service that is calculated from the bound load based monitor.

Requests (Req) Total number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)

Responses (Rsp) Number of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)

Current client connections (ClntConn) Number of current client connections.

Current server connections (SvrConn) Number of current connections to the actual servers behind the virtual server.

Service hits (Hits) Number of times that the service has been provided.

Current Server Est connections (SvrEstConn) Number of server connections in ESTABLISHED state.

rename gslb service

Renames a global server load balancing (GSLB) service.

Synopsis

rename gslb service @ @

Arguments

serviceName Existing name of the GSLB service.

newName New name for the GSLB service.

Example

rename gslb service gsl_svc gslb_svc_new

add gslb service

Creates a global server load balancing (GSLB) service.

Synopsis

add gslb service (-cnameEntry | | | | | -publicIP | -publicPort | -sitePersistence | -sitePrefix ) [-maxClient ] [-healthMonitor ( YES | NO )] -siteName [-state ( ENABLED | DISABLED )] [-cip ( ENABLED | DISABLED ) []] [-cookieTimeout ] [-cltTimeout ] [-svrTimeout ] [-maxBandwidth ] [-downStateFlush ( ENABLED | DISABLED )] [-maxAAAUsers ] [-monThreshold ] [-hashId ] [-comment ] [-appflowLog ( ENABLED | DISABLED )] [-naptrReplacement [-naptrDomainTTL ]] [-naptrOrder ] [-naptrServices ] [-naptrPreference ]

Arguments

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').

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.

Possible values: HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, ANY, SIP_UDP, SIP_TCP, SIP_SSL, RADIUS, RDP, RTSP, MYSQL, MSSQL, ORACLE Default value: NSSVC_SERVICE_UNKNOWN

port Port on which the load balancing entity represented by this GSLB service listens. Minimum value: 1

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. Minimum value: 0 Maximum value: 4294967294

healthMonitor Monitor the health of the GSLB service.

Possible values: YES, NO Default value: YES

siteName Name of the GSLB site to which the service belongs.

state Enable or disable the service.

Possible values: ENABLED, DISABLED 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.

Possible values: ENABLED, DISABLED 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 command 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.

Possible values: ConnectionProxy, HTTPRedirect, NONE

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. Minimum value: 0

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.

Possible values: ENABLED, DISABLED

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. Minimum value: 0 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. Minimum value: 0 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

Possible values: ENABLED, DISABLED 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

Example

add gslb service sj_svc 203.12.123.12 http 80 -site san_jos

bind gslb service

Binds a DNS view or a monitor to a global server load balancing (GSLB) service.

Synopsis

bind gslb service ((-viewName ) | (-monitorName @ [-monState ( ENABLED | DISABLED )] [-weight ]))

Arguments

serviceName Name of the GSLB service.

viewName Name of the DNS view of the service. A DNS view is used in global server load balancing (GSLB) to return a predetermined IP address to a specific group of clients, which are identified by using a DNS policy.

viewIP IP address for the specified DNS view.

monitorName Name of the monitor to bind to the GSLB service.

monState Initial state of the GSLB monitor.

Possible values: ENABLED, DISABLED Default value: ENABLED

weight Weight to assign to the monitor-service binding. A larger number specifies a greater weight. Contributes to the monitoring threshold, which determines the state of the service. Default value: 1 Minimum value: 1 Maximum value: 100

Example

bind gslb service -viewName privateview 1.2.3.4

show gslb service

Displays the parameters of all the global server load balancing (GSLB) services configured on the appliance, or the parameters of just the specified service, and statistics related to the service. To display the parameters of all the GSLB services, do not specify a service name.

Synopsis

show gslb service [] show gslb service stats - alias for 'stat gslb service'

Arguments

serviceName Name of the GSLB service.

Output

gslb IPAddress IP address of the service

IP IP address of the service

serverName Name of the server hosting the GSLB service.

serviceType Service type.

port Port number of the service.

publicIP Public ip of the service

publicPort Public port of the service

maxClient Maximum number of clients.

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.

siteName Name of the site to which the service belongs.

svrState Server state.

svrEffGslbState Effective state of the gslb svc

gslbthreshold Indicates if gslb svc has reached threshold

gslbsvcStats Indicates if gslb svc has stats of the primary or the whole chain

state Enable or disable the service.

monitorName Monitor name.

monState State of the monitor bound to gslb service.

cip Indicates if Client IP option is enabled

cipHeader The client IP header used in the HTTP request.

sitePersistence Indicates the type of cookie persistence set

sitePrefix The site prefix string.

cltTimeout Client timeout in seconds.

svrTimeout Server timeout in seconds.

totalfailedprobes The total number of failed probs.

preferredLocation Prefered location.

maxBandwidth Maximum bandwidth.

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.

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

viewName Name of the DNS view of the service. A DNS view is used in global server load balancing (GSLB) to return a predetermined IP address to a specific group of clients, which are identified by using a DNS policy.

viewIP IP address to be used for the given view

weight The Weight of monitor

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.

failedprobes Number of the current failed monitoring probes.

monStatCode The code indicating the monitor response.

monStatParam1 First parameter for use with message code.

monStatParam2 Second parameter for use with message code.

monStatParam3 Third parameter for use with message code.

responseTime Response time of this monitor.

monState The running state of the monitor on this service.

hashId Unique hash identifier for the GSLB service, used by hash based load balancing methods.

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

stateflag stateflag

healthMonitor Monitor the health of the GSLB service.

appflowLog Enable logging appflow flow information

svccfgFlags Contains the information about config info like internal/configured service

monitorTotalProbes Total number of probes sent to monitor this service.

monitorTotalFailedProbes Total number of failed probes

monitorCurrentFailedProbes Total number of currently failed probes

stateChangeTimeSec Time when last state change happened. Seconds part.

ticksSinceLastStateChange Time in 10 millisecond ticks since the last state change.

threshold ClMonOwner Tells the mon owner of the gslb service.

ClMonView Tells the view id of the monitoring owner.

lastresponse Displays the gslb monitor status in string format.

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

naptrPreference An integer specifying the preference of this NAPTR among NAPTR records having same order. lower the number, higher the preference.

naptrServices Service Parameters applicable to this delegation path.

naptrReplacement The replacement domain name for this NAPTR.

naptrDomainTTL Modify the TTL of the internally created naptr domain

gslbsvcHealth This parameter displays effective health of a GSLB service.

glsbsvcHealthdescr Displays the warning message related to health a of GSLB service.

noDefaultBindings to determine if the configuration will have default ssl CIPHER and ECC curve bindings

devno count

Example

show gslb service sj_svc

unbind gslb service

Unbinds a DNS view or a monitor from a global server load balancing (GSLB) service.

Synopsis

unbind gslb service (-viewName | -monitorName @)

Arguments

serviceName Name of the GSLB service.

viewName Name of the DNS view of the service. A DNS view specifies the IP address that must be returned to clients accessing the service from a specific location.

monitorName Name of the monitor to unbind.

Example

unbind gslb service -viewName privateview

set gslb service

Modifies the specified parameters of a global server load balancing (GSLB) service.

Synopsis

set gslb service [-IPAddress ] [-publicIP ] [-publicPort ] [-cip ( ENABLED | DISABLED ) []] [-sitePersistence ] [-sitePrefix ] [-maxClient ] [-healthMonitor ( YES | NO )] [-maxBandwidth ] [-downStateFlush ( ENABLED | DISABLED )] [-maxAAAUsers ] [-viewName ] [-monThreshold ] [-weight ] [-hashId ] [-comment ] [-appflowLog ( ENABLED | DISABLED )] [-naptrOrder ] [-naptrPreference ] [-naptrServices ] [-naptrReplacement [-naptrDomainTTL ]]

Arguments

serviceName Name of the GSLB service.

IPAddress The new IP address of the service.

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. Minimum value: 1

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.

Possible values: ENABLED, DISABLED 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 command 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.

Possible values: ConnectionProxy, HTTPRedirect, NONE

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.

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. Minimum value: 0 Maximum value: 4294967294

healthMonitor Monitor the health of the GSLB service.

Possible values: YES, NO Default value: YES

maxBandwidth Maximum bandwidth. Minimum value: 0

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.

Possible values: ENABLED, DISABLED Default value: ENABLED

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. Minimum value: 0 Maximum value: 65535

viewName Name of the DNS view of the service. A DNS view is used in global server load balancing (GSLB) to return a predetermined IP address to a specific group of clients, which are identified by using a DNS policy.

viewIP IP address to be used for the given view

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. Minimum value: 0 Maximum value: 65535

weight Weight to assign to the monitor-service binding. A larger number specifies a greater weight. Contributes to the monitoring threshold, which determines the state of the service. Minimum value: 1 Maximum value: 100

monitorName Name of the monitor to bind to the service.

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

Possible values: ENABLED, DISABLED Default value: ENABLED

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

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

naptrServices Service Parameters applicable to this delegation path.

naptrReplacement The replacement domain name for this NAPTR.

naptrDomainTTL Modify the TTL of the internally created naptr domain Default value: 3600 Minimum value: 1

Example

set gslb service sj_svc -sitePersistence ConnectionProxy

Was this article helpful?