ADC NITRO APIs

ospfRouter

May 23, 2024

Contributed by:

Configuration for ospfRouter resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
area		Read-write	OSPF area ID as a decimal value. Minimum value: 0 Maximum value: 4294967295
ipaddress		Read-write	OSPF network prefix.
netmask		Read-write	The netmask length Minimum value: 0 Maximum value: 32
passiveInterface	[]	Read-write	Suppress routing updates on an interface
processId		Read-write	OSPF process ID Minimum value: 1 Maximum value: 65535
metric		Read-write	The metric of redistributed routes. Minimum value: 0 Maximum value: 16777214
metricType		Read-write	OSPF metric type for default routes - OSPF External Type 1 metrics or Type 2 metrics. Minimum value: 1 Maximum value: 2
ospfProcessId		Read-write	The process ID of the ospf instance to redistribute the routes from.
protocol		Read-write	The protocol from which routes need to be redistributed. Possible values: bgp, connected, intranet, isis, kernel, ospf, rip, static
routeMap		Read-write	Route map reference
tag		Read-write	Set tag for routes redistributed into OSPF Minimum value: 0 Maximum value: 4294967295
routerId		Read-write	Router-id for the OSPF process

Operations

(click to see Properties )

ADD
SET
UNSET
DELETE
GET

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/routerDynamicRouting/ospfRouter HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"routerDynamicRouting" : {
"ospfRouter" : {
"networks" : {
"area" : <Integer>,
"ipaddress" : <String>,
"netmask" : <Integer>
},
"passiveInterface" : [<String>],
<b>"processId" : <Integer></b>,
"redistribute" : {
"metric" : <Integer>,
"metricType" : <Integer>,
"ospfProcessId" : <Integer>,
"protocol" : <String>,
"routeMap" : <String>,
"tag" : <Integer>
},
"routerId" : <String>
}
}}

<!--NeedCopy-->

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

set

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/ospfRouter HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"routerDynamicRouting" : {
"ospfRouter" : {
"networks" : {
"area" : <Integer>,
"ipaddress" : <String>,
"netmask" : <Integer>
},
"passiveInterface" : [<String>],
<b>"processId" : <Integer></b>,
"redistribute" : {
"metric" : <Integer>,
"metricType" : <Integer>,
"ospfProcessId" : <Integer>,
"protocol" : <String>,
"routeMap" : <String>,
"tag" : <Integer>
},
"routerId" : <String>
}
}}

<!--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/routerDynamicRouting/ospfRouter HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"routerDynamicRouting" : {
"ospfRouter" : {
"networks" : {
"area" : <Integer>,
"ipaddress" : <String>,
"netmask" : <Integer>
},
"passiveInterface" : [<String>],
<b>"processId" : <Integer></b>,
"redistribute" : {
"metric" : true,
"metricType" : true,
"ospfProcessId" : <Integer>,
"protocol" : <String>,
"routeMap" : true,
"tag" : true
},
"routerId" : 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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/ospfRouter?args=processId:<Integer> HTTP Method: DELETE

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

URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/ospfRouter URL: http:// <netscaler-ip-address> /nitro/v1/config/routerDynamicRouting/ospfRouter?args=processId:<Integer> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/ospfRouter ?args=processId:<Integer>

Use this query-parameter to get ospfRouter 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": {
"ospfRouter" : [{
"networks" : [{
"area" : <Integer>,
"ipaddress" : <String>,
"netmask" : <Integer>
}],
"passiveInterface" : [<String>],
"processId" : <Integer>,
"redistribute" : [{
"metric" : <Integer>,
"metricType" : <Integer>,
"ospfProcessId" : <Integer>,
"protocol" : <String>,
"routeMap" : <String>,
"tag" : <Integer>
}],
"routerId" : <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

ospfRouter

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

ospfRouter

Properties

Operations

add

set

unset

delete

get

In this article