protocolquic
Statistics for QUIC protocol resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats |
|
Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| quicclientdgrmrcvd |
|
Read-only | Total QUIC client UDP datagrams received |
| quicclientdgrmrcvdrate |
|
Read-only | Rate (/s) counter for quicclientdgrmrcvd |
| quicserverdgrmrcvd |
|
Read-only | Total QUIC server UDP datagrams received |
| quicserverdgrmrcvdrate |
|
Read-only | Rate (/s) counter for quicserverdgrmrcvd |
| quicclientdgrmsent |
|
Read-only | Total QUIC client UDP datagrams sent |
| quicclientdgrmsentrate |
|
Read-only | Rate (/s) counter for quicclientdgrmsent |
| quicserverdgrmsent |
|
Read-only | Total QUIC server UDP datagrams sent |
| quicserverdgrmsentrate |
|
Read-only | Rate (/s) counter for quicserverdgrmsent |
| quiccurclientconn |
|
Read-only | Current QUIC client connections |
| quiccurclientconnrate |
|
Read-only | Rate (/s) counter for quiccurclientconn |
| quiccurserverconn |
|
Read-only | Current QUIC server connections |
| quiccurserverconnrate |
|
Read-only | Rate (/s) counter for quiccurserverconn |
| quiclocalconnid |
|
Read-only | Current QUIC local connection IDs allocated |
| quiclocalconnidrate |
|
Read-only | Rate (/s) counter for quiclocalconnid |
| quiccursavedcryptoctx |
|
Read-only | Current QUIC crypto contexts allocated |
| quiccursavedcryptoctxrate |
|
Read-only | Rate (/s) counter for quiccursavedcryptoctx |
| quictotclientconn |
|
Read-only | Total QUIC client connections |
| quicclientconnrate |
|
Read-only | Rate (/s) counter for quictotclientconn |
| quictotserverconn |
|
Read-only | Total QUIC server connections |
| quicserverconnrate |
|
Read-only | Rate (/s) counter for quictotserverconn |
| quicmigratedconn |
|
Read-only | Total number of migrated QUIC connections |
| quicmigratedconnrate |
|
Read-only | Rate (/s) counter for quicmigratedconn |
| quicjumboframesrcvd |
|
Read-only | Total number of QUIC jumbo frames received |
| quicjumboframesrcvdrate |
|
Read-only | Rate (/s) counter for quicjumboframesrcvd |
| quicretrypktsent |
|
Read-only | Number of QUIC Retry packets sent |
| quicretrypktsentrate |
|
Read-only | Rate (/s) counter for quicretrypktsent |
| quichandshakecmpltd |
|
Read-only | Number of QUIC handshake messages completed |
| quichandshakecmpltdrate |
|
Read-only | Rate (/s) counter for quichandshakecmpltd |
| quictransptconnclosepktsent |
|
Read-only | Number of QUIC transport no-error Connection Close packets sent |
| quictransptconnclosepktsentrate |
|
Read-only | Rate (/s) counter for quictransptconnclosepktsent |
| quicappconnclosepktsent |
|
Read-only | Number of QUIC application no-error Connection Close packets sent |
| quicappconnclosepktsentrate |
|
Read-only | Rate (/s) counter for quicappconnclosepktsent |
| quicasyncdatagramssent |
|
Read-only | Number of QUIC datagrams sent using async mode |
| quicasyncdatagramssentrate |
|
Read-only | Rate (/s) counter for quicasyncdatagramssent |
| quicconninfoalcfail |
|
Read-only | Quic session allocations failed |
| quicconninfoalcfailrate |
|
Read-only | Rate (/s) counter for quicconninfoalcfail |
| quicnsbalcfail |
|
Read-only | Quic NSB allocations failed |
| quicnsbalcfailrate |
|
Read-only | Rate (/s) counter for quicnsbalcfail |
| quictlsalertsent |
|
Read-only | Total QUIC TLS 1.3 transport errors sent |
| quictlsalertsentrate |
|
Read-only | Rate (/s) counter for quictlsalertsent |
| quicstlessconnclosepktsent |
|
Read-only | Number of QUIC stateless Connection Close packets sent |
| quicstlessconnclosepktsentrate |
|
Read-only | Rate (/s) counter for quicstlessconnclosepktsent |
| quicvernegpktsent |
|
Read-only | Number of QUIC Version Negotiation packets sent |
| quicvernegpktsentrate |
|
Read-only | Rate (/s) counter for quicvernegpktsent |
| quictransptconnclosepktfail |
|
Read-only | Number of QUIC transport error Connection Close packets sent |
| quictransptconnclosepktfailrate |
|
Read-only | Rate (/s) counter for quictransptconnclosepktfail |
| quicappconnclosepktfail |
|
Read-only | Number of QUIC application error Connection Close packets sent |
| quicappconnclosepktfailrate |
|
Read-only | Rate (/s) counter for quicappconnclosepktfail |
| quicretrytokenverfail |
|
Read-only | Number of times QUIC Retry token verification failed |
| quicretrytokenverfailrate |
|
Read-only | Rate (/s) counter for quicretrytokenverfail |
| quicnewtokenverfail |
|
Read-only | Number of times QUIC NEW_TOKEN token verification failed |
| quicnewtokenverfailrate |
|
Read-only | Rate (/s) counter for quicnewtokenverfail |
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/protocolquic Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/protocolquic? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get protocolquic resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/stat/protocolquic? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
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:
{ "protocolquic": [ {
"quicstlessconnclosepktsent":<Double_value>,
"quiccursavedcryptoctxrate":<Double_value>,
"quictotserverconn":<Double_value>,
"quiclocalconnid":<Double_value>,
"quicclientconnrate":<Double_value>,
"quicretrypktsent":<Double_value>,
"quicappconnclosepktfail":<Double_value>,
"quicjumboframesrcvdrate":<Double_value>,
"quicnsbalcfail":<Double_value>,
"quicnewtokenverfailrate":<Double_value>,
"quicserverdgrmrcvd":<Double_value>,
"quichandshakecmpltd":<Double_value>,
"quiccurserverconn":<Double_value>,
"quictransptconnclosepktfailrate":<Double_value>,
"quicserverconnrate":<Double_value>,
"quicjumboframesrcvd":<Double_value>,
"quicstlessconnclosepktsentrate":<Double_value>,
"quicretrytokenverfail":<Double_value>,
"quiccursavedcryptoctx":<Double_value>,
"quicnewtokenverfail":<Double_value>,
"quiclocalconnidrate":<Double_value>,
"quicserverdgrmrcvdrate":<Double_value>,
"quicnsbalcfailrate":<Double_value>,
"quicclientdgrmsentrate":<Double_value>,
"quiccurclientconn":<Double_value>,
"quictransptconnclosepktsent":<Double_value>,
"quicretrypktsentrate":<Double_value>,
"quicasyncdatagramssent":<Double_value>,
"quicserverdgrmsent":<Double_value>,
"quicvernegpktsentrate":<Double_value>,
"quiccurserverconnrate":<Double_value>,
"quicconninfoalcfailrate":<Double_value>,
"quictransptconnclosepktsentrate":<Double_value>,
"quicclientdgrmsent":<Double_value>,
"quicmigratedconnrate":<Double_value>,
"quictotclientconn":<Double_value>,
"quicclientdgrmrcvdrate":<Double_value>,
"quicappconnclosepktfailrate":<Double_value>,
"quichandshakecmpltdrate":<Double_value>,
"quictransptconnclosepktfail":<Double_value>,
"quiccurclientconnrate":<Double_value>,
"quicserverdgrmsentrate":<Double_value>,
"quicmigratedconn":<Double_value>,
"quicappconnclosepktsent":<Double_value>,
"quicretrytokenverfailrate":<Double_value>,
"quictlsalertsentrate":<Double_value>,
"quicconninfoalcfail":<Double_value>,
"quicvernegpktsent":<Double_value>,
"quicappconnclosepktsentrate":<Double_value>,
"quicclientdgrmrcvd":<Double_value>,
"quicasyncdatagramssentrate":<Double_value>,
"quictlsalertsent":<Double_value>
}]}