Citrix ADC 12.1 NITRO API Reference

protocolipv6

August 17, 2023

Contributed by:

Statistics for ip v6 resource.

Properties

(click to see Operations)

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
ipv6totrxpkts	Read-only	IPv6 packets received.
ipv6rxpktsrate	Read-only	Rate (/s) counter for ipv6totrxpkts
ipv6totrxbytes	Read-only	Bytes of IPv6 data received.
ipv6rxbytesrate	Read-only	Rate (/s) counter for ipv6totrxbytes
ipv6tottxpkts	Read-only	IPv6 packets transmitted
ipv6txpktsrate	Read-only	Rate (/s) counter for ipv6tottxpkts
ipv6tottxbytes	Read-only	Bytes of IPv6 data transmitted.
ipv6txbytesrate	Read-only	Rate (/s) counter for ipv6tottxbytes
ipv6totroutepkts	Read-only	IPv6 packets routed.
ipv6routepktsrate	Read-only	Rate (/s) counter for ipv6totroutepkts
ipv6totroutembits	Read-only	IPv6 total Mbits.
ipv6routembitsrate	Read-only	Rate (/s) counter for ipv6totroutembits
ipv6fragtotrxpkts	Read-only	IPv6 fragments received.
ipv6fragrxpktsrate	Read-only	Rate (/s) counter for ipv6fragtotrxpkts
ipv6fragtottcpreassembled	Read-only	TCP fragments processed after reassembly.
ipv6fragtcpreassembledrate	Read-only	Rate (/s) counter for ipv6fragtottcpreassembled
ipv6fragtotudpreassembled	Read-only	UDP fragments processed after reassembly.
ipv6fragudpreassembledrate	Read-only	Rate (/s) counter for ipv6fragtotudpreassembled
ipv6fragtotpktsprocessnoreass	Read-only	IPv6 fragments processed without reassembly.
ipv6fragpktsprocessnoreassrate	Read-only	Rate (/s) counter for ipv6fragtotpktsprocessnoreass
ipv6fragtotpktsforward	Read-only	IPv6 fragments forwarded to the client or server without reassembly.
ipv6fragpktsforwardrate	Read-only	Rate (/s) counter for ipv6fragtotpktsforward
ipv6errhdr	Read-only	Packets received that contain an error in one or more components of the IPv6 header.
ipv6nextheadererr	Read-only	Packets received that contain an unsupported next header. The supported next headers are TCP, ICMP, UDP, OSPF, and FRAGMENT.
ipv6landattack	Read-only	Land-attack packets received. The source and destination addresses are the same. If not dropped, these packets can lock up the appliance.
ipv6fragpkttoobig	Read-only	Packets received for which the reassembled data exceeds the Ethernet packet data length of 1500 bytes.
ipv6fragzerolenpkt	Read-only	Packets received with a fragment length of 0 bytes.
ipv6toticmpnarx	Read-only	Number of ICMPv6 NA packets received by Citrix ADC (OBSOLETE).
ipv6icmpnarxrate	Read-only	Rate (/s) counter for ipv6toticmpnarx
ipv6toticmpnsrx	Read-only	Number of ICMPv6 NS packets received by Citrix ADC (OBSOLETE).
ipv6icmpnsrxrate	Read-only	Rate (/s) counter for ipv6toticmpnsrx
ipv6toticmpnatx	Read-only	Number of ICMPv6 NA packets transmitted by Citrix ADC (OBSOLETE).
ipv6icmpnatxrate	Read-only	Rate (/s) counter for ipv6toticmpnatx
ipv6toticmpnstx	Read-only	Number of ICMPv6 NS packets transmitted by Citrix ADC (OBSOLETE).
ipv6icmpnstxrate	Read-only	Rate (/s) counter for ipv6toticmpnstx
ipv6toticmprarx	Read-only	Number of ICMPv6 RA packets received by Citrix ADC (OBSOLETE).
ipv6icmprarxrate	Read-only	Rate (/s) counter for ipv6toticmprarx
ipv6toticmprstx	Read-only	Number of ICMPv6 RS packets transmitted by Citrix ADC (OBSOLETE).
ipv6icmprstxrate	Read-only	Rate (/s) counter for ipv6toticmprstx
ipv6toticmprx	Read-only	Number of ICMPv6 packets received by Citrix ADC (OBSOLETE).
ipv6icmprxrate	Read-only	Rate (/s) counter for ipv6toticmprx
ipv6toticmptx	Read-only	Number of ICMPv6 packets transmitted by Citrix ADC (OBSOLETE).
ipv6icmptxrate	Read-only	Rate (/s) counter for ipv6toticmptx
ipv6errrxhdr	Read-only	Number of erroneous header packets received (OBSOLETE).
ipv6errrxpkt	Read-only	Number of erroneous packets received (OBSOLETE).
ipv6badcksum	Read-only	Number of bad checksum packets received (OBSOLETE).
icmpv6error	Read-only	Number of erroneous ICMPv6 packets received (OBSOLETE).
icmpv6unspt	Read-only	Number of ICMPv6 unsupported packets received (OBSOLETE).
icmpv6rtthsld	Read-only	Number of ICMPv6 packets dropped for rate threshold exceeded (OBSOLETE).

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

Query-parameters:

args

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

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

{ "protocolipv6": [ {
"ipv6fragpktsforwardrate":<Double_value>,
"ipv6icmprstxrate":<Double_value>,
"ipv6fragpkttoobig":<Double_value>,
"ipv6fragtotrxpkts":<Double_value>,
"ipv6icmpnatxrate":<Double_value>,
"ipv6toticmpnsrx":<Double_value>,
"icmpv6unspt":<Double_value>,
"ipv6errrxhdr":<Double_value>,
"ipv6rxpktsrate":<Double_value>,
"ipv6icmpnstxrate":<Double_value>,
"ipv6errhdr":<Double_value>,
"ipv6rxbytesrate":<Double_value>,
"ipv6icmprxrate":<Double_value>,
"ipv6fragpktsprocessnoreassrate":<Double_value>,
"ipv6icmpnarxrate":<Double_value>,
"ipv6errrxpkt":<Double_value>,
"ipv6nextheadererr":<Double_value>,
"ipv6tottxbytes":<Double_value>,
"ipv6fragtotpktsforward":<Double_value>,
"ipv6totroutepkts":<Double_value>,
"ipv6toticmpnarx":<Double_value>,
"ipv6txpktsrate":<Double_value>,
"ipv6totrxbytes":<Double_value>,
"ipv6toticmpnatx":<Double_value>,
"ipv6toticmprstx":<Double_value>,
"ipv6txbytesrate":<Double_value>,
"icmpv6error":<Double_value>,
"ipv6fragzerolenpkt":<Double_value>,
"ipv6routembitsrate":<Double_value>,
"icmpv6rtthsld":<Double_value>,
"ipv6icmprarxrate":<Double_value>,
"ipv6toticmprx":<Double_value>,
"ipv6icmpnsrxrate":<Double_value>,
"ipv6routepktsrate":<Double_value>,
"ipv6icmptxrate":<Double_value>,
"ipv6fragtcpreassembledrate":<Double_value>,
"ipv6tottxpkts":<Double_value>,
"ipv6fragtotudpreassembled":<Double_value>,
"ipv6fragtottcpreassembled":<Double_value>,
"ipv6fragudpreassembledrate":<Double_value>,
"ipv6fragrxpktsrate":<Double_value>,
"ipv6badcksum":<Double_value>,
"ipv6totrxpkts":<Double_value>,
"ipv6fragtotpktsprocessnoreass":<Double_value>,
"ipv6totroutembits":<Double_value>,
"ipv6toticmptx":<Double_value>,
"ipv6toticmpnstx":<Double_value>,
"ipv6toticmprarx":<Double_value>,
"ipv6landattack":<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

protocolipv6

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

protocolipv6

Properties

Operations

get (all)

In this article