Product Documentation

protocoludp

Sep 08, 2016

Statistics for UDP Protocol resource.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
udptotrxpkts
<Double>
Read-only
Total number of UDP packets received.
udprxpktsrate
<Double>
Read-only
Rate (/s) counter for udptotrxpkts
udptotrxbytes
<Double>
Read-only
Total number of UDP data received in bytes.
udprxbytesrate
<Double>
Read-only
Rate (/s) counter for udptotrxbytes
udptottxpkts
<Double>
Read-only
Total number of UDP packets transmitted.
udptxpktsrate
<Double>
Read-only
Rate (/s) counter for udptottxpkts
udptottxbytes
<Double>
Read-only
Total number of UDP data transmitted in bytes.
udptxbytesrate
<Double>
Read-only
Rate (/s) counter for udptottxbytes
udpcurratethreshold
<Double>
Read-only
Limit for UDP packets handled every 10 milliseconds. Default value, 0, applies no limit. This is a configurable value using the set rateControl command.
udptotunknownsvcpkts
<Double>
Read-only
Stray UDP packets dropped due to no configured listening service.
udpbadchecksum
<Double>
Read-only
Packets received with a UDP checksum error.
udpcurratethresholdexceeds
<Double>
Read-only
Number of times the UDP rate threshold is exceeded. If this counter continuously increases, first make sure the UDP packets received are genuine. If they are, increase the current rate threshold. This is a configurable value using the set rateControl command.

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/protocoludp

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/protocoludp?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get protocoludp 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 Headers:

Content-Type:application/json

Response Payload:

{ "protocoludp": [ {
      "udptxpktsrate":<Double_value>,
      "udpcurratethreshold":<Double_value>,
      "udptotrxpkts":<Double_value>,
      "udptottxpkts":<Double_value>,
      "udptotrxbytes":<Double_value>,
      "udptxbytesrate":<Double_value>,
      "udprxpktsrate":<Double_value>,
      "udpbadchecksum":<Double_value>,
      "udptottxbytes":<Double_value>,
      "udptotunknownsvcpkts":<Double_value>,
      "udprxbytesrate":<Double_value>,
      "udpcurratethresholdexceeds":<Double_value>
}]}