pcpserver
Statistics for server resource.
Properties
(click to see Operations )
| Name | Data Type | 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 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.
attrs http:// <netscaler-ip-address> /nitro/v1/stat/pcpserver? 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:
{ "pcpserver": [ {
"name":<String_value>,
"pcptotmalformedreq":<Double_value>,
"pcptotpeerrequests":<Double_value>,
"pcptotresponses":<Double_value>,
"pcptotnetfailure":<Double_value>,
"pcpunsuppversrate":<Double_value>,
"pcpuserexqoutarate":<Double_value>,
"pcpexcesspeersrate":<Double_value>,
"pcpmalformedoptionrate":<Double_value>,
"pcpmaprequestsrate":<Double_value>,
"pcpnoexternalrate":<Double_value>,
"pcptotexcesspeers":<Double_value>,
"pcpnetfailurerate":<Double_value>,
"pcptotnoresources":<Double_value>,
"pcppeerrequestsrate":<Double_value>,
"pcperrinresrate":<Double_value>,
"pcptotunsuppopcode":<Double_value>,
"pcptotrequests":<Double_value>,
"pcptotmaprequests":<Double_value>,
"pcptotaddrmismatch":<Double_value>,
"pcpaddrmismatchrate":<Double_value>,
"pcpnoresourcesrate":<Double_value>,
"pcptoterrinrquest":<Double_value>,
"pcptotmalformedoption":<Double_value>,
"pcptotunsuppvers":<Double_value>,
"pcperrinrquestrate":<Double_value>,
"pcpresponsesrate":<Double_value>,
"pcptotunsuppoption":<Double_value>,
"pcpmalformedreqrate":<Double_value>,
"pcprequestsrate":<Double_value>,
"pcpunsuppopcoderate":<Double_value>,
"pcpunsupportedprotocolrate":<Double_value>,
"pcptotnoexternal":<Double_value>,
"pcptotuserexqouta":<Double_value>,
"pcptotunsupportedprotocol":<Double_value>,
"pcpunsuppoptionrate":<Double_value>,
"pcptoterrinres":<Double_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/stat/pcpserver/ name_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:
{ "pcpserver": [ {
"name":<String_value>,
"pcptotmalformedreq":<Double_value>,
"pcptotpeerrequests":<Double_value>,
"pcptotresponses":<Double_value>,
"pcptotnetfailure":<Double_value>,
"pcpunsuppversrate":<Double_value>,
"pcpuserexqoutarate":<Double_value>,
"pcpexcesspeersrate":<Double_value>,
"pcpmalformedoptionrate":<Double_value>,
"pcpmaprequestsrate":<Double_value>,
"pcpnoexternalrate":<Double_value>,
"pcptotexcesspeers":<Double_value>,
"pcpnetfailurerate":<Double_value>,
"pcptotnoresources":<Double_value>,
"pcppeerrequestsrate":<Double_value>,
"pcperrinresrate":<Double_value>,
"pcptotunsuppopcode":<Double_value>,
"pcptotrequests":<Double_value>,
"pcptotmaprequests":<Double_value>,
"pcptotaddrmismatch":<Double_value>,
"pcpaddrmismatchrate":<Double_value>,
"pcpnoresourcesrate":<Double_value>,
"pcptoterrinrquest":<Double_value>,
"pcptotmalformedoption":<Double_value>,
"pcptotunsuppvers":<Double_value>,
"pcperrinrquestrate":<Double_value>,
"pcpresponsesrate":<Double_value>,
"pcptotunsuppoption":<Double_value>,
"pcpmalformedreqrate":<Double_value>,
"pcprequestsrate":<Double_value>,
"pcpunsuppopcoderate":<Double_value>,
"pcpunsupportedprotocolrate":<Double_value>,
"pcptotnoexternal":<Double_value>,
"pcptotuserexqouta":<Double_value>,
"pcptotunsupportedprotocol":<Double_value>,
"pcpunsuppoptionrate":<Double_value>,
"pcptoterrinres":<Double_value>
}]}
<!--NeedCopy-->