| statprotocoltcpResult Structure Definition |
The statprotocoltcpResult structure defines the return type for statprotocoltcp 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. |
protocoltcpList |
Pointer to the protocoltcp List. |
| protocoltcpstats Structure Definition |
The protocoltcpstats structure defines the actual return type values for statprotocoltcp API. |
Syntax |
Members |
clearstats |
Clear the statsistics / counters |
_nextgenapiresource |
tcpactiveserverconn |
Connections to a server currently responding to requests. |
tcpcurserverconnopening |
Server connections in the Opening state, which indicates that the handshakes are not yet complete. |
tcpcurclientconnopening |
Client connections in the Opening state, which indicates that the handshakes are not yet complete. |
tcpcurclientconnestablished |
Current client connections in the Established state, which indicates that data transfer can occur between the Citrix ADC and the client. |
tcpcurserverconnestablished |
Current server connections in the Established state, which indicates that data transfer can occur between the Citrix ADC and the server. |
tcptotrxpkts |
TCP packets received. |
tcprxpktsrate |
TCP packets received. |
tcptotrxbytes |
Bytes of TCP data received. |
tcprxbytesrate |
Bytes of TCP data received. |
tcptottxpkts |
TCP packets transmitted. |
tcptxpktsrate |
TCP packets transmitted. |
tcptottxbytes |
Bytes of TCP data transmitted. |
tcptxbytesrate |
Bytes of TCP data transmitted. |
tcpcurclientconn |
Client connections, including connections in the Opening, Established, and Closing state. |
tcpcurclientconnclosing |
Client connections in the Closing state, which indicates that the connection termination process has initiated but is not complete. |
tcptotclientconnopened |
Client connections opened by the Citrix ADC since startup (after three-way handshake). This counter is reset when the Citrix ADC is restarted. |
tcpclientconnopenedrate |
Client connections opened by the Citrix ADC since startup (after three-way handshake). This Rateer is reset when the Citrix ADC is restarted. |
tcpcurserverconn |
Server connections, including connections in the Opening, Established, and Closing state. |
tcpcurserverconnclosing |
Server connections in the Closing state, which indicates that the connection termination process has initiated but is not complete. |
tcptotserverconnopened |
Server connections initiated by the Citrix ADC since startup. This counter is reset when the Citrix ADC is restarted. |
tcpserverconnopenedrate |
Server connections initiated by the Citrix ADC since startup. This Rateer is reset when the Citrix ADC is restarted. |
tcpsurgequeuelen |
Connections in the surge queue. When the Citrix ADC cannot open a connection to the server, for example when maximum connections have been reached, the Citrix ADC queues these requests. |
tcpspareconn |
Spare connections available. To save time and resources in establishing another connection for a new client, the connection on the server is not closed after completing the request from the first client and is available for serving future requests. |
tcptotzombiecltconnflushed |
Client connections that are flushed because the client has been idle for some time. |
tcpzombiecltconnflushedrate |
Client connections that are flushed because the client has been idle for some time. |
tcptotzombiehalfopencltconnflushed |
Half-opened client connections that are flushed because the three-way handshakes are not complete. |
tcpzombiehalfopencltconnflushedrate |
Half-opened client connections that are flushed because the three-way handshakes are not complete. |
tcptotzombieactivehalfclosecltconnflushed |
Active half-closed client connections that are flushed because the client has closed the connection and there has been no activity on the connection. |
tcpzombieactivehalfclosecltconnflushedrate |
Active half-closed client connections that are flushed because the client has closed the connection and there has been no activity on the connection. |
tcptotzombiepassivehalfclosecltconnflushed |
Passive half-closed client connections that are flushed because the Citrix ADC has closed the connection and there has been no activity on the connection. |
tcpzombiepassivehalfclosecltconnflushedrate |
Passive half-closed client connections that are flushed because the Citrix ADC has closed the connection and there has been no activity on the connection. |
tcptotzombiesvrconnflushed |
Server connections that are flushed because there have been no client requests in the queue for some time. |
tcpzombiesvrconnflushedrate |
Server connections that are flushed because there have been no client requests in the queue for some time. |
tcptotzombiehalfopensvrconnflushed |
Half-opened server connections that are flushed because the three-way handshakes are not complete. |
tcpzombiehalfopensvrconnflushedrate |
Half-opened server connections that are flushed because the three-way handshakes are not complete. |
tcptotzombieactivehalfclosesvrconnflushed |
Active half-closed server connections that are flushed because the server has closed the connection and there has been no activity on the connection. |
tcpzombieactivehalfclosesvrconnflushedrate |
Active half-closed server connections that are flushed because the server has closed the connection and there has been no activity on the connection. |
tcptotzombiepassivehalfclosesrvconnflushed |
Passive half-closed server connections that are flushed because the Citrix ADC has closed the connection and there has been no activity on the connection. |
tcpzombiepassivehalfclosesrvconnflushedrate |
Passive half-closed server connections that are flushed because the Citrix ADC has closed the connection and there has been no activity on the connection. |
pcbtotzombiecall |
Times the Zombie cleanup function is called. Every time a connection is flushed, it is marked for cleanup. The Zombie cleanup function clears all these connections at predefined intervals. |
pcbzombiecallrate |
Times the Zombie cleanup function is called. Every time a connection is flushed, it is marked for cleanup. The Zombie cleanup function clears all these connections at predefined intervals. |
tcptotsyn |
SYN packets received |
tcpsynrate |
SYN packets received |
tcptotsynprobe |
Probes from the Citrix ADC to a server. The Citrix ADC sends a SYN packet to the server to check its availability and expects a SYN_ACK packet from the server before a specified response timeout. |
tcpsynproberate |
Probes from the Citrix ADC to a server. The Citrix ADC sends a SYN packet to the server to check its availability and expects a SYN_ACK packet from the server before a specified response timeout. |
tcptotsvrfin |
FIN packets received from the server. |
tcpsvrfinrate |
FIN packets received from the server. |
tcptotcltfin |
FIN packets received from the clients. |
tcpcltfinrate |
FIN packets received from the clients. |
tcpwaittosyn |
SYN packets (packets used to initiate a TCP connection) received on connections that are in the TIME_WAIT state. Packets cannot be transferred on a connection in this state. |
tcpwaittosynrate |
SYN packets (packets used to initiate a TCP connection) received on connections that are in the TIME_WAIT state. Packets cannot be transferred on a connection in this state. |
tcpwaittodata |
Bytes of data received on connections that are in the TIME_WAIT state. Data cannot be transferred on a connection that is in this state. |
tcpwaittodatarate |
Bytes of data received on connections that are in the TIME_WAIT state. Data cannot be transferred on a connection that is in this state. |
tcptotsynheld |
SYN packets held on the Citrix ADC that are waiting for a server connection. |
tcpsynheldrate |
SYN packets held on the Citrix ADC that are waiting for a server connection. |
tcptotsynflush |
SYN packets flushed on the Citrix ADC because of no response from the server for three or more seconds. |
tcpsynflushrate |
SYN packets flushed on the Citrix ADC because of no response from the server for three or more seconds. |
tcptotfinwaitclosed |
Connections closed on the Citrix ADC because the number of connections in the TIME_WAIT state has exceeded the default value of 7000. |
tcpfinwaitclosedrate |
Connections closed on the Citrix ADC because the Rate of connections in the TIME_WAIT state has exceeded the default value of 7000. |
tcperrbadchecksum |
Packets received with a TCP checksum error. |
tcperrbadchecksumrate |
Packets received with a TCP checksum error. |
tcperrdataafterfin |
Packets received following a connection termination request. This error is usually caused by a reordering of packets during transmission. |
tcperrdataafterfinrate |
Packets received following a connection termination request. This error is usually caused by a reordering of packets during transmission. |
tcperrsyninsynrcvd |
SYN packets received on a connection that is in the SYN_RCVD state. A connection goes into the SYN_RCVD state after receiving a SYN packet. |
tcperrsyninsynrcvdrate |
SYN packets received on a connection that is in the SYN_RCVD state. A connection goes into the SYN_RCVD state after receiving a SYN packet. |
tcperrsyninest |
SYN packets received on a connection that is in the ESTABLISHED state. A SYN packet is not expected on an ESTABLISHED connection. |
tcperrsyninestrate |
SYN packets received on a connection that is in the ESTABLISHED state. A SYN packet is not expected on an ESTABLISHED connection. |
tcperrsynsentbadack |
Incorrect ACK packets received on a connection that is in the SYN_SENT state. An incorrect ACK packet is the third packet in the three-way handshake that has an incorrect sequence number. |
tcperrsynsentbadackrate |
Incorrect ACK packets received on a connection that is in the SYN_SENT state. An incorrect ACK packet is the third packet in the three-way handshake that has an incorrect sequence Rate. |
tcperrrst |
Reset packets received from a client or a server. |
tcperrrstrate |
Reset packets received from a client or a server. |
tcperrrstnonest |
Reset packets received on a connection that is not in the ESTABLISHED state. |
tcperrrstnonestrate |
Reset packets received on a connection that is not in the ESTABLISHED state. |
tcperrrstoutofwindow |
Reset packets received on a connection that is out of the current TCP window. |
tcperrrstoutofwindowrate |
Reset packets received on a connection that is out of the current TCP window. |
tcperrrstintimewait |
Reset packets received on a connection that is in the TIME_WAIT state. Packets cannot be transferred on a connection in the TIME_WAIT state. |
tcperrrstintimewaitrate |
Reset packets received on a connection that is in the TIME_WAIT state. Packets cannot be transferred on a connection in the TIME_WAIT state. |
tcperrsvroutoforder |
Out of order TCP packets received from a server. |
tcperrsvroutoforderrate |
Out of order TCP packets received from a server. |
tcperrcltoutoforder |
Out of order TCP packets received from a client. |
tcperrcltoutoforderrate |
Out of order TCP packets received from a client. |
tcperrclthole |
TCP holes created on a client connection. When out of order packets are received from a client, a hole is created on the Citrix ADC for each group of missing packets. |
tcperrcltholerate |
TCP holes created on a client connection. When out of order packets are received from a client, a hole is created on the Citrix ADC for each group of missing packets. |
tcperrsvrhole |
TCP holes created on a server connection. When out of order packets are received from a server, a hole is created on the Citrix ADC for each group of missing packets. |
tcperrsvrholerate |
TCP holes created on a server connection. When out of order packets are received from a server, a hole is created on the Citrix ADC for each group of missing packets. |
tcperrcookiepktseqreject |
SYN cookie packets rejected because they contain an incorrect sequence number. |
tcperrcookiepktseqrejectrate |
SYN cookie packets rejected because they contain an incorrect sequence Rate. |
tcperrcookiepktsigreject |
SYN cookie packets rejected because they contain an incorrect signature. |
tcperrcookiepktsigrejectrate |
SYN cookie packets rejected because they contain an incorrect signature. |
tcperrcookiepktseqdrop |
SYN cookie packets dropped because the sequence number specified in the packets is outside the current window. |
tcperrcookiepktseqdroprate |
SYN cookie packets dropped because the sequence Rate specified in the packets is outside the current window. |
tcperrcookiepktmssreject |
SYN cookie packets rejected because the maximum segment size (MSS) specified in the packets is incorrect. |
tcperrcookiepktmssrejectrate |
SYN cookie packets rejected because the maximum segment size (MSS) specified in the packets is incorrect. |
tcperranyportfail |
Port allocations that have failed on a mapped IP address because the maximum limit of 65536 has been exceeded. |
tcperranyportfailrate |
Port allocations that have failed on a mapped IP address because the maximum limit of 65536 has been exceeded. |
tcperripportfail |
Port allocations that have failed on a subnet IP address or vserver IP address because the maximum limit of 65536 has been exceeded. |
tcperripportfailrate |
Port allocations that have failed on a subnet IP address or vserver IP address because the maximum limit of 65536 has been exceeded. |
tcperrstraypkt |
Number of stray or misrouted packets. |
tcperrstraypktrate |
Rate of stray or misrouted packets. |
tcperrsentrst |
Reset packets sent to a client or a server. |
tcperrsentrstrate |
Reset packets sent to a client or a server. |
tcperrbadstateconn |
Connections that are not in a valid TCP state. |
tcperrbadstateconnrate |
Connections that are not in a valid TCP state. |
tcperrrstthreshold |
Reset packets dropped because the default threshold of 100 resets per 10 milliseconds has been exceeded. This is a configurable value using the set rateControl command. |
tcperrrstthresholdrate |
Reset packets dropped because the default threshold of 100 resets per 10 milliseconds has been exceeded. This is a configurable value using the set rateControl command. |
tcperroutofwindowpkts |
Packets received that are out of the current advertised window. |
tcperroutofwindowpktsrate |
Packets received that are out of the current advertised window. |
tcperrsyndroppedcongestion |
SYN packets dropped because of network congestion. |
tcperrsyndroppedcongestionrate |
SYN packets dropped because of network congestion. |
tcperrcltretrasmit |
Packets retransmitted by a client. This usually occurs because the acknowledgement from the Citrix ADC has not reached the client. |
tcperrcltretrasmitrate |
Packets retransmitted by a client. This usually occurs because the acknowledgement from the Citrix ADC has not reached the client. |
tcperrfullretrasmit |
Full packets retransmitted by the client or the server. |
tcperrfullretrasmitrate |
Full packets retransmitted by the client or the server. |
tcperrsynretry |
SYN packets resent to a server. |
tcperrsynretryrate |
SYN packets resent to a server. |
tcperrsyngiveup |
Attempts to establish a connection on the Citrix ADC that timed out. |
tcperrsyngiveuprate |
Attempts to establish a connection on the Citrix ADC that timed out. |
tcperrretransmit |
TCP packets retransmitted. The Citrix ADC attempts to retransmit the packet up to seven times, after which it resets the other half of the TCP connection. |
tcperrretransmitrate |
TCP packets retransmitted. The Citrix ADC attempts to retransmit the packet up to seven times, after which it resets the other half of the TCP connection. |
tcperrfirstretransmissions |
Packets retransmitted once by the Citrix ADC. |
tcperrfirstretransmissionsrate |
Packets retransmitted once by the Citrix ADC. |
tcperrthirdretransmissions |
Packets retransmitted three times by the Citrix ADC. |
tcperrthirdretransmissionsrate |
Packets retransmitted three times by the Citrix ADC. |
tcperrfifthretransmissions |
Packets retransmitted five times by the Citrix ADC. |
tcperrfifthretransmissionsrate |
Packets retransmitted five times by the Citrix ADC. |
tcperrseventhretransmissions |
Packets retransmitted seven times by the Citrix ADC. If this fails, the Citrix ADC terminates the connection. |
tcperrseventhretransmissionsrate |
Packets retransmitted seven times by the Citrix ADC. If this fails, the Citrix ADC terminates the connection. |
tcperrfastretransmissions |
TCP packets on which the Citrix ADC performs a fast retransmission in response to three duplicate acknowledgements or a partial acknowledgement. The Citrix ADC assumes that the packet is lost and retransmits the packet before its time-out. |
tcperrfastretransmissionsrate |
TCP packets on which the Citrix ADC performs a fast retransmission in response to three duplicate acknowledgements or a partial acknowledgement. The Citrix ADC assumes that the packet is lost and retransmits the packet before its time-out. |
tcperrsvrretrasmit |
Packets retransmitted by a server. This usually occurs because the acknowledgement from the Citrix ADC has not reached the server. |
tcperrsvrretrasmitrate |
Packets retransmitted by a server. This usually occurs because the acknowledgement from the Citrix ADC has not reached the server. |
tcperrpartialretrasmit |
Partial packet retransmits by a client or server due to congestion on the connection. This usually occurs because the window advertised by the Citrix ADC is not big enough to hold the full packet. |
tcperrpartialretrasmitrate |
Partial packet retransmits by a client or server due to congestion on the connection. This usually occurs because the window advertised by the Citrix ADC is not big enough to hold the full packet. |
tcperrfinretry |
FIN packets resent to a server or a client. |
tcperrfinretryrate |
FIN packets resent to a server or a client. |
tcperrfingiveup |
Connections that were timed out by the Citrix ADC because of not receiving the ACK packet after retransmitting the FIN packet four times. |
tcperrfingiveuprate |
Connections that were timed out by the Citrix ADC because of not receiving the ACK packet after retransmitting the FIN packet four times. |
tcperrsecondretransmissions |
Packets retransmitted twice by the Citrix ADC. |
tcperrsecondretransmissionsrate |
Packets retransmitted twice by the Citrix ADC. |
tcperrforthretransmissions |
Packets retransmitted four times by the Citrix ADC. |
tcperrforthretransmissionsrate |
Packets retransmitted four times by the Citrix ADC. |
tcperrsixthretransmissions |
Packets retransmitted six times by the Citrix ADC. |
tcperrsixthretransmissionsrate |
Packets retransmitted six times by the Citrix ADC. |
tcperrretransmitgiveup |
Number of times Citrix ADC terminates a connection after retransmitting the packet seven times on that connection.Retrasnmission happens when recieving end doesn't acknowledges the packet. |
tcperrretransmitgiveuprate |
Rate of times Citrix ADC terminates a connection after retransmitting the packet seven times on that connection.Retrasnmission happens when recieving end doesn't acknowledges the packet. |
tcperrcipalloc |
Number of times TCP level client header insertion failure |
tcperrcipallocrate |
Rate of times TCP level client header insertion failure |
See Also |