ADC NITRO APIs

nd6ravariables

August 17, 2023

Contributed by:

Configuration for nd6 Router Advertisment configuration variables resource.

Properties

(click to see Operations )

Name	Permissions	Description
vlan	Read-write	The VLAN number. Minimum value = 1 Maximum value = 4094
ceaserouteradv	Read-write	Cease router advertisements on this vlan. Default value: NO Possible values = YES, NO
sendrouteradv	Read-write	whether the router sends periodic RAs and responds to Router Solicitations. Default value: NO Possible values = YES, NO
srclinklayeraddroption	Read-write	Include source link layer address option in RA messages. Default value: YES Possible values = YES, NO
onlyunicastrtadvresponse	Read-write	Send only Unicast Router Advertisements in respond to Router Solicitations. Default value: NO Possible values = YES, NO
managedaddrconfig	Read-write	Value to be placed in the Managed address configuration flag field. Default value: NO Possible values = YES, NO
otheraddrconfig	Read-write	Value to be placed in the Other configuration flag field. Default value: NO Possible values = YES, NO
currhoplimit	Read-write	Current Hop limit. Default value: 64 Minimum value = 0 Maximum value = 255
maxrtadvinterval	Read-write	Maximum time allowed between unsolicited multicast RAs, in seconds. Default value: 600 Minimum value = 4 Maximum value = 1800
minrtadvinterval	Read-write	Minimum time interval between RA messages, in seconds. Default value: 198 Minimum value = 3 Maximum value = 1350
linkmtu	Read-write	The Link MTU. Default value: 0 Minimum value = 0 Maximum value = 1500
reachabletime	Read-write	Reachable time, in milliseconds. Default value: 0 Minimum value = 0 Maximum value = 3600000
retranstime	Read-write	Retransmission time, in milliseconds. Default value: 0
defaultlifetime	Read-write	Default life time, in seconds. Default value: 1800 Minimum value = 0 Maximum value = 9000
lastrtadvtime	Read-only	Last RA sent timestamp.
nextrtadvdelay	Read-only	Next RA delay.
__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/nd6ravariables

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nd6ravariables":{
<b>      "vlan":<Double_value>,
</b>      "ceaserouteradv":<String_value>,
      "sendrouteradv":<String_value>,
      "srclinklayeraddroption":<String_value>,
      "onlyunicastrtadvresponse":<String_value>,
      "managedaddrconfig":<String_value>,
      "otheraddrconfig":<String_value>,
      "currhoplimit":<Double_value>,
      "maxrtadvinterval":<Double_value>,
      "minrtadvinterval":<Double_value>,
      "linkmtu":<Double_value>,
      "reachabletime":<Double_value>,
      "retranstime":<Double_value>,
      "defaultlifetime":<Integer_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/nd6ravariables? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nd6ravariables":{
<b>      "vlan":<Double_value>,
</b>      "ceaserouteradv":true,
      "sendrouteradv":true,
      "srclinklayeraddroption":true,
      "onlyunicastrtadvresponse":true,
      "managedaddrconfig":true,
      "otheraddrconfig":true,
      "currhoplimit":true,
      "maxrtadvinterval":true,
      "minrtadvinterval":true,
      "linkmtu":true,
      "reachabletime":true,
      "retranstime":true,
      "defaultlifetime":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/nd6ravariables

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/nd6ravariables? 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/nd6ravariables? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of nd6ravariables 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/nd6ravariables? pagesize=#no;pageno=#no

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

{ "nd6ravariables": [ {
      "vlan":<Double_value>,
      "ceaserouteradv":<String_value>,
      "sendrouteradv":<String_value>,
      "srclinklayeraddroption":<String_value>,
      "onlyunicastrtadvresponse":<String_value>,
      "managedaddrconfig":<String_value>,
      "otheraddrconfig":<String_value>,
      "currhoplimit":<Double_value>,
      "maxrtadvinterval":<Double_value>,
      "minrtadvinterval":<Double_value>,
      "linkmtu":<Double_value>,
      "reachabletime":<Double_value>,
      "retranstime":<Double_value>,
      "defaultlifetime":<Integer_value>,
      "lastrtadvtime":<Double_value>,
      "nextrtadvdelay":<Double_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/nd6ravariables/ vlan_value<Double>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/nd6ravariables/ vlan_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/nd6ravariables/ vlan_value<Double> ? view=summary

Use this query-parameter to get the summary output of nd6ravariables 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:

{  "nd6ravariables": [ {
      "vlan":<Double_value>,
      "ceaserouteradv":<String_value>,
      "sendrouteradv":<String_value>,
      "srclinklayeraddroption":<String_value>,
      "onlyunicastrtadvresponse":<String_value>,
      "managedaddrconfig":<String_value>,
      "otheraddrconfig":<String_value>,
      "currhoplimit":<Double_value>,
      "maxrtadvinterval":<Double_value>,
      "minrtadvinterval":<Double_value>,
      "linkmtu":<Double_value>,
      "reachabletime":<Double_value>,
      "retranstime":<Double_value>,
      "defaultlifetime":<Integer_value>,
      "lastrtadvtime":<Double_value>,
      "nextrtadvdelay":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/nd6ravariables? 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:

{ "nd6ravariables": [ { "__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

nd6ravariables

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

nd6ravariables

Properties

Operations

update

unset

get (all)

get

count

In this article