pqpolicy
Statistics for PQ policy resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| policyname | <String> | Read-write | Name of the priority queuing policy whose statistics must be displayed. If a name is not provided, statistics of all priority queuing policies are shown.
Minimum length = 1 |
| clearstats | <String> | Read-write | Clear the statsistics / counters.
Possible values = basic, full |
| pqtotavgqueuewaittime | <Double> | Read-only | Average wait time for clients for this priority queuing policy. |
| pqavgqueuewaittimerate | <Double> | Read-only | Rate (/s) counter for pqtotavgqueuewaittime |
| pqavgclienttransactiontimems | <Double> | Read-only | Average time taken by a priority queuing client to complete its transaction for this priority queuing policy. |
| pqavgclienttransactiontimemsrate | <Double> | Read-only | Rate (/s) counter for pqavgclienttransactiontimems |
| pqvserverip | <String> | Read-only | IP address of the virtual server to which this priority queuing policy is bound. |
| pqvserverport | <Integer> | Read-only | Port number of the virtual server to which this priority queuing policy is bound. |
| pqqdepth | <Double> | Read-only | Number of clients waiting currently for this priority queuing policy. |
| pqqdepthrate | <Double> | Read-only | Rate (/s) counter for pqqdepth |
| pqcurrentclientconnections | <Double> | Read-only | Current number of server connections established for serving clients for this priority queuing policy. |
| pqcurrentclientconnectionsrate | <Double> | Read-only | Rate (/s) counter for pqcurrentclientconnections |
| pqtotclientconnections | <Double> | Read-only | Total number of server connections established for serving clients for this priority queuing policy. |
| pqclientconnectionsrate | <Double> | Read-only | Rate (/s) counter for pqtotclientconnections |
| pqdropped | <Double> | Read-only | Total number of dropped transactions for this priority queuing policy. |
| pqdroppedrate | <Double> | Read-only | Rate (/s) counter for pqdropped |
| totclienttransactions | <Double> | Read-only | Total number of client transactions for this priority queuing policy. |
| clienttransactionsrate | <Double> | Read-only | Rate (/s) counter for totclienttransactions |
| pqtotqueuedepth | <Double> | Read-only | Total number of waiting clients for this priority queuing policy. |
| pqqueuedepthrate | <Double> | Read-only | Rate (/s) counter for pqtotqueuedepth |
Operations
(click to see Properties )
- GET (ALL)
- GET
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/pqpolicy
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/stat/pqpolicy? args=policyname: <String_value> ,detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get pqpolicy 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:
{ "pqpolicy": [ {
"policyname":<String_value>,
"pqvserverip":<String_value>,
"pqqueuedepthrate":<Double_value>,
"pqdroppedrate":<Double_value>,
"pqtotqueuedepth":<Double_value>,
"pqvserverport":<Integer_value>,
"totclienttransactions":<Double_value>,
"clienttransactionsrate":<Double_value>,
"pqcurrentclientconnectionsrate":<Double_value>,
"pqqdepthrate":<Double_value>,
"pqqdepth":<Double_value>,
"pqclientconnectionsrate":<Double_value>,
"pqavgclienttransactiontimems":<Double_value>,
"pqavgclienttransactiontimemsrate":<Double_value>,
"pqtotavgqueuewaittime":<Double_value>,
"pqdropped":<Double_value>,
"pqtotclientconnections":<Double_value>,
"pqavgqueuewaittimerate":<Double_value>,
"pqcurrentclientconnections":<Double_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/stat/pqpolicy/ policyname_value><String>
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:
{ "pqpolicy": [ {
"policyname":<String_value>,
"pqvserverip":<String_value>,
"pqqueuedepthrate":<Double_value>,
"pqdroppedrate":<Double_value>,
"pqtotqueuedepth":<Double_value>,
"pqvserverport":<Integer_value>,
"totclienttransactions":<Double_value>,
"clienttransactionsrate":<Double_value>,
"pqcurrentclientconnectionsrate":<Double_value>,
"pqqdepthrate":<Double_value>,
"pqqdepth":<Double_value>,
"pqclientconnectionsrate":<Double_value>,
"pqavgclienttransactiontimems":<Double_value>,
"pqavgclienttransactiontimemsrate":<Double_value>,
"pqtotavgqueuewaittime":<Double_value>,
"pqdropped":<Double_value>,
"pqtotclientconnections":<Double_value>,
"pqavgqueuewaittimerate":<Double_value>,
"pqcurrentclientconnections":<Double_value>
}]}
<!--NeedCopy-->