ADC NITRO APIs

protocoludp

August 17, 2023

Contributed by:

Statistics for UDP Protocol resource.

Properties

(click to see Operations )

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
udptotrxpkts	Read-only	Total number of UDP packets received.
udprxpktsrate	Read-only	Rate (/s) counter for udptotrxpkts
udptotrxbytes	Read-only	Total number of UDP data received in bytes.
udprxbytesrate	Read-only	Rate (/s) counter for udptotrxbytes
udptottxpkts	Read-only	Total number of UDP packets transmitted.
udptxpktsrate	Read-only	Rate (/s) counter for udptottxpkts
udptottxbytes	Read-only	Total number of UDP data transmitted in bytes.
udptxbytesrate	Read-only	Rate (/s) counter for udptottxbytes
udpcurratethreshold	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	Read-only	Stray UDP packets dropped due to no configured listening service.
udpbadchecksum	Read-only	Packets received with a UDP checksum error.
udpcurratethresholdexceeds	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 )

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 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/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 Header:

Content-Type:application/json

Response Payload:

{  "protocoludp": [ {
      "udptotrxpkts":<Double_value>,
      "udprxpktsrate":<Double_value>,
      "udptottxbytes":<Double_value>,
      "udptotunknownsvcpkts":<Double_value>,
      "udprxbytesrate":<Double_value>,
      "udptxpktsrate":<Double_value>,
      "udpcurratethreshold":<Double_value>,
      "udptottxpkts":<Double_value>,
      "udptotrxbytes":<Double_value>,
      "udptxbytesrate":<Double_value>,
      "udpbadchecksum":<Double_value>,
      "udpcurratethresholdexceeds":<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

protocoludp

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

protocoludp

Properties

Operations

get (all)

In this article