ipv6
Configuration for ip v6 resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| ralearning | <String> | Read-write | Enable the NetScaler appliance to learn about various routes from Router Advertisement (RA) and Router Solicitation (RS) messages sent by the routers.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| routerredirection | <String> | Read-write | Enable the NetScaler appliance to do Router Redirection.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| ndbasereachtime | <Double> | Read-write | Base reachable time of the Neighbor Discovery (ND6) protocol. The time, in milliseconds, that the NetScaler appliance assumes an adjacent device is reachable after receiving a reachability confirmation.<br>Default value: 30000<br>Minimum value = 1 |
| ndretransmissiontime | <Double> | Read-write | Retransmission time of the Neighbor Discovery (ND6) protocol. The time, in milliseconds, between retransmitted Neighbor Solicitation (NS) messages, to an adjacent device.<br>Default value: 1000<br>Minimum value = 1 |
| natprefix | <String> | 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 NetScaler appliance to ensure that the IPv6-IPv4 translation is done by the appliance. |
| td | <Double> | 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.<br>Minimum value = 0<br>Maximum value = 4094 |
| dodad | <String> | Read-write | Enable the NetScaler appliance to do Duplicate Address<br>Detection (DAD) for all the NetScaler owned IPv6 addresses regardless of whether they are obtained through stateless auto configuration, DHCPv6, or manual configuration.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| basereachtime | <Integer> | Read-only | ND6 base reachable time (ms). |
| reachtime | <Integer> | Read-only | ND6 computed reachable time (ms). |
| ndreachtime | <Double> | Read-only | ND6 computed reachable time (ms). |
| retransmissiontime | <Integer> | Read-only | ND6 retransmission time (ms). |
| __count | <Double> | 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>
}}
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
}}
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
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 errorResponse Headers:
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>
}]}
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
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 errorResponse Headers:
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>
}]}
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 errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "ipv6": [ { "__count": "#no"} ] }