ADC NITRO APIs

ospf6Neighbor

May 23, 2024

Contributed by:

Configuration for ospf6Neighbor resource.

Properties

(click to see Operations )

Name	Permissions	Description
BDR	Read-write	The backup designated router for the network.
DR	Read-write	The designated router for the network.
area	Read-write	The area to which the neighbor belongs.
interface	Read-write	The interface of peering.
ip6address	Read-write	The IP address this neighbor is using in its IP Source Address.
options	Read-write	The options received from this neighbor.
priority	Read-write	The priority of this neighbor in the designated router election algorithm.
routerId	Read-write	The IpAddress that uniquely identifies the neighboring router in the Autonomous System.
state	Read-write	The state of the relationship with this neighbor.
tagId	Read-write	OSPFv3 Tag

Operations

(click to see Properties )

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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/ospf6Neighbor URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/ospf6Neighbor?args=tagId:<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/ospf6Neighbor ?args=tagId:<String>

Use this query-parameter to get ospf6Neighbor resources based on additional properties.

HTTP Method: GET

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 Payload:

{ "routerDynamicRouting": {
"ospf6Neighbor" : [{
"BDR" : <String>,
"DR" : <String>,
"area" : <Integer>,
"interface" : <String>,
"ip6address" : <None>,
"options" : <String>,
"priority" : <Integer>,
"routerId" : <String>,
"state" : <String>,
"tagId" : <String>
}]
}}

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

ospf6Neighbor

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

ospf6Neighbor

Properties

Operations

get

In this article