Product Documentation

qos

Sep 08, 2016

Statistics for qos.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
ipcmessagessent
<Double>
Read-only
IPC messages sent from qos system.
ipcmessagessentrate
<Double>
Read-only
Rate (/s) counter for ipcmessagessent
ipcmessagesfailed
<Double>
Read-only
IPC messages failed to send from qos system.
ipcmessagesfailedrate
<Double>
Read-only
Rate (/s) counter for ipcmessagesfailed
ipcmessagesreceived
<Double>
Read-only
IPC messages received by qos.
ipcmessagesreceivedrate
<Double>
Read-only
Rate (/s) counter for ipcmessagesreceived
ipcpe2qossent
<Double>
Read-only
IPC messages sent to qos system.
ipcpe2qossentrate
<Double>
Read-only
Rate (/s) counter for ipcpe2qossent
ipcpe2qosfailed
<Double>
Read-only
IPC messages failed to send to qos system.
ipcpe2qosfailedrate
<Double>
Read-only
Rate (/s) counter for ipcpe2qosfailed
ipcpe2qosreceived
<Double>
Read-only
IPC messages received from qos system.
ipcpe2qosreceivedrate
<Double>
Read-only
Rate (/s) counter for ipcpe2qosreceived
qosbytesdropped
<Double>
Read-only
Bytes QoS marked for drop
qosbytesdroppedrate
<Double>
Read-only
Rate (/s) counter for qosbytesdropped
qosbytessentnotclassified
<Double>
Read-only
Bytes scheduled by QoS that were not classified.
qosbytessentnotclassifiedrate
<Double>
Read-only
Rate (/s) counter for qosbytessentnotclassified
qosbytesdroppednoconnection
<Double>
Read-only
Bytes dropped by QoS when no connection was found.
qosbytesdroppednoconnectionrate
<Double>
Read-only
Rate (/s) counter for qosbytesdroppednoconnection
qosinputpackets
<Double>
Read-only
Packets sent to QoS for scheduling.
qosinputpacketsrate
<Double>
Read-only
Rate (/s) counter for qosinputpackets
qosoutputpackets
<Double>
Read-only
Packets from QoS to be sent
qosoutputpacketsrate
<Double>
Read-only
Rate (/s) counter for qosoutputpackets
qosdroppackets
<Double>
Read-only
Packets Dropped by QoS.
qosdroppacketsrate
<Double>
Read-only
Rate (/s) counter for qosdroppackets
qosrewritemacs
<Double>
Read-only
Number of packets with inband classification in source MAC.
qosrewritemacsrate
<Double>
Read-only
Rate (/s) counter for qosrewritemacs
qospacketsunclassified
<Double>
Read-only
Number of packets without classification.
qospacketsunclassifiedrate
<Double>
Read-only
Rate (/s) counter for qospacketsunclassified
qospacketsclassified
<Double>
Read-only
Number of packets with classification.
qospacketsclassifiedrate
<Double>
Read-only
Rate (/s) counter for qospacketsclassified
qoslearnedmac
<Double>
Read-only
QoS learned true MAC
qoslearnedmacrate
<Double>
Read-only
Rate (/s) counter for qoslearnedmac
qosinputbytes
<Double>
Read-only
Bytes sent to QoS for scheduling
qosinputbytesrate
<Double>
Read-only
Rate (/s) counter for qosinputbytes
qosoutputbytes
<Double>
Read-only
Bytes received from QoS to be sent
qosoutputbytesrate
<Double>
Read-only
Rate (/s) counter for qosoutputbytes
qosfreeheldlist
<Double>
Read-only
No. more packets QoS can hold onto.
qoslink00sent
<Double>
Read-only
QoS bytes sent on Link 00
qoslink00sentrate
<Double>
Read-only
Rate (/s) counter for qoslink00sent
qoslink00drop
<Double>
Read-only
QoS bytes dropped on Link 00
qoslink00droprate
<Double>
Read-only
Rate (/s) counter for qoslink00drop
qoslink01sent
<Double>
Read-only
QoS bytes sent on Link 01
qoslink01sentrate
<Double>
Read-only
Rate (/s) counter for qoslink01sent
qoslink01drop
<Double>
Read-only
QoS bytes dropped on Link 01
qoslink01droprate
<Double>
Read-only
Rate (/s) counter for qoslink01drop
qoslink02sent
<Double>
Read-only
QoS bytes sent on Link 02
qoslink02sentrate
<Double>
Read-only
Rate (/s) counter for qoslink02sent
qoslink02drop
<Double>
Read-only
QoS bytes dropped on Link 02
qoslink02droprate
<Double>
Read-only
Rate (/s) counter for qoslink02drop
qoslink03sent
<Double>
Read-only
QoS bytes sent on Link 03
qoslink03sentrate
<Double>
Read-only
Rate (/s) counter for qoslink03sent
qoslink03drop
<Double>
Read-only
QoS bytes dropped on Link 03
qoslink03droprate
<Double>
Read-only
Rate (/s) counter for qoslink03drop
qoslink04sent
<Double>
Read-only
QoS bytes sent on Link 04
qoslink04sentrate
<Double>
Read-only
Rate (/s) counter for qoslink04sent
qoslink04drop
<Double>
Read-only
QoS bytes dropped on Link 04
qoslink04droprate
<Double>
Read-only
Rate (/s) counter for qoslink04drop
qoslink05sent
<Double>
Read-only
QoS bytes sent on Link 05
qoslink05sentrate
<Double>
Read-only
Rate (/s) counter for qoslink05sent
qoslink05drop
<Double>
Read-only
QoS bytes dropped on Link 05
qoslink05droprate
<Double>
Read-only
Rate (/s) counter for qoslink05drop
qoslink06sent
<Double>
Read-only
QoS bytes sent on Link 06
qoslink06sentrate
<Double>
Read-only
Rate (/s) counter for qoslink06sent
qoslink06drop
<Double>
Read-only
QoS bytes dropped on Link 06
qoslink06droprate
<Double>
Read-only
Rate (/s) counter for qoslink06drop
qoslink07sent
<Double>
Read-only
QoS bytes sent on Link 07
qoslink07sentrate
<Double>
Read-only
Rate (/s) counter for qoslink07sent
qoslink07drop
<Double>
Read-only
QoS bytes dropped on Link 07
qoslink07droprate
<Double>
Read-only
Rate (/s) counter for qoslink07drop
qoslink08sent
<Double>
Read-only
QoS bytes sent on Link 08
qoslink08sentrate
<Double>
Read-only
Rate (/s) counter for qoslink08sent
qoslink08drop
<Double>
Read-only
QoS bytes dropped on Link 08
qoslink08droprate
<Double>
Read-only
Rate (/s) counter for qoslink08drop
qoslink09sent
<Double>
Read-only
QoS bytes sent on Link 09
qoslink09sentrate
<Double>
Read-only
Rate (/s) counter for qoslink09sent
qoslink09drop
<Double>
Read-only
QoS bytes dropped on Link 09
qoslink09droprate
<Double>
Read-only
Rate (/s) counter for qoslink09drop
qoslink10sent
<Double>
Read-only
QoS bytes sent on Link 10
qoslink10sentrate
<Double>
Read-only
Rate (/s) counter for qoslink10sent
qoslink10drop
<Double>
Read-only
QoS bytes dropped on Link 10
qoslink10droprate
<Double>
Read-only
Rate (/s) counter for qoslink10drop

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

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

Use this query-parameter to get qos 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 Headers:

Content-Type:application/json

Response Payload:

{ "qos": [ {
      "qoslink06droprate":<Double_value>,
      "ipcpe2qosfailed":<Double_value>,
      "qoslink02sent":<Double_value>,
      "qoslink10sent":<Double_value>,
      "ipcmessagessentrate":<Double_value>,
      "qoslink02sentrate":<Double_value>,
      "qosrewritemacsrate":<Double_value>,
      "qoslink08sentrate":<Double_value>,
      "qoslink04drop":<Double_value>,
      "qoslink01droprate":<Double_value>,
      "qosoutputbytesrate":<Double_value>,
      "qoslink08drop":<Double_value>,
      "qoslink05sent":<Double_value>,
      "qoslink10droprate":<Double_value>,
      "qoslink00drop":<Double_value>,
      "ipcmessagesfailedrate":<Double_value>,
      "qoslink05droprate":<Double_value>,
      "qoslink08droprate":<Double_value>,
      "qosbytessentnotclassifiedrate":<Double_value>,
      "qoslink03droprate":<Double_value>,
      "qoslink09sent":<Double_value>,
      "qospacketsunclassifiedrate":<Double_value>,
      "qosfreeheldlist":<Double_value>,
      "qospacketsclassified":<Double_value>,
      "qosbytesdroppednoconnectionrate":<Double_value>,
      "qoslink01sentrate":<Double_value>,
      "qoslink09sentrate":<Double_value>,
      "qoslink03drop":<Double_value>,
      "qoslink03sentrate":<Double_value>,
      "qoslink02drop":<Double_value>,
      "qosinputbytes":<Double_value>,
      "qosinputpacketsrate":<Double_value>,
      "qosoutputbytes":<Double_value>,
      "ipcmessagesfailed":<Double_value>,
      "qoslink07sentrate":<Double_value>,
      "qosinputbytesrate":<Double_value>,
      "qoslink04droprate":<Double_value>,
      "ipcpe2qosfailedrate":<Double_value>,
      "qosoutputpackets":<Double_value>,
      "qosbytesdroppedrate":<Double_value>,
      "qoslink06sent":<Double_value>,
      "qoslink04sent":<Double_value>,
      "qoslink00sent":<Double_value>,
      "qoslink07sent":<Double_value>,
      "qoslink09droprate":<Double_value>,
      "qoslink10drop":<Double_value>,
      "qospacketsunclassified":<Double_value>,
      "qosoutputpacketsrate":<Double_value>,
      "qoslink03sent":<Double_value>,
      "qoslink05sentrate":<Double_value>,
      "qoslink04sentrate":<Double_value>,
      "qosbytesdropped":<Double_value>,
      "qosdroppackets":<Double_value>,
      "qoslink06drop":<Double_value>,
      "qosinputpackets":<Double_value>,
      "qoslink07droprate":<Double_value>,
      "ipcmessagesreceived":<Double_value>,
      "qoslink09drop":<Double_value>,
      "qoslink02droprate":<Double_value>,
      "qoslink07drop":<Double_value>,
      "qoslink05drop":<Double_value>,
      "ipcpe2qosreceivedrate":<Double_value>,
      "qoslink00sentrate":<Double_value>,
      "ipcpe2qossent":<Double_value>,
      "qoslink01sent":<Double_value>,
      "qoslearnedmacrate":<Double_value>,
      "qoslink08sent":<Double_value>,
      "qoslink06sentrate":<Double_value>,
      "qoslink01drop":<Double_value>,
      "ipcmessagesreceivedrate":<Double_value>,
      "ipcpe2qossentrate":<Double_value>,
      "qosbytessentnotclassified":<Double_value>,
      "qoslearnedmac":<Double_value>,
      "ipcmessagessent":<Double_value>,
      "qoslink00droprate":<Double_value>,
      "qoslink10sentrate":<Double_value>,
      "ipcpe2qosreceived":<Double_value>,
      "qosdroppacketsrate":<Double_value>,
      "qosbytesdroppednoconnection":<Double_value>,
      "qospacketsclassifiedrate":<Double_value>,
      "qosrewritemacs":<Double_value>
}]}