ADC NITRO APIs

ipv6

August 17, 2023

Contributed by:

Configuration for ip v6 resource.

Properties

(click to see Operations )

Name	Permissions	Description
ralearning	Read-write	Enable the Citrix ADC to learn about various routes from Router Advertisement (RA) and Router Solicitation (RS) messages sent by the routers. Default value: DISABLED Possible values = ENABLED, DISABLED
routerredirection	Read-write	Enable the Citrix ADC to do Router Redirection. Default value: DISABLED Possible values = ENABLED, DISABLED
ndbasereachtime	Read-write	Base reachable time of the Neighbor Discovery (ND6) protocol. The time, in milliseconds, that the Citrix ADC assumes an adjacent device is reachable after receiving a reachability confirmation. Default value: 30000 Minimum value = 1
ndretransmissiontime	Read-write	Retransmission time of the Neighbor Discovery (ND6) protocol. The time, in milliseconds, between retransmitted Neighbor Solicitation (NS) messages, to an adjacent device. Default value: 1000 Minimum value = 1
natprefix	Read-write	Prefix used for translating packets from private IPv6 servers to IPv4 packets. This prefix has a length of 96 bits (128-32 = 96). The IPv6 servers embed the destination IP address of the IPv4 servers or hosts in the last 32 bits of the destination IP address field of the IPv6 packets. The first 96 bits of the destination IP address field are set as the IPv6 NAT prefix. IPv6 packets addressed to this prefix have to be routed to the Citrix ADC to ensure that the IPv6-IPv4 translation is done by the appliance.
td	Read-write	Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Default value: 0 Minimum value = 0 Maximum value = 4094
dodad	Read-write	Enable the Citrix ADC to do Duplicate Address Detection (DAD) for all the Citrix ADC owned IPv6 addresses regardless of whether they are obtained through stateless auto configuration, DHCPv6, or manual configuration. Default value: DISABLED Possible values = ENABLED, DISABLED
usipnatprefix	Read-write	IPV6 NATPREFIX used in NAT46 scenario when USIP is turned on.
basereachtime	Read-only	ND6 base reachable time (ms).
reachtime	Read-only	ND6 computed reachable time (ms).
ndreachtime	Read-only	ND6 computed reachable time (ms).
retransmissiontime	Read-only	ND6 retransmission time (ms).
__count	Read-only	count parameter

Operations

(click to see Properties )

UPDATE
UNSET
GET (ALL)
GET
COUNT

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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipv6

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"ipv6":{
      "ralearning":<String_value>,
      "routerredirection":<String_value>,
      "ndbasereachtime":<Double_value>,
      "ndretransmissiontime":<Double_value>,
      "natprefix":<String_value>,
      "td":<Double_value>,
      "dodad":<String_value>,
      "usipnatprefix":<String_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipv6? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"ipv6":{
      "ralearning":true,
      "routerredirection":true,
      "ndbasereachtime":true,
      "ndretransmissiontime":true,
      "natprefix":true,
      "td":<Double_value>,
      "dodad":true,
      "usipnatprefix":true
}}

<!--NeedCopy-->

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipv6

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/ipv6? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/ipv6? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of ipv6 resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/ipv6? view=summary

Use this query-parameter to get the summary output of ipv6 resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/ipv6? pagesize=#no;pageno=#no

Use this query-parameter to get the ipv6 resources in chunks.

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:

{ "ipv6": [ {
      "td":<Double_value>,
      "ralearning":<String_value>,
      "routerredirection":<String_value>,
      "basereachtime":<Integer_value>,
      "ndbasereachtime":<Double_value>,
      "reachtime":<Integer_value>,
      "ndreachtime":<Double_value>,
      "retransmissiontime":<Integer_value>,
      "ndretransmissiontime":<Double_value>,
      "natprefix":<String_value>,
      "dodad":<String_value>,
      "usipnatprefix":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipv6/ td_value<Double>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/ipv6/ td_value<Double> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/ipv6/ td_value<Double> ? view=summary

Use this query-parameter to get the summary output of ipv6 resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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:

{  "ipv6": [ {
      "td":<Double_value>,
      "ralearning":<String_value>,
      "routerredirection":<String_value>,
      "basereachtime":<Integer_value>,
      "ndbasereachtime":<Double_value>,
      "reachtime":<Integer_value>,
      "ndreachtime":<Double_value>,
      "retransmissiontime":<Integer_value>,
      "ndretransmissiontime":<Double_value>,
      "natprefix":<String_value>,
      "dodad":<String_value>,
      "usipnatprefix":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipv6? count=yes

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:

{ "ipv6": [ { "__count": "#no"} ] }

<!--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

ipv6

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

ipv6

Properties

Operations

update

unset

get (all)

get

count

In this article