Skip to content

protocolicmp

Statistics for icmp resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
icmptotrxpkts <Double> Read-only ICMP packets received.
icmprxpktsrate <Double> Read-only Rate (/s) counter for icmptotrxpkts
icmptotrxbytes <Double> Read-only Bytes of ICMP data received.
icmprxbytesrate <Double> Read-only Rate (/s) counter for icmptotrxbytes
icmptottxpkts <Double> Read-only ICMP packets transmitted.
icmptxpktsrate <Double> Read-only Rate (/s) counter for icmptottxpkts
icmptottxbytes <Double> Read-only Bytes of ICMP data transmitted.
icmptxbytesrate <Double> Read-only Rate (/s) counter for icmptottxbytes
icmptotrxechoreply <Double> Read-only ICMP Ping echo replies received.
icmprxechoreplyrate <Double> Read-only Rate (/s) counter for icmptotrxechoreply
icmptottxechoreply <Double> Read-only ICMP Ping echo replies transmitted.
icmptxechoreplyrate <Double> Read-only Rate (/s) counter for icmptottxechoreply
icmptotrxecho <Double> Read-only ICMP Ping Echo Request and Echo Reply packets received.
icmprxechorate <Double> Read-only Rate (/s) counter for icmptotrxecho
icmptotdstiplookup <Double> Read-only Total number of MTU lookup on destination IP info received on a need fragmentation ICMP error message failed.
icmpcurratethreshold <Double> 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 <Double> Read-only ICMP Port Unreachable error messages received. This error is generated when there is no service is running on the port.
icmptotportunreachabletx <Double> Read-only ICMP Port Unreachable error messages generated. This error is generated when there is no service is running on the port.
icmptotneedfragrx <Double> 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 <Double> 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 <Double> Read-only ICMP packets dropped because the rate threshold has been exceeded.
icmptotbadchecksum <Double> Read-only ICMP Fragmentation Needed error messages received with an ICMP checksum error.
icmptotnonfirstipfrag <Double> Read-only ICMP Fragmentation Needed error messages received that were generated by an IP fragment other than the first one.
icmptotinvalidbodylen <Double> Read-only ICMP Fragmentation Needed error messages received that specified an invalid body length.
icmptotnotcpconn <Double> 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 <Double> 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 <Double> Read-only ICMP Fragmentation Needed error messages received for packets that contain an invalid TCP address.
icmptotinvalidnextmtuval <Double> 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 <Double> 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 <Double> Read-only ICMP Fragmentation Needed error messages received that contain a protocol other than TCP and UDP.
icmptotbadpmtuipchecksum <Double> Read-only ICMP Fragmentation Needed error messages received with an IP checksum error.
icmptotpmtunolink <Double> 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 <Double> 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 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/protocolicmp

Query-parameters:

args

http:// <netscaler-ip-address> /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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

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>
}]}