ospf

---

routing/ospf

Type: Directory

routing/ospf/instance

Type: Directory

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive

Argument	Type	Description
name	string
version	enum (2 | 3)	OSPF version this instance will be running (v2 for IPv4, v3 for IPv6).
vrf	enum	The VRF table this OSPF instance operates on.
router-id	alt { ipAddr , enum }	OSPF Router ID. Can be set explicitly as an IP address, or as the name of the router-id instance.
out-filter-select ( unset )	enum	Name of the routing filter select chain, used for output selection. Output operates only with external routes.
out-filter-chain ( unset )	enum
originate-default ( unset )	enum (never | always | if-installed)	Specifies the default route (0.0.0.0/0) distribution method.
in-filter-chain ( unset )	enum	Name of the routing filter chain used for incoming prefixes.
routing-table ( unset )	enum
mpls-te-address ( unset )	address (flags=64)
mpls-te-area ( unset )	ipAddr	The area used for MPLS traffic engineering. TE Opaque LSAs are generated in this area. No more than one OSPF instance can have mpls-te-area configured.
domain-id ( unset )	address (flags=R)	MPLS-related parameter. Identifies the OSPF domain of the instance. This value is attached to OSPF routes redistributed in BGP as VPNv4 routes as a BGP extended community attribute and used when BGP VPNv4 routes are redistributed back to OSPF to determine whether to generate an inter-area or AS-external LSA for that route. By default Null domain-id is used, as described in RFC 4577.
domain-tag ( unset )	num	If set, then used in route redistribution (as route-tag in all external LSAs generated by this router), and in route calculation (all external LSAs having this route tag are ignored). Needed for interoperability with older Cisco systems. By default not set.
use-dn ( unset )	bool	Forces use or ignoring of the DN bit. Useful in some CE-PE scenarios to inject intra-area routes into VRF. If a parameter is unset, then the DN bit is used according to RFC.
redistribute ( unset )	ubit (connected, static, rip, ospf, isis, bgp, vpn, dhcp, fantasy, modem, bgp-mpls-vpn, slaac)	Enable redistribution of specific route types.

routing/ospf/area

Type: Directory

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive
D	dynamic	dynamic
T	transit-capable	transit-capable

Argument	Type	Description
name	string	The name of the area
instance ( mandatory )	enum	Name of the OSPF instance this area belongs to.
area-id	ipAddr	OSPF area identifier. If the router has networks in more than one area, then an area with area-id=0.0.0.0 (the backbone) must always be present. The backbone always contains all area border routers. The backbone is responsible for distributing routing information between non-backbone areas. The backbone must be contiguous, i.e. there must be no disconnected segments. However, area border routers do not need to be physically connected to the backbone - connection to it may be simulated using a virtual link.
type	enum (default | stub | nssa)	The area type. Read more on the area types in the OSPF user guides.
no-summaries	switch	Flag parameter, if set then the area will not flood summary LSAs in the stub area.
default-cost ( unset )	num	Default cost of injected LSAs into the area. If the value is not set, then stub area type-3 default LSA will not be originated.
nssa-translator ( unset )	enum (candidate | no | yes)	The parameter indicates which ABR will be used as a translator from type-7 to type-5 LSA. Applicable only if area type is NSSA. yes - the router will be always used as a translator. no - the router will never be used as a translator. candidate - OSPF elects one of the candidate routers to be a translator.

Read-only Argument	Type	Description
transit-capable	bool

routing/ospf/area/range

Type: Directory

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive
A	advertise	advertise

Argument	Type	Description
area ( mandatory )	enum	The OSPF area associated with this range.
prefix ( mandatory )	address (flags=46/)	The network prefix of this range.
advertise	bool	Whether to create a summary LSA and advertise it to the adjacent areas.
cost ( unset )	num	The cost of the summary LSA this range will create. Default - use the largest cost of all routes used (i.e. routes that fall within this range).

routing/ospf/interface-template

Type: Directory

The interface template defines common network and interface matches and what parameters to assign to a matched interface.

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive

Argument	Type	Description
area ( mandatory )	enum	The OSPF area to which the matching interface will be associated.
interfaces ( unset )	obj_arg { interface_enum { } { } }	Matcher. Interfaces to match. Accepts specific interface names or the name of the interface list.
instance-id	num
networks ( unset )	obj_arg { address (flags=46/) }	Matcher. The network prefix associated with the area. OSPF will be enabled on all interfaces that have at least one address falling within this range. Note that the network prefix of the address is used for this check (i.e. not the local address). For point-to-point interfaces, this means the address of the remote endpoint.
prefix-list ( unset )	enum	Name of the address list containing networks that should be advertised to the v3 interface.
type	enum (broadcast | nbma | ptp | ptp-unnumbered | ptmp | ptmp-broadcast)	The OSPF network type on this interface. Note that if interface configuration does not exist, the default network type is 'point-to-point' on PtP interfaces and 'broadcast' on all other interfaces. broadcast - Network type suitable for Ethernet and other multicast capable link layers. Elects designated router. nbma - Non-Broadcast Multiple Access. Protocol packets are sent to each neighbor's unicast address. Requires manual configuration of neighbors. Elects designated router. ptp - Suitable for networks that consist only of two nodes. Does not elect a designated router ptmp - Point-to-Multipoint. Easier to configure than NBMA because it requires no manual configuration of a neighbor. Does not elect a designated router. This is the most robust network type and as such suitable for wireless networks, if 'broadcast' mode does not work well enough for them ptp-unnumbered - Works the same as ptp, except that the remote neighbor does not have an associated IP address to a specific PTP interface. For example, in case IP unnumbered is used on Cisco devices.
retransmit-interval	time	Time interval after which the lost link state advertisement will be resent. When a router sends a link state advertisement (LSA) to its neighbor, the LSA is kept until the acknowledgment is received. If the acknowledgment was not received in time (see transmit-delay), the router will try to retransmit the LSA.
transmit-delay	time	Link-state transmit delay is the estimated time it takes to transmit a link-state update packet on the interface.
hello-interval	time	The interval between HELLO packets that the router sends out on this interface. The smaller this interval is, the faster topological changes will be detected; the tradeoff is more OSPF protocol traffic. This value must be the same for all the routers on a specific network, otherwise, adjacency between them will not form.
dead-interval	time	Specifies the interval after which a neighbor is declared dead. This interval is advertised in hello packets. This value must be the same for all routers on a specific network, otherwise, adjacency between them will not form.
priority	num	Router's priority. Used to determine the designated router in a broadcast network. The router with the highest priority value takes precedence. Priority value 0 means the router is not eligible to become a designated or backup designated router at all. Default value is 128 (defined in RFC), keep this in mind if you had strict priorities set for DR/BDR election.
cost	num	Interface cost expressed as link state metric.
passive	switch	If enabled, then the router does not send or receive OSPF traffic on the matching interfaces.
auth ( unset )	enum (simple | md5 | sha1 | sha256 | sha384 | sha512)	Specifies authentication method for OSPF protocol messages. simple - plain text authentication. md5 - keyed Message Digest 5 authentication. sha* - HMAC-SHA authentication RFC5709. If the parameter is unset, then authentication is not used.
auth-key ( unset )	string	The authentication key to be used, should match on all the neighbors of the network segment.
auth-id ( unset )	num	The key id is used to calculate a message digest (used when MD5 or SHA authentication is enabled). The value should match all OSPF routers from the same region.
use-bfd ( unset )	bool

routing/ospf/interface

Type: Directory

Flag	Name	Description
D	dynamic	dynamic
X	disabled	disabled

Argument	Type	Description
interface ( unset )	interface_enum
address ( unset )	address (flags=4i)
area	enum
instance-id	num
type	enum (broadcast | nbma | ptp | ptp-unnumbered | ptmp | virtual-link)	The OSPF network type on this interface. Note that if interface configuration does not exist, the default network type is 'point-to-point' on PtP interfaces and 'broadcast' on all other interfaces. broadcast - Network type suitable for Ethernet and other multicast capable link layers. Elects designated router. nbma - Non-Broadcast Multiple Access. Protocol packets are sent to each neighbor's unicast address. Requires manual configuration of neighbors. Elects designated router. ptp - Suitable for networks that consist only of two nodes. Does not elect a designated router ptmp - Point-to-Multipoint. Easier to configure than NBMA because it requires no manual configuration of a neighbor. Does not elect a designated router. This is the most robust network type and as such suitable for wireless networks, if 'broadcast' mode does not work well enough for them ptp-unnumbered - Works the same as ptp, except that the remote neighbor does not have an associated IP address to a specific PTP interface. For example, in case IP unnumbered is used on Cisco devices. virtual-link - Interface for virtual link.
cost	num
priority	num
use-bfd ( unset )	bool
retransmit-interval	time
transmit-delay	time
hello-interval	time
dead-interval	time
vlink-transit-area ( unset )	enum	A non-backbone area the two routers have in common over which the virtual link will be established. Virtual links can not be established through stub areas.
vlink-neighbor-id ( unset )	ipAddr	Specifies the router-id of the neighbor which should be connected over the virtual link.

Read-only Argument	Type	Description
state	enum (down | loopback | ptp | passive | waiting | standby | dr-other | bdr | dr)
dr	ipAddr
bdr	ipAddr
vlink-remote-address	address (flags=46)

routing/ospf/static-neighbor

Type: Directory

Static configuration of the OSPF neighbors. Required for non-broadcast multi-access networks.

Flag	Name	Description
X	disabled	disabled
I	inactive	inactive

Argument	Type	Description
area ( mandatory )	enum	Name of the area the neighbor belongs to.
address ( mandatory )	address (flags=46i)	The unicast IP address and an interface that can be used to reach the IP of the neighbor. For example, address=1.2.3.4%ether1 indicates that a neighbor with IP 1.2.3.4 is reachable on the ether1 interface.
instance-id	num
poll-interval	time	How often to send hello messages to the neighbors that are in a down state (i.e., there is no traffic from them).

routing/ospf/neighbor

Type: Directory

List of currently active OSPF neighbors.

Flag	Name	Description
V	virtual	virtual
D	dynamic	dynamic

Read-only Argument	Type	Description
instance	enum
area	enum
interface	interface_enum	Name of the interface this neighbor was discovered.
address	address (flags=46i)	An IP address of the OSPF neighbor router.
priority	num
router-id	ipAddr	Neighbor router's RouterID
dr	ipAddr	An IP address of the Designated Router.
bdr	ipAddr	An IP address of the Backup Designated Router.
state	string	Down - No Hello packets have been received from a neighbor. Attempt - Applies only to NBMA clouds. The state indicates that no recent information was received from a neighbor. Init - Hello packet received from the neighbor, but bidirectional communication is not established (Its own RouterID is not listed in the Hello packet). 2-way - This state indicates that bi-directional communication is established. DR and BDR elections occur during this state. Routers build adjacencies based on whether the router is DR or BDR, and the link is point-to-point or a virtual link. ExStart - Routers try to establish the initial sequence number that is used for the packet information exchange. The router with a higher ID becomes the master and starts the exchange. Exchange - Routers exchange database description (DD) packets. Loading - In this state, actual link state information is exchanged. Link State Request packets are sent to neighbors to request any new LSAs that were found during the Exchange state. Full - Adjacency is complete, and neighbor routers are fully adjacent. LSA information is synchronized between adjacent routers. Routers achieve the full state with their DR and BDR only. An exception is P2P links.
state-changes	num
ls-retransmits	num
ls-requests	num
db-summaries	num
adjacency	time	Elapsed time since adjacency was formed.
timeout	time

routing/ospf/lsa

Type: Directory

Flag	Name	Description
S	self-originated	Whether the LSA originated from the router itself.
F	flushing	flushing
W	wraparound	wraparound
D	dynamic	dynamic

Read-only Argument	Type	Description
instance	enum
area	enum	The area this LSA belongs to.
link	address (flags=4i)
link-instance-id	num
type	string
originator	ipAddr	An originator of the LSA record.
id	ipAddr	LSA record ID
sequence	num	A number of times the LSA for a link has been updated.
age	num	How long ago (in seconds) the last update occurred.
checksum	num
body	string