Skip to content
Was this article helpful?


Statistics for GSLB service group entity resource.


(click to see Operations)

NameData TypePermissionsDescription
servicegroupname<String>Read-writeDisplays statistics for the specified GSLB service group.Name of the GSLB service group. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my servicegroup" or 'my servicegroup').
Minimum length = 1
ip<String>Read-writeIP address of the GSLB service group. Mutually exclusive with the server name parameter.
servername<String>Read-writeName of the server. Mutually exclusive with the IP address parameter.
Minimum length = 1
port<Integer>Read-writePort number of the service group member.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
establishedconn<Double>Read-onlyNumber of client connections in ESTABLISHED state.
primaryipaddress<String>Read-onlyThe IP address on which the service is running.
primaryport<Integer>Read-onlyThe port on which the service is running.
servicetype<String>Read-onlyThe 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<String>Read-onlyCurrent 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)
totalrequestbytes<Double>Read-onlyTotal number of request bytes received on this service or virtual server.
requestbytesrate<Double>Read-onlyRate (/s) counter for totalrequestbytes
totalresponsebytes<Double>Read-onlyNumber of response bytes received by this service or virtual server.
responsebytesrate<Double>Read-onlyRate (/s) counter for totalresponsebytes
curload<Double>Read-onlyLoad on the service that is calculated from the bound load based monitor.
totalrequests<Double>Read-onlyTotal number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
requestsrate<Double>Read-onlyRate (/s) counter for totalrequests
totalresponses<Double>Read-onlyNumber of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
responsesrate<Double>Read-onlyRate (/s) counter for totalresponses
curclntconnections<Double>Read-onlyNumber of current client connections.
cursrvrconnections<Double>Read-onlyNumber of current connections to the actual servers behind the virtual server.


(click to see Properties)


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 Citrix ADC appliance, the URL is as follows:


    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 Citrix ADC 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:



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



Mandatory parameters are marked in redand placeholder content is marked in <green>.

get (all)





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


Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json


HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:


Response Payload:

{ "gslbservicegroupmember": [ {
Was this article helpful?