ADC NITRO APIs
qos
Statistics for qos.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name |
|
Read-write | . |
| clearstats |
|
Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| snmpqosqos_packets_received |
|
Read-only | Receive direction packets processed by QoS |
| snmpqosqos_packets_receivedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_packets_received |
| snmpqosqos_packets_sent |
|
Read-only | Send direction packets processed by QoS |
| snmpqosqos_packets_sentrate |
|
Read-only | Rate (/s) counter for snmpqosqos_packets_sent |
| snmpqosqos_packets_bypassed |
|
Read-only | Packets bypassing QoS |
| snmpqosqos_packets_bypassedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_packets_bypassed |
| snmpqosqos_packets_dropped |
|
Read-only | Total packets dropped |
| snmpqosqos_packets_droppedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_packets_dropped |
| snmpqosqos_bytes_rx |
|
Read-only | Received bytes processed by QoS |
| snmpqosqos_bytes_rxrate |
|
Read-only | Rate (/s) counter for snmpqosqos_bytes_rx |
| snmpqosqos_bytes_tx |
|
Read-only | Sent bytes processed by QoS |
| snmpqosqos_bytes_txrate |
|
Read-only | Rate (/s) counter for snmpqosqos_bytes_tx |
| snmpqosqos_lazy_bytes |
|
Read-only | QoS lazy byte optimization rate |
| snmpqosqos_lazy_bytesrate |
|
Read-only | Rate (/s) counter for snmpqosqos_lazy_bytes |
| snmpqosqos_real_bytes |
|
Read-only | QoS actual bytes scheduled |
| snmpqosqos_real_bytesrate |
|
Read-only | Rate (/s) counter for snmpqosqos_real_bytes |
| snmpqosqos_packets_filtered |
|
Read-only | Total packets filtered by QoS |
| snmpqosqos_packets_filteredrate |
|
Read-only | Rate (/s) counter for snmpqosqos_packets_filtered |
| snmpqosqos_packets_classified |
|
Read-only | Total packets classified by QoS |
| snmpqosqos_packets_classifiedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_packets_classified |
| snmpqosqos_flows |
|
Read-only | New QoS flows |
| snmpqosqos_flowsrate |
|
Read-only | Rate (/s) counter for snmpqosqos_flows |
| snmpqosqos_flow_recycles |
|
Read-only | Recycled QoS flows |
| snmpqosqos_flow_recyclesrate |
|
Read-only | Rate (/s) counter for snmpqosqos_flow_recycles |
| snmpqosqos_session_recycle_failure |
|
Read-only | QoS Flow Recycle failures |
| snmpqosqos_session_recycle_failurerate |
|
Read-only | Rate (/s) counter for snmpqosqos_session_recycle_failure |
| snmpqosqos_sessions_ignored |
|
Read-only | Sessions manually ignored |
| snmpqosqos_sessions_ignoredrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sessions_ignored |
| snmpqosqos_sessions_consumed |
|
Read-only | sessions manually consumed |
| snmpqosqos_sessions_consumedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sessions_consumed |
| snmpqosqos_actions_created |
|
Read-only | Uneque qos action objects created |
| snmpqosqos_actions_createdrate |
|
Read-only | Rate (/s) counter for snmpqosqos_actions_created |
| snmpqosqos_policy_reeval |
|
Read-only | Policies re-evaluated due to cli change |
| snmpqosqos_policy_reevalrate |
|
Read-only | Rate (/s) counter for snmpqosqos_policy_reeval |
| snmpqosqos_cfy_tcp_unknown |
|
Read-only | Connections unable to be classified beyond TCP |
| snmpqosqos_cfy_tcp_unknownrate |
|
Read-only | Rate (/s) counter for snmpqosqos_cfy_tcp_unknown |
| snmpqosqos_cfy_udp_unknown |
|
Read-only | Connections unable to be classified beyond UDP |
| snmpqosqos_cfy_udp_unknownrate |
|
Read-only | Rate (/s) counter for snmpqosqos_cfy_udp_unknown |
| snmpqosqos_sch_leafs |
|
Read-only | Scheduler leaf nodes constructed |
| snmpqosqos_sch_leafsrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_leafs |
| snmpqosqos_session_mem |
|
Read-only | Session memory allocated |
| snmpqosqos_session_memrate |
|
Read-only | Rate (/s) counter for snmpqosqos_session_mem |
| snmpqosqos_sch_virtual_packets |
|
Read-only | Scheduler virtual packets constructed |
| snmpqosqos_sch_virtual_packetsrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_virtual_packets |
| snmpqosqos_sch_virtual_bytes_accepted |
|
Read-only | Scheduler bytes accepted |
| snmpqosqos_sch_virtual_bytes_acceptedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_virtual_bytes_accepted |
| snmpqosqos_sch_leaf_recycle_failures |
|
Read-only | Scheduler Failures to recycle QoS flows |
| snmpqosqos_sch_leaf_recycle_failuresrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_leaf_recycle_failures |
| snmpqosqos_sch_node_regulated_count |
|
Read-only | Scheduler Regulated node count |
| snmpqosqos_sch_node_regulated_countrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_node_regulated_count |
| snmpqosqos_sch_sessions_created |
|
Read-only | Scheduler session classes constructed |
| snmpqosqos_sch_sessions_createdrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_sessions_created |
| snmpqosqos_sch_sessions_deleted |
|
Read-only | Scheduler session classes constructed |
| snmpqosqos_sch_sessions_deletedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_sessions_deleted |
| snmpqosqos_sch_sdrr_nodes |
|
Read-only | Scheduler sdrr nodes constructed |
| snmpqosqos_sch_sdrr_nodesrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_sdrr_nodes |
| snmpqosqos_sch_session_conns |
|
Read-only | Scheduler session connections created |
| snmpqosqos_sch_session_connsrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_session_conns |
| snmpqosqos_sch_session_conns_removed |
|
Read-only | Scheduler session connections removed |
| snmpqosqos_sch_session_conns_removedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_session_conns_removed |
| snmpqosqos_sch_sessions_regulated_count |
|
Read-only | Scheduler regulated sessions count |
| snmpqosqos_sch_sessions_regulated_countrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_sessions_regulated_count |
| snmpqosqos_sch_sessions_byte_count |
|
Read-only | Scheduler session bytes total |
| snmpqosqos_sch_sessions_byte_countrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_sessions_byte_count |
| snmpqosqos_sch_regulated_count |
|
Read-only | Scheduler regulated node count |
| snmpqosqos_sch_regulated_countrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_regulated_count |
| snmpqosqos_sch_links_created |
|
Read-only | Scheduler links created |
| snmpqosqos_sch_links_createdrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_links_created |
| snmpqosqos_sch_links_deleted |
|
Read-only | Scheduler links deleted |
| snmpqosqos_sch_links_deletedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_links_deleted |
| snmpqosqos_sch_links_updated |
|
Read-only | Scheduler links updated |
| snmpqosqos_sch_links_updatedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_links_updated |
| snmpqosqos_sch_poll_count |
|
Read-only | Scheduler calls to poll_libqos |
| snmpqosqos_sch_poll_countrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_poll_count |
| snmpqosqos_sch_peer_msgs |
|
Read-only | Scheduler peer messages received |
| snmpqosqos_sch_peer_msgsrate |
|
Read-only | Rate (/s) counter for snmpqosqos_sch_peer_msgs |
| snmpqosqos_error_ipc |
|
Read-only | IPC failed for QoS messages. |
| snmpqosqos_error_ipcrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_ipc |
| snmpqosqos_flow_mem |
|
Read-only | Flow memory allocated |
| snmpqosqos_flow_memrate |
|
Read-only | Rate (/s) counter for snmpqosqos_flow_mem |
| snmpqosqos_flows_available |
|
Read-only | Flows free list size |
| snmpqosqos_flows_availablerate |
|
Read-only | Rate (/s) counter for snmpqosqos_flows_available |
| snmpqosqos_recycle_failed_backlog |
|
Read-only | Recycle failed due to backlog |
| snmpqosqos_recycle_failed_backlograte |
|
Read-only | Rate (/s) counter for snmpqosqos_recycle_failed_backlog |
| snmpqosqos_recycle_failed_session |
|
Read-only | Recycle failed due to session attachment |
| snmpqosqos_recycle_failed_sessionrate |
|
Read-only | Rate (/s) counter for snmpqosqos_recycle_failed_session |
| snmpqosqos_error_create_action_failed |
|
Read-only | Failed attempts to create actions |
| snmpqosqos_error_create_action_failedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_create_action_failed |
| snmpqosqos_error_modify_action_failed |
|
Read-only | Failed attempts to modify actions |
| snmpqosqos_error_modify_action_failedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_modify_action_failed |
| snmpqosqos_error_remove_action_failed |
|
Read-only | Failed attempts to remove actions |
| snmpqosqos_error_remove_action_failedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_remove_action_failed |
| snmpqosqos_error_cli_unknown |
|
Read-only | Internal CLI error |
| snmpqosqos_error_cli_unknownrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_cli_unknown |
| snmpqosqos_error_rename_not_implemented |
|
Read-only | qos action rename not yet implemented |
| snmpqosqos_error_rename_not_implementedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_rename_not_implemented |
| snmpqosqos_error_remove_policy_failed |
|
Read-only | Failed attempts to remove qos policy |
| snmpqosqos_error_remove_policy_failedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_remove_policy_failed |
| snmpqosqos_error_create_policy_failed |
|
Read-only | Failed attempts to create qos policy |
| snmpqosqos_error_create_policy_failedrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_create_policy_failed |
| snmpqosqos_error_libqos_api_failures |
|
Read-only | Libqos api failures |
| snmpqosqos_error_libqos_api_failuresrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_libqos_api_failures |
| snmpqosqos_error_api_ses_invalidpcb |
|
Read-only | Libqos api qos_session_add_pcb/natpcb() failed for reason QS_EINVALIDPCB |
| snmpqosqos_error_api_ses_invalidpcbrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_api_ses_invalidpcb |
| snmpqosqos_error_api_ses_notready |
|
Read-only | Libqos api qos_session_add_pcb/natpcb() failed for reason QS_ENOTREADY |
| snmpqosqos_error_api_ses_notreadyrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_api_ses_notready |
| snmpqosqos_error_api_ses_add_insession |
|
Read-only | Libqos api qos_session_add_pcb/natpcb() failed for reason QS_EINSESSION |
| snmpqosqos_error_api_ses_add_insessionrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_api_ses_add_insession |
| snmpqosqos_error_api_ses_add_other |
|
Read-only | Libqos api qos_session_add_pcb/natpcb() failed |
| snmpqosqos_error_api_ses_add_otherrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_api_ses_add_other |
| snmpqosqos_error_api_ses_rem_notinsession |
|
Read-only | Libqos api qos_session_rem_pcb/natpcb() failed for reason QS_ENOTINSESSION |
| snmpqosqos_error_api_ses_rem_notinsessionrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_api_ses_rem_notinsession |
| snmpqosqos_error_api_ses_rem_other |
|
Read-only | Libqos api qos_session_rem_pcb/natpcb() failed |
| snmpqosqos_error_api_ses_rem_otherrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_api_ses_rem_other |
| snmpqosqos_error_api_ses_del |
|
Read-only | Libqos api qos_session_delete faled |
| snmpqosqos_error_api_ses_delrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_api_ses_del |
| snmpqosqos_error_no_flows |
|
Read-only | Libqos out of flow memory |
| snmpqosqos_error_no_flowsrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_no_flows |
| snmpqosqos_error_no_sessions |
|
Read-only | Libqos out of session memory |
| snmpqosqos_error_no_sessionsrate |
|
Read-only | Rate (/s) counter for snmpqosqos_error_no_sessions |
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/qos Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/qos? args=name: <String_value> ,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.
attrs http:// <netscaler-ip-address> /nitro/v1/stat/qos? 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:
{ "qos": [ {
"snmpqosqos_cfy_udp_unknownrate":<Double_value>,
"snmpqosqos_flow_memrate":<Double_value>,
"snmpqosqos_sch_sessions_createdrate":<Double_value>,
"snmpqosqos_sch_peer_msgs":<Double_value>,
"snmpqosqos_packets_classified":<Double_value>,
"snmpqosqos_sch_session_conns_removed":<Double_value>,
"snmpqosqos_sch_regulated_countrate":<Double_value>,
"snmpqosqos_actions_createdrate":<Double_value>,
"snmpqosqos_error_no_sessions":<Double_value>,
"snmpqosqos_flows_available":<Double_value>,
"snmpqosqos_sch_virtual_bytes_acceptedrate":<Double_value>,
"snmpqosqos_flowsrate":<Double_value>,
"snmpqosqos_packets_droppedrate":<Double_value>,
"snmpqosqos_lazy_bytesrate":<Double_value>,
"snmpqosqos_error_remove_policy_failed":<Double_value>,
"snmpqosqos_sch_links_deleted":<Double_value>,
"snmpqosqos_recycle_failed_backlograte":<Double_value>,
"snmpqosqos_real_bytesrate":<Double_value>,
"snmpqosqos_session_recycle_failurerate":<Double_value>,
"snmpqosqos_cfy_tcp_unknown":<Double_value>,
"snmpqosqos_error_rename_not_implementedrate":<Double_value>,
"snmpqosqos_sessions_ignoredrate":<Double_value>,
"snmpqosqos_bytes_rx":<Double_value>,
"snmpqosqos_error_remove_action_failed":<Double_value>,
"snmpqosqos_packets_filtered":<Double_value>,
"snmpqosqos_error_api_ses_add_insessionrate":<Double_value>,
"snmpqosqos_error_api_ses_notready":<Double_value>,
"snmpqosqos_recycle_failed_backlog":<Double_value>,
"snmpqosqos_sch_session_connsrate":<Double_value>,
"snmpqosqos_error_create_action_failed":<Double_value>,
"snmpqosqos_sch_virtual_packets":<Double_value>,
"snmpqosqos_packets_sent":<Double_value>,
"snmpqosqos_session_memrate":<Double_value>,
"snmpqosqos_error_api_ses_invalidpcb":<Double_value>,
"snmpqosqos_error_rename_not_implemented":<Double_value>,
"snmpqosqos_sch_links_createdrate":<Double_value>,
"snmpqosqos_bytes_rxrate":<Double_value>,
"snmpqosqos_error_api_ses_invalidpcbrate":<Double_value>,
"snmpqosqos_sch_leaf_recycle_failures":<Double_value>,
"snmpqosqos_error_modify_action_failed":<Double_value>,
"snmpqosqos_error_create_policy_failed":<Double_value>,
"snmpqosqos_packets_receivedrate":<Double_value>,
"snmpqosqos_sch_links_deletedrate":<Double_value>,
"snmpqosqos_policy_reeval":<Double_value>,
"snmpqosqos_real_bytes":<Double_value>,
"snmpqosqos_error_api_ses_add_insession":<Double_value>,
"snmpqosqos_error_api_ses_add_other":<Double_value>,
"snmpqosqos_sch_sessions_deleted":<Double_value>,
"snmpqosqos_bytes_tx":<Double_value>,
"snmpqosqos_packets_classifiedrate":<Double_value>,
"snmpqosqos_error_libqos_api_failures":<Double_value>,
"snmpqosqos_error_create_action_failedrate":<Double_value>,
"snmpqosqos_error_api_ses_del":<Double_value>,
"snmpqosqos_packets_filteredrate":<Double_value>,
"snmpqosqos_flows_availablerate":<Double_value>,
"snmpqosqos_session_recycle_failure":<Double_value>,
"snmpqosqos_sch_virtual_packetsrate":<Double_value>,
"snmpqosqos_bytes_txrate":<Double_value>,
"snmpqosqos_packets_bypassed":<Double_value>,
"snmpqosqos_cfy_udp_unknown":<Double_value>,
"snmpqosqos_packets_received":<Double_value>,
"snmpqosqos_error_create_policy_failedrate":<Double_value>,
"snmpqosqos_error_api_ses_delrate":<Double_value>,
"snmpqosqos_flow_mem":<Double_value>,
"snmpqosqos_session_mem":<Double_value>,
"snmpqosqos_recycle_failed_sessionrate":<Double_value>,
"snmpqosqos_sch_poll_count":<Double_value>,
"snmpqosqos_lazy_bytes":<Double_value>,
"snmpqosqos_error_remove_action_failedrate":<Double_value>,
"snmpqosqos_sch_sessions_regulated_count":<Double_value>,
"snmpqosqos_error_api_ses_add_otherrate":<Double_value>,
"snmpqosqos_error_api_ses_rem_otherrate":<Double_value>,
"snmpqosqos_recycle_failed_session":<Double_value>,
"snmpqosqos_sch_sessions_byte_countrate":<Double_value>,
"snmpqosqos_sch_links_updated":<Double_value>,
"snmpqosqos_sch_sdrr_nodes":<Double_value>,
"snmpqosqos_sch_peer_msgsrate":<Double_value>,
"snmpqosqos_sch_session_conns":<Double_value>,
"snmpqosqos_error_libqos_api_failuresrate":<Double_value>,
"snmpqosqos_error_cli_unknownrate":<Double_value>,
"snmpqosqos_actions_created":<Double_value>,
"snmpqosqos_sch_virtual_bytes_accepted":<Double_value>,
"snmpqosqos_sessions_consumed":<Double_value>,
"snmpqosqos_error_remove_policy_failedrate":<Double_value>,
"snmpqosqos_error_cli_unknown":<Double_value>,
"snmpqosqos_flow_recycles":<Double_value>,
"snmpqosqos_sch_sessions_deletedrate":<Double_value>,
"snmpqosqos_sch_poll_countrate":<Double_value>,
"snmpqosqos_sch_node_regulated_countrate":<Double_value>,
"snmpqosqos_error_no_sessionsrate":<Double_value>,
"snmpqosqos_error_api_ses_rem_notinsession":<Double_value>,
"snmpqosqos_flows":<Double_value>,
"snmpqosqos_sch_sessions_regulated_countrate":<Double_value>,
"snmpqosqos_sch_session_conns_removedrate":<Double_value>,
"snmpqosqos_sch_sessions_byte_count":<Double_value>,
"snmpqosqos_flow_recyclesrate":<Double_value>,
"snmpqosqos_sch_leafs":<Double_value>,
"snmpqosqos_error_api_ses_rem_other":<Double_value>,
"snmpqosqos_policy_reevalrate":<Double_value>,
"snmpqosqos_sch_links_created":<Double_value>,
"snmpqosqos_error_api_ses_notreadyrate":<Double_value>,
"snmpqosqos_error_no_flowsrate":<Double_value>,
"snmpqosqos_error_ipcrate":<Double_value>,
"snmpqosqos_error_modify_action_failedrate":<Double_value>,
"snmpqosqos_sch_regulated_count":<Double_value>,
"snmpqosqos_sch_sessions_created":<Double_value>,
"snmpqosqos_error_no_flows":<Double_value>,
"snmpqosqos_error_api_ses_rem_notinsessionrate":<Double_value>,
"snmpqosqos_sch_leafsrate":<Double_value>,
"snmpqosqos_sch_node_regulated_count":<Double_value>,
"snmpqosqos_error_ipc":<Double_value>,
"snmpqosqos_sch_leaf_recycle_failuresrate":<Double_value>,
"snmpqosqos_packets_dropped":<Double_value>,
"snmpqosqos_sessions_consumedrate":<Double_value>,
"snmpqosqos_sessions_ignored":<Double_value>,
"snmpqosqos_cfy_tcp_unknownrate":<Double_value>,
"snmpqosqos_sch_sdrr_nodesrate":<Double_value>,
"snmpqosqos_sch_links_updatedrate":<Double_value>,
"snmpqosqos_packets_sentrate":<Double_value>,
"snmpqosqos_packets_bypassedrate":<Double_value>
}]}
<!--NeedCopy-->
qos
In this article
Copied!
Failed!