Skip to content

service

Statistics for service resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name of the service.

Minimum length = 1
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
throughput <Double> Read-only Number of bytes received or sent by this service (Mbps).
throughputrate <Double> Read-only Rate (/s) counter for throughput
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
primaryipaddress <String> Read-only The IP address on which the service is running.
primaryport <Integer> Read-only The port on which the service is running.
servicetype <String> Read-only The 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-only 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.
curload <Double> Read-only Load on the service that is calculated from the bound load based monitor.
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
httpmaxhdrszpkts <Double> Read-only Number of http max header size packet parsing failures
tcpmaxooopkts <Double> Read-only No of times max out of order packets reached
curtflags <Double> Read-only Current flags on the service for internal use in display handlers.
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).
vsvrservicehits <Double> Read-only Number of times that the service has been provided.
vsvrservicehitsrate <Double> Read-only Rate (/s) counter for vsvrservicehits
activetransactions <Double> Read-only Number of active transactions handled by this service. (Including those in the surge queue.) Active Transaction means number of transactions currently served by the server including those waiting in the SurgeQ

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 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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/stat/service

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/service? args=name: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

Use this query-parameter to get service 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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "service": [ {
      "name":<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>,
      "throughput":<Double_value>,
      "throughputrate":<Double_value>,
      "totalconnreassemblyqueue75":<Double_value>,
      "curtflags":<Double_value>,
      "cursrvrconnections":<Double_value>,
      "totalconnreassemblyqueueflush":<Double_value>,
      "primaryipaddress":<String_value>,
      "activetransactions":<Double_value>,
      "toleratingttlbtransactions":<Double_value>,
      "responsesrate":<Double_value>,
      "maxclients":<Double_value>,
      "avgsvrttfb":<Double_value>,
      "tcpmaxooopkts":<Double_value>,
      "curload":<Double_value>,
      "totalrequestbytes":<Double_value>,
      "curreusepool":<Double_value>,
      "state":<String_value>,
      "httpmaxhdrszpkts":<Double_value>,
      "vsvrservicehits":<Double_value>,
      "totsvrttlbtransactions":<Double_value>,
      "frustratingttlbtransactions":<Double_value>,
      "totalresponsebytes":<Double_value>,
      "primaryport":<Integer_value>,
      "requestsrate":<Double_value>,
      "vsvrservicehitsrate":<Double_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/stat/service/ name_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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "service": [ {
      "name":<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>,
      "throughput":<Double_value>,
      "throughputrate":<Double_value>,
      "totalconnreassemblyqueue75":<Double_value>,
      "curtflags":<Double_value>,
      "cursrvrconnections":<Double_value>,
      "totalconnreassemblyqueueflush":<Double_value>,
      "primaryipaddress":<String_value>,
      "activetransactions":<Double_value>,
      "toleratingttlbtransactions":<Double_value>,
      "responsesrate":<Double_value>,
      "maxclients":<Double_value>,
      "avgsvrttfb":<Double_value>,
      "tcpmaxooopkts":<Double_value>,
      "curload":<Double_value>,
      "totalrequestbytes":<Double_value>,
      "curreusepool":<Double_value>,
      "state":<String_value>,
      "httpmaxhdrszpkts":<Double_value>,
      "vsvrservicehits":<Double_value>,
      "totsvrttlbtransactions":<Double_value>,
      "frustratingttlbtransactions":<Double_value>,
      "totalresponsebytes":<Double_value>,
      "primaryport":<Integer_value>,
      "requestsrate":<Double_value>,
      "vsvrservicehitsrate":<Double_value>
}]}