Citrix ADC 12.1 NITRO API Reference

pcpserver

August 17, 2023

Contributed by:

Statistics for server resource.

Properties

(click to see Operations)

Name	Permissions	Description
name	Read-write	PCP Statistics per Server.
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
pcptotrequests	Read-only	PCP Request received.
pcprequestsrate	Read-only	Rate (/s) counter for pcptotrequests
pcptotresponses	Read-only	Number PCP responces sent.
pcpresponsesrate	Read-only	Rate (/s) counter for pcptotresponses
pcptotmaprequests	Read-only	PCP MAP Requests received.
pcpmaprequestsrate	Read-only	Rate (/s) counter for pcptotmaprequests
pcptotpeerrequests	Read-only	PCP PEER Requests received.
pcppeerrequestsrate	Read-only	Rate (/s) counter for pcptotpeerrequests
pcptoterrinrquest	Read-only	total PCP request with error.
pcperrinrquestrate	Read-only	Rate (/s) counter for pcptoterrinrquest
pcptoterrinres	Read-only	Total PCP responses with errors.
pcperrinresrate	Read-only	Rate (/s) counter for pcptoterrinres
pcptotunsuppvers	Read-only	PCP request with unsupported version.
pcpunsuppversrate	Read-only	Rate (/s) counter for pcptotunsuppvers
pcptotmalformedreq	Read-only	total PCP request having malformed PCP packets.
pcpmalformedreqrate	Read-only	Rate (/s) counter for pcptotmalformedreq
pcptotunsuppopcode	Read-only	total Unsupproted OPCODES received Requests.
pcpunsuppopcoderate	Read-only	Rate (/s) counter for pcptotunsuppopcode
pcptotunsuppoption	Read-only	total Unsupproted OPTIONS received in requests.
pcpunsuppoptionrate	Read-only	Rate (/s) counter for pcptotunsuppoption
pcptotmalformedoption	Read-only	total malformed OPTIONS received in requests.
pcpmalformedoptionrate	Read-only	Rate (/s) counter for pcptotmalformedoption
pcptotnetfailure	Read-only	Total Network Failures.
pcpnetfailurerate	Read-only	Rate (/s) counter for pcptotnetfailure
pcptotnoresources	Read-only	no resources
pcpnoresourcesrate	Read-only	Rate (/s) counter for pcptotnoresources
pcptotunsupportedprotocol	Read-only	Total Unsupported Protocols requests.
pcpunsupportedprotocolrate	Read-only	Rate (/s) counter for pcptotunsupportedprotocol
pcptotuserexqouta	Read-only	Total user ex quota.
pcpuserexqoutarate	Read-only	Rate (/s) counter for pcptotuserexqouta
pcptotnoexternal	Read-only	Total responses with opcode can not provide external.
pcpnoexternalrate	Read-only	Rate (/s) counter for pcptotnoexternal
pcptotaddrmismatch	Read-only	Total address mismatch.
pcpaddrmismatchrate	Read-only	Rate (/s) counter for pcptotaddrmismatch
pcptotexcesspeers	Read-only	Total responses with opcode excessive remote peers.
pcpexcesspeersrate	Read-only	Rate (/s) counter for pcptotexcesspeers

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 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/pcpserver

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/pcpserver?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 pcpserver 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:

{ "pcpserver": [ {
"name":<String_value>,
"pcpaddrmismatchrate":<Double_value>,
"pcptotmalformedreq":<Double_value>,
"pcpnoresourcesrate":<Double_value>,
"pcpunsuppopcoderate":<Double_value>,
"pcptotpeerrequests":<Double_value>,
"pcpnetfailurerate":<Double_value>,
"pcptoterrinrquest":<Double_value>,
"pcptotmalformedoption":<Double_value>,
"pcptotresponses":<Double_value>,
"pcpunsupportedprotocolrate":<Double_value>,
"pcptotnoresources":<Double_value>,
"pcptotnetfailure":<Double_value>,
"pcppeerrequestsrate":<Double_value>,
"pcptotnoexternal":<Double_value>,
"pcperrinresrate":<Double_value>,
"pcptotunsuppopcode":<Double_value>,
"pcpunsuppversrate":<Double_value>,
"pcptotuserexqouta":<Double_value>,
"pcptotunsuppvers":<Double_value>,
"pcpuserexqoutarate":<Double_value>,
"pcptotunsupportedprotocol":<Double_value>,
"pcpexcesspeersrate":<Double_value>,
"pcpmalformedoptionrate":<Double_value>,
"pcptotrequests":<Double_value>,
"pcperrinrquestrate":<Double_value>,
"pcpresponsesrate":<Double_value>,
"pcpunsuppoptionrate":<Double_value>,
"pcpmaprequestsrate":<Double_value>,
"pcpnoexternalrate":<Double_value>,
"pcptotunsuppoption":<Double_value>,
"pcptoterrinres":<Double_value>,
"pcptotmaprequests":<Double_value>,
"pcptotexcesspeers":<Double_value>,
"pcpmalformedreqrate":<Double_value>,
"pcprequestsrate":<Double_value>,
"pcptotaddrmismatch":<Double_value>
}]}

<!--NeedCopy-->

get

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

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

{ "pcpserver": [ {
"name":<String_value>,
"pcpaddrmismatchrate":<Double_value>,
"pcptotmalformedreq":<Double_value>,
"pcpnoresourcesrate":<Double_value>,
"pcpunsuppopcoderate":<Double_value>,
"pcptotpeerrequests":<Double_value>,
"pcpnetfailurerate":<Double_value>,
"pcptoterrinrquest":<Double_value>,
"pcptotmalformedoption":<Double_value>,
"pcptotresponses":<Double_value>,
"pcpunsupportedprotocolrate":<Double_value>,
"pcptotnoresources":<Double_value>,
"pcptotnetfailure":<Double_value>,
"pcppeerrequestsrate":<Double_value>,
"pcptotnoexternal":<Double_value>,
"pcperrinresrate":<Double_value>,
"pcptotunsuppopcode":<Double_value>,
"pcpunsuppversrate":<Double_value>,
"pcptotuserexqouta":<Double_value>,
"pcptotunsuppvers":<Double_value>,
"pcpuserexqoutarate":<Double_value>,
"pcptotunsupportedprotocol":<Double_value>,
"pcpexcesspeersrate":<Double_value>,
"pcpmalformedoptionrate":<Double_value>,
"pcptotrequests":<Double_value>,
"pcperrinrquestrate":<Double_value>,
"pcpresponsesrate":<Double_value>,
"pcpunsuppoptionrate":<Double_value>,
"pcpmaprequestsrate":<Double_value>,
"pcpnoexternalrate":<Double_value>,
"pcptotunsuppoption":<Double_value>,
"pcptoterrinres":<Double_value>,
"pcptotmaprequests":<Double_value>,
"pcptotexcesspeers":<Double_value>,
"pcpmalformedreqrate":<Double_value>,
"pcprequestsrate":<Double_value>,
"pcptotaddrmismatch":<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

pcpserver

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

pcpserver

Properties

Operations

get (all)

get

In this article