gslb-serviceGroup¶

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

add gslb serviceGroup¶

Creates a GSLB service group. You can group similar services into a GSLB service group and use them as a single entity.

Synopsis¶

add gslb serviceGroup <serviceGroupName>@ <serviceType> [-maxClient <positive_integer>] [-cip ( ENABLED | DISABLED ) [<cipHeader>]] [-healthMonitor ( YES | NO )] [-cltTimeout <secs>] [-svrTimeout <secs>] [-maxBandwidth <positive_integer>] [-monThreshold <positive_integer>] [-state ( ENABLED | DISABLED )] [-downStateFlush ( ENABLED | DISABLED )] [-comment <string>] [-appflowLog ( ENABLED | DISABLED )] [-autoScale ( DISABLED | DNS )] -siteName <string> [-sitePersistence <sitePersistence>]

Arguments¶

serviceGroupName

Name of the GSLB service group. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed after the name is created.

serviceType

Protocol used to exchange data with the GSLB service.

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

maxClient

Maximum number of simultaneous open connections for the GSLB service group. Minimum value: 0 Maximum value: 4294967294

cip

Insert the Client IP header in requests forwarded to the GSLB service.

Possible values: ENABLED, DISABLED

cipHeader

Name of the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If client IP insertion is enabled, and the client IP header is not specified, the value of Client IP Header parameter or the value set by the set ns config command is used as client's IP header name.

healthMonitor

Monitor the health of this GSLB service.Available settings function are as follows: YES - Send probes to check the health of the GSLB service. NO - Do not send probes to check the health of the GSLB service. With the NO option, the appliance shows the service as UP at all times.

Possible values: YES, NO Default value: YES

cltTimeout

Time, in seconds, after which to terminate an idle client connection. Maximum value: 31536000

svrTimeout

Time, in seconds, after which to terminate an idle server connection. Maximum value: 31536000

maxBandwidth

Maximum bandwidth, in Kbps, allocated for all the services in the GSLB service group. Minimum value: 0 Maximum value: 4294967287

monThreshold

Minimum sum of weights of the monitors that are bound to this GSLB service. Used to determine whether to mark a GSLB service as UP or DOWN. Minimum value: 0 Maximum value: 65535

state

Initial state of the GSLB service group.

Possible values: ENABLED, DISABLED Default value: ENABLED

downStateFlush

Flush all active transactions associated with all the services in the GSLB service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Possible values: ENABLED, DISABLED Default value: ENABLED

comment

Any information about the GSLB service group.

appflowLog

Enable logging of AppFlow information for the specified GSLB service group.

Possible values: ENABLED, DISABLED Default value: ENABLED

autoScale

Auto scale option for a GSLB servicegroup

Possible values: DISABLED, DNS Default value: DISABLED

siteName

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

sitePersistence

Use cookie-based site persistence. Applicable only to HTTP and SSL non-autoscale enabled GSLB servicegroups.

Possible values: ConnectionProxy, HTTPRedirect, NONE

Example¶

add gslb servicegroup http_svc_group http -site san_jos

rm gslb serviceGroup¶

Removes a GSLB service group.

Synopsis¶

rm gslb serviceGroup <serviceGroupName>@

Arguments¶

serviceGroupName

Name of the GSLB service group.

Example¶

rm gslb servicegroup http_svc_group

set gslb serviceGroup¶

Modifies the specified parameters of a GSLB service group.

Synopsis¶

Arguments¶

serviceGroupName

Name of the GSLB service group.

serverName

Name of the server to which to bind the service group.

port

Server port number.

weight

Weight to assign to the servers in the service group. Specifies the capacity of the servers relative to the other servers in the load balancing configuration. The higher the weight, the higher the percentage of requests sent to the service. Minimum value: 1 Maximum value: 100

hashId

The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods. 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. Minimum value: 1

sitePrefix

The site's prefix string. When the GSLB service group is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound serviceitem-domain pair by concatenating the site prefix of the service item 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.

monitorName

Name of the monitor bound to the GSLB service group. Used to assign a weight to the monitor.

weight

weight of the monitor that is bound to GSLB servicegroup. Minimum value: 1

maxClient

Maximum number of simultaneous open connections for the GSLB service group. Minimum value: 0 Maximum value: 4294967294

healthMonitor

Monitor the health of this GSLB service.Available settings function are as follows: YES - Send probes to check the health of the GSLB service. NO - Do not send probes to check the health of the GSLB service. With the NO option, the appliance shows the service as UP at all times.

Possible values: YES, NO Default value: YES

cip

Insert the Client IP header in requests forwarded to the GSLB service.

Possible values: ENABLED, DISABLED

cipHeader

CIP Header.

cltTimeout

Time, in seconds, after which to terminate an idle client connection. Maximum value: 31536000

svrTimeout

Time, in seconds, after which to terminate an idle server connection. Maximum value: 31536000

maxBandwidth

Maximum bandwidth, in Kbps, allocated for all the services in the GSLB service group. Minimum value: 0 Maximum value: 4294967287

monThreshold

Minimum sum of weights of the monitors that are bound to this GSLB service. Used to determine whether to mark a GSLB service as UP or DOWN. Minimum value: 0 Maximum value: 65535

downStateFlush

Flush all active transactions associated with all the services in the GSLB service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

Possible values: ENABLED, DISABLED Default value: ENABLED

comment

Any information about the GSLB service group.

appflowLog

Enable logging of AppFlow information for the specified GSLB service group.

Possible values: ENABLED, DISABLED Default value: ENABLED

sitePersistence

Use cookie-based site persistence. Applicable only to HTTP and SSL non-autoscale enabled GSLB servicegroups.

Possible values: ConnectionProxy, HTTPRedirect, NONE

Example¶

set gslb servicegroup http_svc_group -maxClient 100

unset gslb serviceGroup¶

Removes the attributes of the specified GSLB service group. Attributes for which a default value is available revert to their default values..Refer to the set gslb serviceGroup command for meanings of the arguments.

Synopsis¶

unset gslb serviceGroup <serviceGroupName>@ [(<serverName>@ <port> [-weight] [-hashId] [-publicIP] [-publicPort] [-sitePrefix]) | -sitePersistence] [-maxClient] [-cip] [-cltTimeout] [-svrTimeout] [-maxBandwidth] [-monThreshold] [-appflowLog] [-monitorName] [-weight] [-healthMonitor] [-cipHeader] [-downStateFlush] [-comment]

Example¶

unset gslb servicegroup http_svc_group -maxClient

bind gslb serviceGroup¶

Binds a service to a GSLB service group.

Synopsis¶

Arguments¶

serviceGroupName

Name of the GSLB service group.

IP

IP address of the server that hosts the GSLB service. Mutually exclusive with the Server Name parameter.

serverName

Name of the server that hosts the GSLB service. Mutually exclusive with the IP address parameter.

port

Port number of the GSLB service. Each service must have a unique port number.

monitorName

The name of the GSLB service or a GSLB service group to which the monitor is to be bound.

monState

Administrative state assigned to the monitor and GSLB service group binding. If set to disabled, the service group is not monitored.

Possible values: ENABLED, DISABLED Default value: ENABLED

passive

Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.

weight

When used along with monitor name, it specifies the weight of the monitor binding. When used along with servername &port pair, it specifies the weight of this GSLB service . Default value: 1 Minimum value: 1 Maximum value: 100

state

Initial state of the service after binding.

Possible values: ENABLED, DISABLED Default value: ENABLED

hashId

Unique numerical identifier used by hash based load balancing methods to identify a service. 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.

sitePrefix

The site's prefix string. When the GSLB service group is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound serviceitem-domain pair by concatenating the site prefix of the service item 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.

Example¶

bind gslb servicegroup http_svc_group 10.102.27.153 80

unbind gslb serviceGroup¶

Unbinds a service or a monitor from a GSLB service group.

Synopsis¶

unbind gslb serviceGroup <serviceGroupName> ((<IP>@ <port>) | <serverName>@ | -monitorName <string>@)

Arguments¶

serviceGroupName

Name of the GSLB service group.

IP

IP address of the server that hosts the GSLB service. Mutually exclusive with the Server Name parameter.

serverName

Name of the server that hosts the service. Mutually exclusive with the IP Address parameter.

port

Port number of the GSLB service.

monitorName

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

Example¶

unbind gslb servicegroup http_svc_group 10.102.27.153 80

enable gslb serviceGroup¶

Enables a GSLB service group or a member of the GSLB service group.

Synopsis¶

enable gslb serviceGroup <serviceGroupName>@ [<serverName>@ <port>]

Arguments¶

serviceGroupName

Name of the gslb service group.

serverName

Name of the server that hosts the gslb service.

port

Port number of the service to be enabled.

Example¶

enable gslb servicegroup http_svc_group

enable GSLB service

disable gslb serviceGroup¶

Disables a GSLB service group or a member of a GSLB service group. To disable a GSLB service group, provide only the service group name. To disable only a member of a service group, in addition to the GSLB service group name, provide the name of the server that hosts the service, and the port number of the service.

Synopsis¶

disable gslb serviceGroup <serviceGroupName>@ [<serverName>@ <port>] [-delay <secs>] [-graceFul ( YES | NO )]

Arguments¶

serviceGroupName

Name of the GSLB service group.

serverName

Name of the server that hosts the GSLB service.

port

Port number of the GSLB service.

delay

The time allowed (in seconds) for a graceful shutdown. During this period, new connections or requests will continue to be sent to this service for clients who already have a persistent session on the system. Connections or requests from fresh or new clients who do not yet have a persistence sessions on the system will not be sent to the service. Instead, they will be load balanced among other available services. After the delay time expires, no new requests or connections will be sent to the service.

graceFul

Wait for all existing connections to the service to terminate before shutting down the service.

Possible values: YES, NO Default value: NO

Example¶

disable gslb servicegroup http_svc_group 10.102.27.153 80 -delay 10

show gslb serviceGroup¶

Displays the specified GSLB service group's binding information.

Synopsis¶

show gslb serviceGroup [<serviceGroupName> | -includeMembers]

Arguments¶

serviceGroupName

Name of the GSLB service group.

includeMembers

Display the members of the listed GSLB service groups in addition to their settings. Can be specified when no service group name is provided in the command. In that case, the details displayed for each service group are identical to the details displayed when a service group name is provided, except that bound monitors are not displayed.

Output¶

numOfconnections

This will tell the number of client side connections are still open.

serviceType

Protocol used to exchange data with the GSLB service.

port

The port number of the GSLB service to be enabled.

serviceConfType

The configuration type of the GSLB service group.

value

SSL Status.

maxClient

Maximum number of simultaneous open connections for the GSLB service group.

cip

Insert the Client IP header in requests forwarded to the GSLB service.

cipHeader

CIP Header.

monweight

weight of the monitor that is bound to GSLB servicegroup.

cltTimeout

Time, in seconds, after which to terminate an idle client connection.

svrTimeout

Time, in seconds, after which to terminate an idle server connection.

maxBandwidth

Maximum bandwidth, in Kbps, allocated for all the services in the GSLB service group.

state

The state of the GSLB service group

svrState

The state of the GSLB service

delay

The remaining time in seconds for the service to be disabled

IP

IP Address.

serverName

The name of the server to be changed.

monitorName

Monitor name.

monThreshold

Minimum sum of weights of the monitors that are bound to this GSLB service. Used to determine whether to mark a GSLB service as UP or DOWN.

monState

Monitor state.

weight

When used along with monitor name, it specifies the weight of the monitor binding. When used along with servername &port pair, it specifies the weight of this GSLB service .

monState

The running state of the monitor on this service.

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.

monitorTotalProbes

Total number of probes sent to monitor this service.

monitorTotalFailedProbes

Total number of failed probes

monitorCurrentFailedProbes

Total number of currently failed probes

downStateFlush

Flush all active transactions associated with all services in the GSLB service group whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions.

lastresponse

The string form of monstatcode.

stateChangeTimeSec

Time when last state change occurred. Seconds part.

stateChangeTimemSec

Time when last state change occurred. Milliseconds part.

ticksSinceLastStateChange

Time in 10 millisecond ticks since the last state change.

StateUpdateReason

Checks state update reason on the secondary node.

ClMonOwner

Tells the mon owner of the service.

ClMonView

Tells the view id of the monitoring owner.

groupCount

Servicegroup Count

comment

Any information about the GSLB service group.

hashId

The hash identifier for the service. This must be unique for each service. This parameter is used by hash based load balancing methods.

graceFul

Indicates graceful shutdown of the GSLB service. System will wait for all outstanding connections to this service to be closed before disabling the service.

healthMonitor

Monitor the health of this GSLB service.Available settings function are as follows: YES - Send probes to check the health of the GSLB service. NO - Do not send probes to check the health of the GSLB service. With the NO option, the appliance shows the service as UP at all times.

appflowLog

Enable logging of AppFlow information for the specified GSLB service group.

autoScale

Auto scale option for a GSLB servicegroup

state

Monitor state.

weight

weight of the monitor that is bound to GSLB servicegroup.

serviceIPstr

This field has been intorduced to show the dbs services ip

serviceGroupEntName2

passive

Indicates if load monitor is passive. A passive load monitor does not remove service from LB decision when threshold is breached.

serviceGroupeffectivestate

Indicates the effective GSLB servicegroup state based on the state of the bound service items.If all services are UP the effective state is UP, if all are DOWN its DOWN,if all are OFS its OFS.If atleast one serviceis UP and rest are either DOWN or OFS, the effective state is PARTIAL-UP.If atleast one bound service is DOWN and rest are OFS the effective state is PARTIAL DOWN.

siteName

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

gslb

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.

svrEffGslbState

Effective state of the gslb svc

gslbthreshold

Indicates if gslb svc has reached threshold

threshold

preferredLocation

Prefered location.

sitePersistence

Use cookie-based site persistence. Applicable only to HTTP and SSL non-autoscale enabled GSLB servicegroups.

sitePrefix

The site's prefix string. When the GSLB service group is bound to a GSLB virtual server, a GSLB site domain is generated internally for each bound serviceitem-domain pair by concatenating the site prefix of the service item 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.

noDefaultBindings

to determine if the configuration is from stylebooks

devno

count

stateflag

stat gslb serviceGroup¶

Displays configuration statistics of the specified GSLB service group or all the GSLB service groups configured on the appliance.

Synopsis¶

stat gslb serviceGroup [<serviceGroupName>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]

Arguments¶

serviceGroupName

Name of the GSLB service group for which to display settings.

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¶

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)

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

stat gslb serviceGroupMember

rename gslb serviceGroup¶

Renames a global server load balancing (GSLB) servicegroup. Please fire this command manually or by using real time sync on all the participating GSLB sites otherwise stats exchange between GSLB sites will not work.

Synopsis¶

rename gslb serviceGroup <serviceGroupName>@ <newName>@

Arguments¶

serviceGroupName

Existing name of the GSLB service group.

newName

New name for the GSLB service group.

Example¶

rename gslb servicegroup gslb_svc_grp gslb_svc_grp_new

gslb-serviceGroup¶

add gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶

rm gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶

set gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶

unset gslb serviceGroup¶

Synopsis¶

Example¶

bind gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶

unbind gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶

enable gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶

Related Commands¶

disable gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶

show gslb serviceGroup¶

Synopsis¶

Arguments¶

Output¶

stat gslb serviceGroup¶

Synopsis¶

Arguments¶

Output¶

Counters¶

Related Commands¶

rename gslb serviceGroup¶

Synopsis¶

Arguments¶

Example¶