| getgslbservicegroupResult Structure Definition |
The getgslbservicegroupResult structure defines the return type for getgslbservicegroup API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
gslbservicegroupList |
List of gslbservicegroups |
| gslbservicegroup Structure Definition |
The gslbservicegroup structure defines the actual return type values for getgslbservicegroup API. |
Syntax |
Members |
servicegroupname |
Name of the GSLB service group. |
includemembers |
Display the members of the listed GSLB service groups in addition to their settings. |
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 . |
monstate2 |
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 |
autodelayedtrofs |
Indicates graceful movement of the service to TROFS. System will wait for monitor response time out before moving to TROFS |
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 |
order |
Order number to be assigned to the gslb servicegroup member |
order2 |
Order number in string form assigned to the gslb servicegroup member |
trofsdelay |
Delay before moving to TROFS |
_nextgenapiresource |
svcgrpmonbindweight |
ipaddress |
svcstate |
svcgrpentstate |
svchashid |
svcgrpentgraceful |
svcgrpentdelay |
See Also |