Skip to content

servicegroupmember

Statistics for service group entity resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
servicegroupname<String>Read-writeDisplays 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-writeIP address of the 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
avgsvrttfb<Double>Read-onlyAverage 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
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)
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
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
curclntconnections<Double>Read-onlyNumber of current client connections.
surgecount<Double>Read-onlyNumber of requests in the surge queue.
cursrvrconnections<Double>Read-onlyNumber of current connections to the actual servers behind the virtual server.
svrestablishedconn<Double>Read-onlyNumber of server connections in ESTABLISHED state.
curreusepool<Double>Read-onlyNumber of requests in the idle queue/reuse pool.
maxclients<Double>Read-onlyMaximum open connections allowed on this service.
totalconnreassemblyqueue75<Double>Read-onlyTotal no of connections with 75% TCP reassembly queue
totalconnreassemblyqueueflush<Double>Read-onlyTotal no of connections incurred TCP reassembly queue flush
totsvrttlbtransactions<Double>Read-onlyTotal transactions where server TTLB is calculated.
toleratingttlbtransactions<Double>Read-onlyTolerable transactions based on APDEX threshold (>T ;; <4T).
frustratingttlbtransactions<Double>Read-onlyFrustrating transactions based on APDEX threshold (>4T).

Operations

(click to see Properties)

GET (ALL)| GET

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:

    http://<Citrix-ADC-IP-address(NSIP)>/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 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:

    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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/servicegroupmember

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/servicegroupmember?args=servicegroupname:<String_value>,ip:<String_value>,servername:<String_value>,port:<Integer_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

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

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "servicegroupmember": [ {
"servicegroupname":<String_value>,
"svrestablishedconn":<Double_value>,
"curclntconnections":<Double_value>,
"servicetype":<String_value>,
"totalrequests":<Double_value>,
"surgecount":<Double_value>,
"responsebytesrate":<Double_value>,
"totalresponses":<Double_value>,
"requestbytesrate":<Double_value>,
"totalconnreassemblyqueue75":<Double_value>,
"cursrvrconnections":<Double_value>,
"totalconnreassemblyqueueflush":<Double_value>,
"primaryipaddress":<String_value>,
"toleratingttlbtransactions":<Double_value>,
"responsesrate":<Double_value>,
"maxclients":<Double_value>,
"avgsvrttfb":<Double_value>,
"totalrequestbytes":<Double_value>,
"curreusepool":<Double_value>,
"state":<String_value>,
"totsvrttlbtransactions":<Double_value>,
"frustratingttlbtransactions":<Double_value>,
"totalresponsebytes":<Double_value>,
"primaryport":<Integer_value>,
"requestsrate":<Double_value>
}]}

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/servicegroupmember/servicegroupname_value><String>

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "servicegroupmember": [ {
"servicegroupname":<String_value>,
"svrestablishedconn":<Double_value>,
"curclntconnections":<Double_value>,
"servicetype":<String_value>,
"totalrequests":<Double_value>,
"surgecount":<Double_value>,
"responsebytesrate":<Double_value>,
"totalresponses":<Double_value>,
"requestbytesrate":<Double_value>,
"totalconnreassemblyqueue75":<Double_value>,
"cursrvrconnections":<Double_value>,
"totalconnreassemblyqueueflush":<Double_value>,
"primaryipaddress":<String_value>,
"toleratingttlbtransactions":<Double_value>,
"responsesrate":<Double_value>,
"maxclients":<Double_value>,
"avgsvrttfb":<Double_value>,
"totalrequestbytes":<Double_value>,
"curreusepool":<Double_value>,
"state":<String_value>,
"totsvrttlbtransactions":<Double_value>,
"frustratingttlbtransactions":<Double_value>,
"totalresponsebytes":<Double_value>,
"primaryport":<Integer_value>,
"requestsrate":<Double_value>
}]}