Skip to content

ospf_area

Overview

API to add, delete, get, modify OSPF areas.

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • ospf_area : Operations related to ospf_area

Paths

POST operation for ospf_area

POST /ospf_area

Description

Use this operation to add OSPF area

Parameters

Type Name Schema
Body body
optional
ospf_area_request_schema

Responses

HTTP Code Description Schema
200 Resource successfully added ospf_area_post_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • ospf_area

Get operation for ospf_area

GET /ospf_area

Description

Use this operation to get OSPF areas

Responses

HTTP Code Description Schema
200 API Successfully executed ospf_area_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • ospf_area

PUT operation for ospf_area

PUT /ospf_area

Description

Use this operation to modify OSPF area

Responses

HTTP Code Description Schema
200 Resource modified added ospf_area_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • ospf_area

DELETE operation for ospf_area

DELETE /ospf_area/{deletePathParam}

Description

Use this operation to delete OSPF area

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added ospf_area_delete_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • ospf_area

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify OSPF area

Type : integer

ospf_area

Name Schema
id
optional
id
ospf_area_properties
optional
ospf_area_properties
ospf_area_virtual_interface
optional
ospf_area_virtual_interface
package_name
optional
package_name
site_name
optional
site_name

ospf_area_delete_success_schema

Name Schema
ospf_area
optional
ospf_area

ospf_area

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

ospf_area_post_success_schema

Name Schema
ospf_area
optional
ospf_area

ospf_area

Name Description Schema
message
optional
Example : "resource added succesfully" string

ospf_area_properties

OSPF area properties

Type : < ospf_area_properties > array

ospf_area_properties

Name Description Schema
area_id
optional
The IP Address or Area ID(INT) to identify the area that OSPF will learn routes from and advertise routes to string
stub_area
optional
If enabled, the Area will not receive route advertisements from outside of the designated Autonomous System boolean

ospf_area_put_success_schema

Name Schema
ospf_area
optional
ospf_area

ospf_area

Name Description Schema
message
optional
Example : "resource modified succesfully" string

ospf_area_request_schema

Name Schema
ospf_area
optional
ospf_area

ospf_area_response_schema

Type : < ospf_area_response_schema > array

ospf_area_response_schema

Name Schema
id
optional
id
ospf_area_properties
optional
ospf_area_properties
ospf_area_virtual_interface
optional
ospf_area_virtual_interface
package_name
optional
package_name
site_name
optional
site_name

ospf_area_virtual_interface

OSPF area virtual interface

Type : < ospf_area_virtual_interface > array

ospf_area_virtual_interface

Name Description Schema
authentication_type
optional
The authentication type from 'none', 'plain_text' or 'md5' can used for authentication enum (none, plain_text, md5)
dead_interval
optional
The amount of time to wait to recieve a Hello protocol packet before marking a router as dead integer
hello_interval
optional
The amount of time to wait between sending Hello protocol packets to directly connected neighbors integer
id
optional
Auto-generated ID to uniquely identify the OSPF area virtual interface integer
interface_cost
optional
The base cost for routes learned on the interface integer
network_type
optional
The type of network from 'auto', 'pointtopoint', 'broadcast' can be used to determine connection of OSPF interface enum (auto, pointtopoint, broadcast)
password
optional
The password used to encrypt and decrypt OSPF packets when password_type is chosen from plain_text or md5 string
routing_domain
optional
Choose one of the configured Routing Domains, Leave blank or any for Any Routing Domain string
virtual_interface_name
optional
The Virtual Interface Name of which source IP address is used to send OSPF messages for this interface string

package_name

Config package name using which the site API operation should be performed.

Type : string

site_name

Site Name

Type : string