/system/vrfs/{name}/ospf_routers/{instance_tag}

put

https://switch-ip/rest/v10.08/system/vrfs/{name}/ospf_routers/{instance_tag}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

instance_tag

string

required

Reference Resource: OSPF_Router
The list of all the OSPFv2 Router instances.

Body Params

spf_throttle

object

Timers related to SPF throttling.

strict_lsa_check_disable

boolean

Specifies whether strict LSA checking is disabled for this OSPF router instance.

gr_ignore_lost_interface

boolean

Specifies whether to ignore OSPF interfaces that have gone down just prior to the restart event.

maximum_paths

integer

1 to 8

Maximum number of equal cost paths that are stored for each destination in the Routing Table.

protocol_disable

boolean

Disable this OSPF instance.

other_config

object

asbr_summary_addresses

object

List of ASBR summary addresses associated with this OSPF router instance. These summarized addresses are in the IPv4 or IPv6 address/mask format.

helper_disable

boolean

Indicates whether OSPF will help a neighbor undergoing hitless restart on this interface.

lsa_throttle

object

Timers related to LSA throttling.

restart_interval

integer

5 to 1800

If OSPF is attempting to undergo a graceful restart, this field specifies the length of grace period that should be requested from adjacent routers in grace LSAs.

default_originate

string

enum

Criteria for redistribution of the default routes into the OSPF domain: 'disable' : no default route should be advertised. 'originate' : advertise default route if it exists in the routing table. 'always_originate': always advertise default route, regardless of its presence in the routing table.

Allowed:

auto_cost_ref_bw

integer

1 to 4000000

The reference bandwidth, Mbits/second, for interface cost calculations.

areas

object

Reference Resource: OSPF_Area
The list of all the "OSPF_Area" for the OSPF router instance, which contains the OSPFv2 area related configurations. The Area ID is in IPv4 address format.

admin_router_id

string

length ≤ 15

The router identifier configured for the OSPF instance. The router ID MUST be unique within the entire Autonomus System. If admin_router_id is present, the same will be elected as active_router_id. The router ID is in IPv4 address format.

stub_router_adv

object

active_interfaces

array of strings

length ≤ 9223372036854776000

Reference Resource: Port
The list of the active-interfaces. If "passive_interface_default" is set "false", then this list should be empty.

active_interfaces

distance

object

redistribute_ospf_route_map

object

Reference Resource: OSPF_Router
Route Map to be applied when redistributing routes from other OSPF instances.

passive_interfaces

array of strings

length ≤ 9223372036854776000

Reference Resource: Port
The list of the passive-interfaces. If "passive_interface_default" is set "true", then this list should be empty.

passive_interfaces

snmp_traps

object

The configurations related to the OSPF SNMP traps.

instance_tag

integer

required

Reference Resource: OSPF_Router
The list of all the OSPFv3 Router instances.

redistribute_route_map

object

Reference Resource: Route_Map
Route Map to be applied when redistributing routes.

bfd_all_interfaces_enable

boolean

Enables BFD on all interfaces involved in OSPF router.

redistribute_ospf

array of strings

length ≤ 7

Reference Resource: OSPF_Router
Redistribute routes from other OSPF instances into this OSPF instance. If the same instance also has a route map based filter associated with it, only the filtered routes will be redistributed into this instance.

redistribute_ospf

lsa_arrival

integer

0 to 600000

Minimum wait time in milliseconds before same LSAs received from a peer are processed.

passive_interface_default

boolean

This determines whether all interfaces should be set to passive by default.

redistribute

array of strings

length ≤ 5

Redistribute routes from other sources into this OSPF instance. If the same source also has a route map based filter associated with it, only the filtered routes will be redistributed into this instance.

redistribute

Responses

200

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Loading…