nd6¶
Configuration for nd6 resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
neighbor | <String> | Read-write | Link-local IPv6 address of the adjacent network device to add to the ND6 table. |
mac | <String> | Read-write | MAC address of the adjacent network device. |
ifnum | <String> | Read-write | Interface through which the adjacent network device is available, specified in slot/port notation (for example, 1/3). Use spaces to separate multiple entries. |
vlan | <Integer> | Read-write | Integer value that uniquely identifies the VLAN on which the adjacent network device exists.
Minimum value = 1 Maximum value = 4094 |
vxlan | <Double> | Read-write | ID of the VXLAN on which the IPv6 address of this ND6 entry is reachable.
Minimum value = 1 Maximum value = 16777215 |
vtep | <String> | Read-write | IP address of the VXLAN tunnel endpoint (VTEP) through which the IPv6 address of this ND6 entry is reachable.
Minimum length = 1 |
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.
Minimum value = 0 Maximum value = 4094 |
nodeid | <Double> | Read-write | Unique number that identifies the cluster node.
Minimum value = 0 Maximum value = 31 |
state | <String> | Read-only | ND6 state.
Default value: REACHABLE Possible values = INCOMPLETE, REACHABLE, STALE, DELAY, PROBE |
timeout | <Double> | Read-only | Time elapsed. |
flags | <Double> | Read-only | flag for static/permanent entry. |
controlplane | <Boolean> | Read-only | This nd6 entry is populated by a control plane protocol. |
channel | <Double> | Read-only | The tunnel that is bound to a netbridge. |
__count | <Double> | Read-only | count parameter |
Operations¶
(click to see Properties )
- ADD
- CLEAR
- DELETE
- GET (ALL)
- 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
add¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/nd6
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nd6":{
<b> "neighbor":<String_value>,
</b><b> "mac":<String_value>,
</b> "ifnum":<String_value>,
"vlan":<Integer_value>,
"vxlan":<Double_value>,
"vtep":<String_value>,
"td":<Double_value>
}}
Response:
HTTP Status Code on Success: 201 Created
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
clear¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/nd6? action=clear
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nd6":{
}}
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
delete¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/nd6/ neighbor_value<String>
Query-parameters:
args=vlan: <Integer_value> ,vxlan: <Double_value> ,td: <Double_value>
HTTP Method: DELETE
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
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/nd6
Query-parameters:
args
http:// <netscaler-ip-address> /nitro/v1/config/nd6? args=neighbor: <String_value> ,td: <Double_value> ,nodeid: <Double_value>
Use this query-parameter to get nd6 resources based on additional properties.
attrs
http:// <netscaler-ip-address> /nitro/v1/config/nd6? 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/nd6? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of nd6 resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http:// <netscaler-ip-address> /nitro/v1/config/nd6? view=summary
Use this query-parameter to get the summary output of nd6 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/nd6? pagesize=#no;pageno=#no
Use this query-parameter to get the nd6 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:
{ "nd6": [ {
neighbor:<String_value>,td:<Double_value>,nodeid:<Double_value> "mac":<String_value>,
"state":<String_value>,
"timeout":<Double_value>,
"ifnum":<String_value>,
"vlan":<Integer_value>,
"vxlan":<Double_value>,
"vtep":<String_value>,
"flags":<Double_value>,
"controlplane":<Boolean_value>,
"channel":<Double_value>
}]}
count¶
URL: http:// <netscaler-ip-address> /nitro/v1/config/nd6? 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:
{ "nd6": [ { "__count": "#no"} ] }