ADC NITRO APIs
cmp
Statistics for cmp.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats | <String> | Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| delbwsaving | <Double> | Read-only | Bandwidth saving from delta compression expressed as percentage. |
| delcmpratio | <Double> | Read-only | Ratio of compressible data received to compressed data transmitted.If this ratio is one (uncmp:1.0) that means compression is disabled or we are not able to compress even a single compressible packet. |
| decomptcpratio | <Double> | Read-only | Ratio of decompressed data transmitted to compressed data received. |
| decomptcpbandwidthsaving | <Double> | Read-only | Bandwidth saving from TCP compression expressed as percentage. |
| comptcpratio | <Double> | Read-only | Ratio of compressible data received to compressed data transmitted.If this ratio is one (uncmp:1.0) that means compression is disabled or we are not able to compress even a single compressible packet. |
| comptcpbandwidthsaving | <Double> | Read-only | Bandwidth saving from TCP compression expressed as percentage. |
| comptotaldatacompressionratio | <Double> | Read-only | Ratio of total HTTP data received to total HTTP data transmitted. |
| comphttpbandwidthsaving | <Double> | Read-only | Bandwidth saving from TCP compression expressed as percentage. |
| compratio | <Double> | Read-only | Ratio of the compressible data received from the server to the compressed data sent to the client. |
| comptotalrequests | <Double> | Read-only | Number of HTTP compression requests the Citrix ADC receives for which the response is successfully compressed. For example, after you enable compression and configure services, if you send HTTP requests to the Citrix ADC using a HTTP client that supports compression, and Citrix ADC compresses the corresponding response, this counter is incremented. |
| comprequestsrate | <Double> | Read-only | Rate (/s) counter for comptotalrequests |
| comptotalrxbytes | <Double> | Read-only | Number of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server. |
| comprxbytesrate | <Double> | Read-only | Rate (/s) counter for comptotalrxbytes |
| comptotaltxbytes | <Double> | Read-only | Number of bytes the Citrix ADC sends to the client after compressing the response from the server. |
| comptxbytesrate | <Double> | Read-only | Rate (/s) counter for comptotaltxbytes |
| comptotalrxpackets | <Double> | Read-only | Number of HTTP packets that can be compressed, which the Citrix ADC receives from the server. |
| comprxpacketsrate | <Double> | Read-only | Rate (/s) counter for comptotalrxpackets |
| comptotaltxpackets | <Double> | Read-only | Number of HTTP packets that the Citrix ADC sends to the client after compressing the response from the server. |
| comptxpacketsrate | <Double> | Read-only | Rate (/s) counter for comptotaltxpackets |
| comptcptotalrxbytes | <Double> | Read-only | Number of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server. |
| comptcprxbytesrate | <Double> | Read-only | Rate (/s) counter for comptcptotalrxbytes |
| comptcptotalrxpackets | <Double> | Read-only | Total number of compressible packets received by Citrix ADC. |
| comptcprxpacketsrate | <Double> | Read-only | Rate (/s) counter for comptcptotalrxpackets |
| comptcptotaltxbytes | <Double> | Read-only | Number of bytes that the Citrix ADC sends to the client after compressing the response from the server. |
| comptcptxbytesrate | <Double> | Read-only | Rate (/s) counter for comptcptotaltxbytes |
| comptcptotaltxpackets | <Double> | Read-only | Number of TCP packets that the Citrix ADC sends to the client after compressing the response from the server. |
| comptcptxpacketsrate | <Double> | Read-only | Rate (/s) counter for comptcptotaltxpackets |
| comptcptotalquantum | <Double> | Read-only | Number of times the Citrix ADC compresses a quantum of data. Citrix ADC buffers the data received from the server till it reaches the quantum size and then compresses the buffered data and transmits to the client. |
| comptcpquantumrate | <Double> | Read-only | Rate (/s) counter for comptcptotalquantum |
| comptcptotalpush | <Double> | Read-only | Number of times the Citrix ADC compresses data on receiving a TCP PUSH flag from the server. The PUSH flag ensures that data is compressed immediately without waiting for the buffered data size to reach the quantum size. |
| comptcppushrate | <Double> | Read-only | Rate (/s) counter for comptcptotalpush |
| comptcptotaleoi | <Double> | Read-only | Number of times the Citrix ADC compresses data on receiving End Of Input (FIN packet). When the Citrix ADC receives End Of Input (FIN packet), it compresses the buffered data immediately without waiting for the buffered data size to reach the quantum size. |
| comptcpeoirate | <Double> | Read-only | Rate (/s) counter for comptcptotaleoi |
| comptcptotaltimer | <Double> | Read-only | Number of times the Citrix ADC compresses data on expiration of data accumulation timer. The timer expires if the server response is very slow and consequently, the Citrix ADC does not receive response for a certain amount of time. Under such a condition, the Citrix ADC compresses the buffered data immediately without waiting for the buffered data size to reach the quantum size. |
| comptcptimerrate | <Double> | Read-only | Rate (/s) counter for comptcptotaltimer |
| decomptcprxbytes | <Double> | Read-only | Total number of compressed bytes received by Citrix ADC. |
| decomptcprxbytesrate | <Double> | Read-only | Rate (/s) counter for decomptcprxbytes |
| decomptcprxpackets | <Double> | Read-only | Total number of compressed packets received by Citrix ADC. |
| decomptcprxpacketsrate | <Double> | Read-only | Rate (/s) counter for decomptcprxpackets |
| decomptcptxbytes | <Double> | Read-only | Total number of decompressed bytes transmitted by Citrix ADC. |
| decomptcptxbytesrate | <Double> | Read-only | Rate (/s) counter for decomptcptxbytes |
| decomptcptxpackets | <Double> | Read-only | Total number of decompressed packets transmitted by Citrix ADC. |
| decomptcptxpacketsrate | <Double> | Read-only | Rate (/s) counter for decomptcptxpackets |
| decomptcperrdata | <Double> | Read-only | Number of data errors encountered while decompressing. |
| decomptcperrdatarate | <Double> | Read-only | Rate (/s) counter for decomptcperrdata |
| decomptcperrlessdata | <Double> | Read-only | Number of times Citrix ADC received less data than declared by protocol. |
| decomptcperrlessdatarate | <Double> | Read-only | Rate (/s) counter for decomptcperrlessdata |
| decomptcperrmoredata | <Double> | Read-only | Number of times Citrix ADC received more data than declared by protocol. |
| decomptcperrmoredatarate | <Double> | Read-only | Rate (/s) counter for decomptcperrmoredata |
| decomptcperrmemory | <Double> | Read-only | Number of times memory failures occurred while decompressing. |
| decomptcperrmemoryrate | <Double> | Read-only | Rate (/s) counter for decomptcperrmemory |
| decomptcperrunknown | <Double> | Read-only | Number of times unknown errors occurred while decompressing. |
| decomptcperrunknownrate | <Double> | Read-only | Rate (/s) counter for decomptcperrunknown |
| delcomptotalrequests | <Double> | Read-only | Total number of delta compression requests received by Citrix ADC. |
| delcomprequestsrate | <Double> | Read-only | Rate (/s) counter for delcomptotalrequests |
| delcompdone | <Double> | Read-only | Total number of delta compressions done by Citrix ADC. |
| delcompdonerate | <Double> | Read-only | Rate (/s) counter for delcompdone |
| delcomptcprxbytes | <Double> | Read-only | Total number of delta-compressible bytes received by Citrix ADC. |
| delcomptcprxbytesrate | <Double> | Read-only | Rate (/s) counter for delcomptcprxbytes |
| delcomptcptxbytes | <Double> | Read-only | Total number of delta-compressed bytes transmitted by Citrix ADC. |
| delcomptcptxbytesrate | <Double> | Read-only | Rate (/s) counter for delcomptcptxbytes |
| delcompfirstaccess | <Double> | Read-only | Total number of delta compression first accesses. |
| delcompfirstaccessrate | <Double> | Read-only | Rate (/s) counter for delcompfirstaccess |
| delcomptcprxpackets | <Double> | Read-only | Number of delta-compressible packets received. |
| delcomptcprxpacketsrate | <Double> | Read-only | Rate (/s) counter for delcomptcprxpackets |
| delcomptcptxpackets | <Double> | Read-only | Total number of delta-compressed packets transmitted by Citrix ADC. |
| delcomptcptxpacketsrate | <Double> | Read-only | Rate (/s) counter for delcomptcptxpackets |
| delcompbaseserved | <Double> | Read-only | Total number of basefile requests served by Citrix ADC. |
| delcompbaseservedrate | <Double> | Read-only | Rate (/s) counter for delcompbaseserved |
| delcompbasetcptxbytes | <Double> | Read-only | Number of basefile bytes transmitted by Citrix ADC. |
| delcompbasetcptxbytesrate | <Double> | Read-only | Rate (/s) counter for delcompbasetcptxbytes |
| delcomperrbypassed | <Double> | Read-only | Number of times delta-compression bypassed by Citrix ADC. |
| delcomperrbypassedrate | <Double> | Read-only | Rate (/s) counter for delcomperrbypassed |
| delcomperrbfilewhdrfailed | <Double> | Read-only | Number of times basefile could not be updated in Citrix ADC cache. |
| delcomperrbfilewhdrfailedrate | <Double> | Read-only | Rate (/s) counter for delcomperrbfilewhdrfailed |
| delcomperrnostoremiss | <Double> | Read-only | Number of times basefile was not found in Citrix ADC cache. |
| delcomperrnostoremissrate | <Double> | Read-only | Rate (/s) counter for delcomperrnostoremiss |
| delcomperrreqinfotoobig | <Double> | Read-only | Number of times basefile request URL was too large. |
| delcomperrreqinfotoobigrate | <Double> | Read-only | Rate (/s) counter for delcomperrreqinfotoobig |
| delcomperrreqinfoallocfail | <Double> | Read-only | Number of times requested basefile could not be allocated. |
| delcomperrreqinfoallocfailrate | <Double> | Read-only | Rate (/s) counter for delcomperrreqinfoallocfail |
| delcomperrsessallocfail | <Double> | Read-only | Number of times delta compression session could not be allocated. |
| delcomperrsessallocfailrate | <Double> | Read-only | Rate (/s) counter for delcomperrsessallocfail |
Operations
(click to see Properties )
- GET (ALL)
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/cmp
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/stat/cmp? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get cmp 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:
{ "cmp": [ {
"comphttpbandwidthsaving":<Double_value>,
"decomptcptxpacketsrate":<Double_value>,
"delcompbasetcptxbytesrate":<Double_value>,
"comptotaltxbytes":<Double_value>,
"comptcpeoirate":<Double_value>,
"delcomperrbypassedrate":<Double_value>,
"delcmpratio":<Double_value>,
"delcomprequestsrate":<Double_value>,
"delcomptcprxpacketsrate":<Double_value>,
"decomptcperrmemory":<Double_value>,
"comptotaldatacompressionratio":<Double_value>,
"comprxbytesrate":<Double_value>,
"delcomperrsessallocfailrate":<Double_value>,
"delcomptcptxpacketsrate":<Double_value>,
"decomptcperrmemoryrate":<Double_value>,
"decomptcperrmoredata":<Double_value>,
"delcompfirstaccessrate":<Double_value>,
"comprxpacketsrate":<Double_value>,
"decomptcprxpacketsrate":<Double_value>,
"comptcpquantumrate":<Double_value>,
"comptxbytesrate":<Double_value>,
"delcompbaseservedrate":<Double_value>,
"comptcptxbytesrate":<Double_value>,
"delcomptcprxpackets":<Double_value>,
"delcomperrbfilewhdrfailed":<Double_value>,
"decomptcperrmoredatarate":<Double_value>,
"delcompbaseserved":<Double_value>,
"compratio":<Double_value>,
"decomptcperrlessdata":<Double_value>,
"comptcprxbytesrate":<Double_value>,
"comptcprxpacketsrate":<Double_value>,
"delcomptcptxbytesrate":<Double_value>,
"decomptcperrdatarate":<Double_value>,
"delcompdonerate":<Double_value>,
"decomptcpratio":<Double_value>,
"decomptcperrlessdatarate":<Double_value>,
"comptcptotaltxbytes":<Double_value>,
"delcomptotalrequests":<Double_value>,
"delcomperrreqinfoallocfailrate":<Double_value>,
"delcomperrnostoremiss":<Double_value>,
"delcompbasetcptxbytes":<Double_value>,
"comptcptotalpush":<Double_value>,
"delcompfirstaccess":<Double_value>,
"delcompdone":<Double_value>,
"comptcptotalrxpackets":<Double_value>,
"delcomperrbypassed":<Double_value>,
"delbwsaving":<Double_value>,
"comprequestsrate":<Double_value>,
"delcomptcptxbytes":<Double_value>,
"delcomperrreqinfoallocfail":<Double_value>,
"delcomperrreqinfotoobig":<Double_value>,
"decomptcprxbytes":<Double_value>,
"comptcptxpacketsrate":<Double_value>,
"comptcptotaleoi":<Double_value>,
"comptcppushrate":<Double_value>,
"decomptcperrunknownrate":<Double_value>,
"comptcpbandwidthsaving":<Double_value>,
"comptotalrxbytes":<Double_value>,
"decomptcptxbytes":<Double_value>,
"decomptcprxpackets":<Double_value>,
"comptcptotaltimer":<Double_value>,
"delcomperrnostoremissrate":<Double_value>,
"decomptcpbandwidthsaving":<Double_value>,
"delcomperrsessallocfail":<Double_value>,
"decomptcptxbytesrate":<Double_value>,
"comptxpacketsrate":<Double_value>,
"comptotaltxpackets":<Double_value>,
"delcomperrreqinfotoobigrate":<Double_value>,
"decomptcprxbytesrate":<Double_value>,
"comptotalrequests":<Double_value>,
"decomptcperrunknown":<Double_value>,
"comptotalrxpackets":<Double_value>,
"delcomptcprxbytes":<Double_value>,
"comptcptimerrate":<Double_value>,
"comptcptotalquantum":<Double_value>,
"comptcptotaltxpackets":<Double_value>,
"delcomptcptxpackets":<Double_value>,
"comptcptotalrxbytes":<Double_value>,
"delcomptcprxbytesrate":<Double_value>,
"decomptcptxpackets":<Double_value>,
"delcomperrbfilewhdrfailedrate":<Double_value>,
"comptcpratio":<Double_value>,
"decomptcperrdata":<Double_value>
}]}
<!--NeedCopy-->
cmp
In this article
Copied!
Failed!