Displays statistics for the specified service group.Name of the 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-write

IP address of the service group. Mutually exclusive with the server name parameter.

servername

<String>

Read-write

Name of the server. Mutually exclusive with the IP address parameter.
Minimum length = 1

port

<Integer>

Read-write

Port number of the service group member.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API

clearstats

<String>

Read-write

Clear the statsistics / counters.
Possible values = basic, full

avgsvrttfb

<Double>

Read-only

Average TTFB between the Citrix ADC and the server. TTFB is the time interval between sending the request packet to a service and receiving the first response from the service

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)

totalrequests

<Double>

Read-only

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

requestsrate

<Double>

Read-only

Rate (/s) counter for totalrequests

totalresponses

<Double>

Read-only

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

responsesrate

<Double>

Read-only

Rate (/s) counter for totalresponses

totalrequestbytes

<Double>

Read-only

Total number of request bytes received on this service or virtual server.

requestbytesrate

<Double>

Read-only

Rate (/s) counter for totalrequestbytes

totalresponsebytes

<Double>

Read-only

Number of response bytes received by this service or virtual server.

responsebytesrate

<Double>

Read-only

Rate (/s) counter for totalresponsebytes

curclntconnections

<Double>

Read-only

Number of current client connections.

surgecount

<Double>

Read-only

Number of requests in the surge queue.

cursrvrconnections

<Double>

Read-only

Number of current connections to the actual servers behind the virtual server.

svrestablishedconn

<Double>

Read-only

Number of server connections in ESTABLISHED state.

curreusepool

<Double>

Read-only

Number of requests in the idle queue/reuse pool.

maxclients

<Double>

Read-only

Maximum open connections allowed on this service.

totalconnreassemblyqueue75

<Double>

Read-only

Total no of connections with 75% TCP reassembly queue

totalconnreassemblyqueueflush

<Double>

Read-only

Total no of connections incurred TCP reassembly queue flush

totsvrttlbtransactions

<Double>

Read-only

Total transactions where server TTLB is calculated.

toleratingttlbtransactions

<Double>

Read-only

Tolerable transactions based on APDEX threshold (>T ;; <4T).

frustratingttlbtransactions

<Double>

Read-only

Frustrating transactions based on APDEX threshold (>4T).

curload

<Double>

Read-only

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

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