statserviceResult Structure Definition

The statserviceResult structure defines the return type for statservice API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

serviceList

Pointer to the service List.


servicestats Structure Definition

The servicestats structure defines the actual return type values for statservice API.

Syntax



Members

name

Name of the service.

clearstats

Clear the statsistics / counters

_nextgenapiresource


throughput

Number of bytes received or sent by this service (Mbps).

throughputrate

Rate of bytes received or sent by this service (Mbps).

avgsvrttfb

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

The IP address on which the service is running.

primaryport

The port on which the service is running.

servicetype

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
Possible Values : HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, MONGO, MONGO_TLS, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP, QUIC, IPFIX, LOGSTREAM, LOGSTREAM_SSL, MQTT, MQTT_TLS, QUIC_BRIDGE, DOT, ADNS_DOT, HTTP_QUIC, ADNS_DOH, KAFKA_BROKER.

state

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)
Possible Values : UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED.

totalrequests

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

requestsrate

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

totalresponses

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

responsesrate

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

totalrequestbytes

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

totalresponsebytes

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

curclntconnections

Number of current client connections.

surgecount

Number of requests in the surge queue.

cursrvrconnections

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

svrestablishedconn

Number of server connections in ESTABLISHED state.

curreusepool

Number of requests in the idle queue/reuse pool.

maxclients

Maximum open connections allowed on this service.

curload

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

totalconnreassemblyqueue75

Total no of connections with 75% TCP reassembly queue

totalconnreassemblyqueueflush

Total no of connections incurred TCP reassembly queue flush

httpmaxhdrszpkts

Number of http max header size packet parsing failures

httpmaxhdrfldlenpkts

Number of HTTP requests exceeding max header field length

tcpmaxooopkts

No of times max out of order packets reached

curtflags

Current flags on the service for internal use in display handlers.

totsvrttlbtransactions

Total transactions where server TTLB is calculated.

toleratingttlbtransactions

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

frustratingttlbtransactions

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

vsvrservicehits

Number of times that the service has been provided.

vsvrservicehitsrate

Rate of times that the service has been provided.

activetransactions

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

serviceorder

Order with which service is bound to vserver

totalpktsrecvd

Total number of packets received by this service or virtual server.

totalpktssent

Total number of packets sent.

See Also