Skip to content

ospf_properties

Overview

API to edit basic properties for OSPF

Version information

Version : v2

URI scheme

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

Tags

  • ospf_properties : Operations related to ospf_properties

Paths

Get operation for ospf_properties

GET /ospf_properties

Description

Use this operation to get the basic OSPF properties

Responses

HTTP Code Description Schema
200 API Successfully executed ospf_properties_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_properties

PUT operation for ospf_properties

PUT /ospf_properties

Description

Use this operation to modify the basic OSPF properties

Parameters

Type Name Schema
Body body
optional
ospf_properties_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added ospf_properties_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

Consumes

  • application/json

Produces

  • application/json

Tags

  • ospf_properties

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

advertise_bgp_routes

Set to true to advertise the routes learnt from BGP peers to the OSPF peers.

Type : boolean

advertise_sdwan_routes

Set to true to allow SD-WAN routes to be advertised via OSPF.

Type : boolean

enabled

Set to true to enable OSPF.

Type : boolean

export_ospf_route_type

Advertise the SD-WAN route to OSPF neighbors as type-1 Intra-area route or type-5 External route. Default route is always advertised as type-5 External route to normal areas and type-1 summary route to stub areas.

Type : enum (type_1, type_5)

export_ospf_route_weight

When export SD-WAN routes to OSPF, add the weight to each route's SD-WAN cost as total cost

Type : integer

ospf_properties

Name Schema
advertise_bgp_routes
optional
advertise_bgp_routes
advertise_sdwan_routes
optional
advertise_sdwan_routes
enabled
optional
enabled
export_ospf_route_type
optional
export_ospf_route_type
export_ospf_route_weight
optional
export_ospf_route_weight
package_name
optional
package_name
router_id
optional
router_id
site_name
optional
site_name

ospf_properties_delete_success_schema

Name Schema
ospf_properties
optional
ospf_properties

ospf_properties

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

ospf_properties_post_success_schema

Name Schema
ospf_properties
optional
ospf_properties

ospf_properties

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

ospf_properties_put_success_schema

Name Schema
ospf_properties
optional
ospf_properties

ospf_properties

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

ospf_properties_request_schema

Name Schema
ospf_properties
optional
ospf_properties

ospf_properties_response_schema

Type : < ospf_properties_response_schema > array

ospf_properties_response_schema

Name Schema
advertise_bgp_routes
optional
advertise_bgp_routes
advertise_sdwan_routes
optional
advertise_sdwan_routes
enabled
optional
enabled
export_ospf_route_type
optional
export_ospf_route_type
export_ospf_route_weight
optional
export_ospf_route_weight
package_name
optional
package_name
router_id
optional
router_id
site_name
optional
site_name

package_name

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

Type : string

router_id

A unique identifier in IPv4 format, used for OSPF advertisements.

Type : string

site_name

Site Name

Type : string