Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

gslbservicegroup

May 23, 2024
Contributed by: 
C

Configuration for GSLB service group resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
servicegroupname Read-write 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.

Minimum length = 1
servicetype Read-write 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 Read-write Maximum number of simultaneous open connections for the GSLB service group.

Minimum value = 0

Maximum value = 4294967294
cip Read-write Insert the Client IP header in requests forwarded to the GSLB service.

Possible values = ENABLED, DISABLED
cipheader Read-write 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.

Minimum length = 1
healthmonitor Read-write 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. Default value: YES Possible values = YES, NO
clttimeout Read-write Time, in seconds, after which to terminate an idle client connection.

Minimum value = 0

Maximum value = 31536000
svrtimeout Read-write Time, in seconds, after which to terminate an idle server connection.

Minimum value = 0

Maximum value = 31536000
maxbandwidth Read-write Maximum bandwidth, in Kbps, allocated for all the services in the GSLB service group.

Minimum value = 0

Maximum value = 4294967287
monthreshold Read-write 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 Read-write Initial state of the GSLB service group.

Default value: ENABLED

Possible values = ENABLED, DISABLED
downstateflush Read-write 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.

Default value: ENABLED

Possible values = ENABLED, DISABLED
comment Read-write Any information about the GSLB service group.
appflowlog Read-write Enable logging of AppFlow information for the specified GSLB service group.

Default value: ENABLED

Possible values = ENABLED, DISABLED
autoscale Read-write Auto scale option for a GSLB servicegroup.

Default value: DISABLED

Possible values = DISABLED, DNS
autodelayedtrofs Read-write Indicates graceful movement of the service to TROFS. System will wait for monitor response time out before moving to TROFS.

Default value: NO

Possible values = YES, NO
sitename Read-write Name of the GSLB site to which the service group belongs.

Minimum length = 1
sitepersistence Read-write Use cookie-based site persistence. Applicable only to HTTP and SSL non-autoscale enabled GSLB servicegroups.

Possible values = ConnectionProxy, HTTPRedirect, NONE
servername Read-write Name of the server to which to bind the service group.

Minimum length = 1
port Read-write Server port number.

Range 1 - 65535

* in CLI is represented as 65535 in NITRO API
weight Read-write 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 Read-write 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 Read-write The public IP address that a NAT device translates to the GSLB service’s private IP address. Optional.

Minimum length = 1
publicport Read-write 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 Read-write 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.
order Read-write Order number to be assigned to the gslb servicegroup member.

Minimum value = 1

Maximum value = 8192
monitor_name_svc Read-write Name of the monitor bound to the GSLB service group. Used to assign a weight to the monitor.

Minimum length = 1
dup_weight Read-write weight of the monitor that is bound to GSLB servicegroup.

Minimum value = 1
delay Read-write 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 Read-write Wait for all existing connections to the service to terminate before shutting down the service.

Default value: NO

Possible values = YES, NO
includemembers Read-write 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.
newname Read-write New name for the GSLB service group.

Minimum length = 1
numofconnections Read-only This will tell the number of client side connections are still open.
serviceconftype Read-only The configuration type of the GSLB service group.
value Read-only SSL Status.

Possible values = Certkey/Certkeybundle not bound, SSL feature disabled
svrstate Read-only The state of the GSLB service.

Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
ip Read-only IP Address.
monstatcode Read-only The code indicating the monitor response.
monstatparam1 Read-only First parameter for use with message code.
monstatparam2 Read-only Second parameter for use with message code.
monstatparam3 Read-only Third parameter for use with message code.
statechangetimemsec Read-only Time when last state change occurred. Milliseconds part.
stateupdatereason Read-only Checks state update reason on the secondary node.
clmonowner Read-only Tells the mon owner of the service.
clmonview Read-only Tells the view id of the monitoring owner.
groupcount Read-only Servicegroup Count.
serviceipstr Read-only This field has been intorduced to show the dbs services ip.
servicegroupeffectivestate Read-only 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.

Possible values = UP, DOWN, OUT OF SERVICE, PARTIAL-UP, PARTIAL-DOWN
gslb Read-only .

Default value: GSLB

Possible values = REMOTE, LOCAL
svreffgslbstate Read-only Effective state of the gslb svc.

Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
nodefaultbindings Read-only to determine if the configuration is from stylebooks.

Default value: NO

Possible values = YES, NO
__count Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • ENABLE
  • DISABLE
  • GET (ALL)
  • GET
  • COUNT
  • RENAME

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"gslbservicegroup":{
<b>"servicegroupname":<String_value>,
</b><b>"servicetype":<String_value>,
</b>"maxclient":<Double_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"healthmonitor":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"maxbandwidth":<Double_value>,
"monthreshold":<Double_value>,
"state":<String_value>,
"downstateflush":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"autoscale":<String_value>,
"autodelayedtrofs":<String_value>,
<b>"sitename":<String_value>,
</b>"sitepersistence":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup/ servicegroupname_value<String> HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"gslbservicegroup":{
<b>"servicegroupname":<String_value>,
</b>"servername":<String_value>,
"port":<Integer_value>,
"weight":<Double_value>,
"hashid":<Double_value>,
"publicip":<String_value>,
"publicport":<Integer_value>,
"siteprefix":<String_value>,
"order":<Double_value>,
"monitor_name_svc":<String_value>,
"dup_weight":<Double_value>,
"maxclient":<Double_value>,
"healthmonitor":<String_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"maxbandwidth":<Double_value>,
"monthreshold":<Double_value>,
"downstateflush":<String_value>,
"comment":<String_value>,
"appflowlog":<String_value>,
"sitepersistence":<String_value>,
"sitename":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"gslbservicegroup":{
<b>"servicegroupname":<String_value>,
</b>"servername":true,
"port":true,
"weight":true,
"hashid":true,
"publicip":true,
"publicport":true,
"siteprefix":true,
"order":true,
"maxclient":true,
"cip":true,
"clttimeout":true,
"svrtimeout":true,
"maxbandwidth":true,
"monthreshold":true,
"appflowlog":true,
"sitepersistence":true,
"monitor_name_svc":true,
"dup_weight":true,
"healthmonitor":true,
"cipheader":true,
"downstateflush":true,
"comment":true
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

enable

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? action=enable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"gslbservicegroup":{
<b>"servicegroupname":<String_value>,
</b>"servername":<String_value>,
"port":<Integer_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

disable

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? action=disable HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"gslbservicegroup":{
<b>"servicegroupname":<String_value>,
</b>"servername":<String_value>,
"port":<Integer_value>,
"delay":<Double_value>,
"graceful":<String_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

rename

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? action=rename HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"gslbservicegroup":{
<b>"servicegroupname":<String_value>,
</b><b>"newname":<String_value>
</b>}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? args=servicegroupname: <String_value> ,includemembers: <Boolean_value>

Use this query-parameter to get gslbservicegroup resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of gslbservicegroup resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? view=summary

Use this query-parameter to get the summary output of gslbservicegroup resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? pagesize=#no;pageno=#no

Use this query-parameter to get the gslbservicegroup resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{ "gslbservicegroup": [ {
servicegroupname:<String_value>,includemembers:<Boolean_value>"numofconnections":<Integer_value>,
"servicetype":<String_value>,
"port":<Integer_value>,
"serviceconftype":<Boolean_value>,
"value":<String_value>,
"maxclient":<Double_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"maxbandwidth":<Double_value>,
"state":<String_value>,
"svrstate":<String_value>,
"delay":<Double_value>,
"ip":<String_value>,
"servername":<String_value>,
"monthreshold":<Double_value>,
"weight":<Double_value>,
"monstatcode":<Integer_value>,
"monstatparam1":<Integer_value>,
"monstatparam2":<Integer_value>,
"monstatparam3":<Integer_value>,
"downstateflush":<String_value>,
"statechangetimemsec":<Double_value>,
"stateupdatereason":<Double_value>,
"clmonowner":<Double_value>,
"clmonview":<Double_value>,
"groupcount":<Double_value>,
"comment":<String_value>,
"hashid":<Double_value>,
"graceful":<String_value>,
"healthmonitor":<String_value>,
"appflowlog":<String_value>,
"autoscale":<String_value>,
"autodelayedtrofs":<String_value>,
"serviceipstr":<String_value>,
"servicegroupeffectivestate":<String_value>,
"sitename":<String_value>,
"gslb":<String_value>,
"publicip":<String_value>,
"publicport":<Integer_value>,
"svreffgslbstate":<String_value>,
"sitepersistence":<String_value>,
"siteprefix":<String_value>,
"nodefaultbindings":<String_value>,
"order":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup/ servicegroupname_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup/ servicegroupname_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup/ servicegroupname_value<String> ? view=summary

Use this query-parameter to get the summary output of gslbservicegroup resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{  "gslbservicegroup": [ {
servicegroupname:<String_value>,includemembers:<Boolean_value>"numofconnections":<Integer_value>,
"servicetype":<String_value>,
"port":<Integer_value>,
"serviceconftype":<Boolean_value>,
"value":<String_value>,
"maxclient":<Double_value>,
"cip":<String_value>,
"cipheader":<String_value>,
"clttimeout":<Double_value>,
"svrtimeout":<Double_value>,
"maxbandwidth":<Double_value>,
"state":<String_value>,
"svrstate":<String_value>,
"delay":<Double_value>,
"ip":<String_value>,
"servername":<String_value>,
"monthreshold":<Double_value>,
"weight":<Double_value>,
"monstatcode":<Integer_value>,
"monstatparam1":<Integer_value>,
"monstatparam2":<Integer_value>,
"monstatparam3":<Integer_value>,
"downstateflush":<String_value>,
"statechangetimemsec":<Double_value>,
"stateupdatereason":<Double_value>,
"clmonowner":<Double_value>,
"clmonview":<Double_value>,
"groupcount":<Double_value>,
"comment":<String_value>,
"hashid":<Double_value>,
"graceful":<String_value>,
"healthmonitor":<String_value>,
"appflowlog":<String_value>,
"autoscale":<String_value>,
"autodelayedtrofs":<String_value>,
"serviceipstr":<String_value>,
"servicegroupeffectivestate":<String_value>,
"sitename":<String_value>,
"gslb":<String_value>,
"publicip":<String_value>,
"publicport":<Integer_value>,
"svreffgslbstate":<String_value>,
"sitepersistence":<String_value>,
"siteprefix":<String_value>,
"nodefaultbindings":<String_value>,
"order":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbservicegroup? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{ "gslbservicegroup": [ { "__count": "#no"} ] }

<!--NeedCopy-->
gslbservicegroup
May 23, 2024
Contributed by: 
C
May 23, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.