Download full document:

protocolicmpv6

Statistics for icmpv6 resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
icmpv6totrxpkts<Double>Read-onlyICMPv6 packets received.
icmpv6rxpktsrate<Double>Read-onlyRate (/s) counter for icmpv6totrxpkts
icmpv6totrxbytes<Double>Read-onlyBytes of ICMPv6 data received.
icmpv6rxbytesrate<Double>Read-onlyRate (/s) counter for icmpv6totrxbytes
icmpv6tottxpkts<Double>Read-onlyICMPv6 packets transmitted.
icmpv6txpktsrate<Double>Read-onlyRate (/s) counter for icmpv6tottxpkts
icmpv6tottxbytes<Double>Read-onlyBytes of ICMPv6 data transmitted.
icmpv6txbytesrate<Double>Read-onlyRate (/s) counter for icmpv6tottxbytes
icmpv6totrxna<Double>Read-onlyICMPv6 neighbor advertisement packets received. These packets are received in response to a neighbor solicitation message sent out by this node, or if the link layer address of a neighbor has changed.
icmpv6rxnarate<Double>Read-onlyRate (/s) counter for icmpv6totrxna
icmpv6totrxns<Double>Read-onlyICMPv6 neighbor solicitation packets received. These packets are received if the link layer address of a neighbor has changed, or in response to a neighbor solicitation message sent out by this node.
icmpv6rxnsrate<Double>Read-onlyRate (/s) counter for icmpv6totrxns
icmpv6totrxra<Double>Read-onlyICMPv6 router advertisement packets received. These are received at defined intervals or in response to a router solicitation message.
icmpv6rxrarate<Double>Read-onlyRate (/s) counter for icmpv6totrxra
icmpv6totrxrs<Double>Read-onlyICMPv6 router solicitation packets received. These could be sent by a neighboring router to initiate address resolution.
icmpv6rxrsrate<Double>Read-onlyRate (/s) counter for icmpv6totrxrs
icmpv6totrxechoreq<Double>Read-onlyICMPv6 Ping Echo Request packets received.
icmpv6rxechoreqrate<Double>Read-onlyRate (/s) counter for icmpv6totrxechoreq
icmpv6totrxechoreply<Double>Read-onlyICMPv6 Ping Echo Reply packets received.
icmpv6rxechoreplyrate<Double>Read-onlyRate (/s) counter for icmpv6totrxechoreply
icmpv6tottxna<Double>Read-onlyICMPv6 neighbor advertisement packets transmitted. These packets are sent in response to a neighbor solicitation packet, or if the link layer address of this node has changed.
icmpv6txnarate<Double>Read-onlyRate (/s) counter for icmpv6tottxna
icmpv6tottxns<Double>Read-onlyICMPv6 neighbor solicitation packets transmitted. These packets are sent to get the link layer addresses of neighboring nodes or to confirm that they are reachable.
icmpv6txnsrate<Double>Read-onlyRate (/s) counter for icmpv6tottxns
icmpv6tottxra<Double>Read-onlyICMPv6 router advertisement packets transmitted. These packets are sent at regular intervals or in response to a router solicitation packet from a neighbor.
icmpv6txrarate<Double>Read-onlyRate (/s) counter for icmpv6tottxra
icmpv6tottxrs<Double>Read-onlyICMPv6 router solicitation packets transmitted. These packets are sent to request neighboring routers to generate router advertisements immediately rather than wait for the next defined time.
icmpv6txrsrate<Double>Read-onlyRate (/s) counter for icmpv6tottxrs
icmpv6tottxechoreq<Double>Read-onlyICMPv6 Ping Echo Request packets transmitted.
icmpv6txechoreqrate<Double>Read-onlyRate (/s) counter for icmpv6tottxechoreq
icmpv6tottxechoreply<Double>Read-onlyICMP Ping Echo Reply packets transmitted.
icmpv6txechoreplyrate<Double>Read-onlyRate (/s) counter for icmpv6tottxechoreply
icmpv6errra<Double>Read-onlyICMPv6 router advertisement error packets received that contain an error in the header, such as an incorrect source IP address, destination IP address, or packet length.
icmpv6errna<Double>Read-onlyICMPv6 neighbor advertisement error packets received that contain an error in the header, such as an incorrect source IP address, destination IP address, or packet length.
icmpv6errns<Double>Read-onlyICMPv6 neighbor solicitation error packets received that contain an error in the header, such as an incorrect source IP address, destination IP address, or packet length.
icmpv6badchecksums<Double>Read-onlyPackets received with an ICMPv6 checksum error.
icmpv6unspt<Double>Read-onlyICMPv6 packets received that are not supported by the Citrix ADC.
icmpv6rtthsld<Double>Read-onlyPackets dropped because the default threshold of 100 requests per 10 milliseconds has been exceeded. 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 redand placeholder content is marked in <green>.

get (all)

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

Query-parameters:

args

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

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

Content-Type:application/json

Response Payload:

{ "protocolicmpv6": [ {
"icmpv6tottxns":<Double_value>,
"icmpv6txpktsrate":<Double_value>,
"icmpv6unspt":<Double_value>,
"icmpv6totrxechoreply":<Double_value>,
"icmpv6tottxra":<Double_value>,
"icmpv6tottxechoreply":<Double_value>,
"icmpv6badchecksums":<Double_value>,
"icmpv6txnarate":<Double_value>,
"icmpv6txrsrate":<Double_value>,
"icmpv6tottxna":<Double_value>,
"icmpv6totrxra":<Double_value>,
"icmpv6tottxrs":<Double_value>,
"icmpv6rxpktsrate":<Double_value>,
"icmpv6totrxpkts":<Double_value>,
"icmpv6totrxns":<Double_value>,
"icmpv6rxechoreplyrate":<Double_value>,
"icmpv6txechoreqrate":<Double_value>,
"icmpv6rxrsrate":<Double_value>,
"icmpv6errna":<Double_value>,
"icmpv6rxnsrate":<Double_value>,
"icmpv6rxbytesrate":<Double_value>,
"icmpv6rtthsld":<Double_value>,
"icmpv6totrxrs":<Double_value>,
"icmpv6totrxna":<Double_value>,
"icmpv6txechoreplyrate":<Double_value>,
"icmpv6totrxbytes":<Double_value>,
"icmpv6txrarate":<Double_value>,
"icmpv6errns":<Double_value>,
"icmpv6totrxechoreq":<Double_value>,
"icmpv6tottxechoreq":<Double_value>,
"icmpv6rxrarate":<Double_value>,
"icmpv6rxechoreqrate":<Double_value>,
"icmpv6tottxpkts":<Double_value>,
"icmpv6tottxbytes":<Double_value>,
"icmpv6rxnarate":<Double_value>,
"icmpv6txnsrate":<Double_value>,
"icmpv6errra":<Double_value>,
"icmpv6txbytesrate":<Double_value>
}]}