Citrix ADC 12.1 NITRO API Reference

pq

August 17, 2023

Contributed by:

Statistics for pq.

Properties

(click to see Operations)

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
pqtotalpolicymatches	Read-only	Number of times the Citrix ADC matched an incoming request using any priority queuing policy.
pqpolicymatchesrate	Read-only	Rate (/s) counter for pqtotalpolicymatches
pqtotalthresholdfailed	Read-only	Number of times the Citrix ADC failed to match an incoming request to any of priority queing policy.
pqthresholdfailedrate	Read-only	Rate (/s) counter for pqtotalthresholdfailed
pqpriority1requests	Read-only	Number of priority 1 requests that the Citrix ADC received.
pqpriority1requestsrate	Read-only	Rate (/s) counter for pqpriority1requests
pqpriority2requests	Read-only	Number of priority 2 requests that the Citrix ADC received.
pqpriority2requestsrate	Read-only	Rate (/s) counter for pqpriority2requests
pqpriority3requests	Read-only	Number of priority 3 requests that the Citrix ADC received.
pqpriority3requestsrate	Read-only	Rate (/s) counter for pqpriority3requests

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 Citrix ADC appliance, the URL is as follows:

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/pq

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/pq?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get pq 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "pq": [ {
"pqpriority2requestsrate":<Double_value>,
"pqpolicymatchesrate":<Double_value>,
"pqpriority1requestsrate":<Double_value>,
"pqthresholdfailedrate":<Double_value>,
"pqtotalpolicymatches":<Double_value>,
"pqpriority1requests":<Double_value>,
"pqpriority3requestsrate":<Double_value>,
"pqpriority3requests":<Double_value>,
"pqpriority2requests":<Double_value>,
"pqtotalthresholdfailed":<Double_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

pq

Properties

Operations

get (all)

In this article