Citrix ADC 12.1 NITRO API Reference

protocolicmp

August 17, 2023

Contributed by:

Statistics for icmp resource.

Properties

(click to see Operations)

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
icmptotrxpkts	Read-only	ICMP packets received.
icmprxpktsrate	Read-only	Rate (/s) counter for icmptotrxpkts
icmptotrxbytes	Read-only	Bytes of ICMP data received.
icmprxbytesrate	Read-only	Rate (/s) counter for icmptotrxbytes
icmptottxpkts	Read-only	ICMP packets transmitted.
icmptxpktsrate	Read-only	Rate (/s) counter for icmptottxpkts
icmptottxbytes	Read-only	Bytes of ICMP data transmitted.
icmptxbytesrate	Read-only	Rate (/s) counter for icmptottxbytes
icmptotrxechoreply	Read-only	ICMP Ping echo replies received.
icmprxechoreplyrate	Read-only	Rate (/s) counter for icmptotrxechoreply
icmptottxechoreply	Read-only	ICMP Ping echo replies transmitted.
icmptxechoreplyrate	Read-only	Rate (/s) counter for icmptottxechoreply
icmptotrxecho	Read-only	ICMP Ping Echo Request and Echo Reply packets received.
icmprxechorate	Read-only	Rate (/s) counter for icmptotrxecho
icmptotdstiplookup	Read-only	Total number of MTU lookup on destination IP info received on a need fragmentation ICMP error message failed.
icmpcurratethreshold	Read-only	Limit for ICMP packets handled every 10 milliseconds. Default value, 0, applies no limit. This is a configurable value using the set rateControl command.
icmptotportunreachablerx	Read-only	ICMP Port Unreachable error messages received. This error is generated when there is no service is running on the port.
icmptotportunreachabletx	Read-only	ICMP Port Unreachable error messages generated. This error is generated when there is no service is running on the port.
icmptotneedfragrx	Read-only	ICMP Fragmentation Needed error messages received for packets that need to be fragmented but for which Don’t Fragment is specified the header.
icmptotthresholdexceeds	Read-only	Times the ICMP rate threshold is exceeded. If this counter continuously increases, first make sure the ICMP packets received are genuine. If they are, increase the current rate threshold.
icmptotpktsdropped	Read-only	ICMP packets dropped because the rate threshold has been exceeded.
icmptotbadchecksum	Read-only	ICMP Fragmentation Needed error messages received with an ICMP checksum error.
icmptotnonfirstipfrag	Read-only	ICMP Fragmentation Needed error messages received that were generated by an IP fragment other than the first one.
icmptotinvalidbodylen	Read-only	ICMP Fragmentation Needed error messages received that specified an invalid body length.
icmptotnotcpconn	Read-only	ICMP Need Fragmentation error messages received for TCP packets. The state of the connection for these packets is not maintained on the Citrix ADC.
icmptotnoudpconn	Read-only	ICMP Need Fragmentation error messages received for UDP packets. The state of the connection for these packets is not maintained on the Citrix ADC.
icmptotinvalidtcpseqno	Read-only	ICMP Fragmentation Needed error messages received for packets that contain an invalid TCP address.
icmptotinvalidnextmtuval	Read-only	ICMP Fragmentation Needed error messages received in which the Maximum Transmission Unit (MTU) for the next hop is out of range. The range for the MTU is 576-1500.
icmptotbignextmtu	Read-only	ICMP Fragmentation Needed error messages received in which the value for the next MTU is higher than that of the current MTU.
icmptotinvalidprotocol	Read-only	ICMP Fragmentation Needed error messages received that contain a protocol other than TCP and UDP.
icmptotbadpmtuipchecksum	Read-only	ICMP Fragmentation Needed error messages received with an IP checksum error.
icmptotpmtunolink	Read-only	ICMP Fragmentation Needed error messages received on a Protocol Control Block (PCB) with no link. The PCB maintains the state of the connection.
icmptotpmtudiscoverydisabled	Read-only	ICMP Need Fragmentation error messages received when the PMTU Discovery mode is not enabled.

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

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/protocolicmp?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

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

{ "protocolicmp": [ {
"icmprxbytesrate":<Double_value>,
"icmptotthresholdexceeds":<Double_value>,
"icmprxechoreplyrate":<Double_value>,
"icmptottxechoreply":<Double_value>,
"icmptottxpkts":<Double_value>,
"icmptotinvalidnextmtuval":<Double_value>,
"icmptotrxecho":<Double_value>,
"icmptotdstiplookup":<Double_value>,
"icmptotnoudpconn":<Double_value>,
"icmptottxbytes":<Double_value>,
"icmptotrxbytes":<Double_value>,
"icmptotportunreachabletx":<Double_value>,
"icmpcurratethreshold":<Double_value>,
"icmptotbadchecksum":<Double_value>,
"icmptotinvalidbodylen":<Double_value>,
"icmprxechorate":<Double_value>,
"icmptotbignextmtu":<Double_value>,
"icmptotpmtudiscoverydisabled":<Double_value>,
"icmprxpktsrate":<Double_value>,
"icmptotbadpmtuipchecksum":<Double_value>,
"icmptotpmtunolink":<Double_value>,
"icmptotinvalidprotocol":<Double_value>,
"icmptotportunreachablerx":<Double_value>,
"icmptotneedfragrx":<Double_value>,
"icmptxechoreplyrate":<Double_value>,
"icmptotpktsdropped":<Double_value>,
"icmptotrxechoreply":<Double_value>,
"icmptxpktsrate":<Double_value>,
"icmptotnonfirstipfrag":<Double_value>,
"icmptotrxpkts":<Double_value>,
"icmptotnotcpconn":<Double_value>,
"icmptotinvalidtcpseqno":<Double_value>,
"icmptxbytesrate":<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

protocolicmp

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

protocolicmp

Properties

Operations

get (all)

In this article