Download full document:

pcpserver¶

Statistics for server resource.

Properties¶

(click to see Operations)

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

Query-parameters:

args

http://<netscaler-ip-address>/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 NetScaler-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>
}]}

get¶

URL: http://<netscaler-ip-address>/nitro/v1/stat/pcpserver/name_value><String>