/routing/ospf/instance
| Property | Description |
|---|---|
| domain-id (Hex | Address) | MPLS-related parameter. Identifies the OSPF domain of the instance. This value is attached to OSPF routes redistributed in BGP as VPNv4 routes as BGP extended community attribute and used when BGP VPNv4 routes are redistributed back to OSPF to determine whether to generate inter-area or AS-external LSA for that route. By default Null domain-id is used, as described in RFC 4577. |
| domain-tag (integer [0..4294967295]) | 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. |
| in-filter (string) | name of the routing filter chain used for incoming prefixes |
| mpls-te-address (string) | 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. |
| mpls-te-area (string) | 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. |
| originate-default (always | if-installed | never; ) | Specifies default route (0.0.0.0/0) distribution method. |
| out-filter-chain (name) | name of the routing filter chain used for outgoing prefixes filtering. Output operates only with "external" routes. |
| out-filter-select (name) | name of the routing filter select chain, used for output selection. Output operates only with "external" routes. |
| redistribute (bgp,connected,copy,dhcp,fantasy,modem,ospf,rip,static,vpn; ) | Enable redistribution of specific route types. |
| router-id (IP | name; Default: main) | OSPF Router ID. Can be set explicitly as an IP address, or as the name of the router-id instance. |
| version (2 | 3; Default: 2) | OSPF version this instance will be running (v2 for IPv4, v3 for IPv6). |
| vrf (name of a routing table; Default: main) | the VRF table this OSPF instance operates on |
| use-dn (yes | no) | Forces to use or ignore 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. Available since v6rc12. |
/routing/ospf/area
| Property | Description |
|---|---|
| area-id (IP address; Default: 0.0.0.0) | 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. |
| default-cost (integer; unset) | 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. |
| instance (name; mandatory) | Name of the OSPF instance this area belongs to. |
| no-summaries () | Flag parameter, if set then the area will not flood summary LSAs in the stub area. |
| name (string) | the name of the area |
| nssa-translate (yes | no | candidate) | The parameter indicates which ABR will be used as a translator from type7 to type5 LSA. Applicable only if area type is NSSA
|
| type (default | nssa | stub; Default: default) | The area type. Read more on the area types in the OSPF case studies. |
/routing/ospf/area/range
| Property | Description |
|---|---|
| advertise (yes | no; Default: yes) | Whether to create a summary LSA and advertise it to the adjacent areas. |
| area (name; mandatory) | the OSPF area associated with this range |
| cost (integer [0..4294967295]) | 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) |
| prefix (IP prefix; mandatory) | the network prefix of this range |
/routing/ospf/interface
Read-only matched interface menu
/routing/ospf/interface-template
The interface template defines common network and interface matches and what parameters to assign to a matched interface.
Matchers
| Property | Description |
|---|---|
interfaces (name) | Interfaces to match. Accepts specific interface names or the name of the interface list. |
| network (IP prefix) | 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. |
Assigned Parameters
| Property | Description |
|---|---|
| area (name; mandatory) | The OSPF area to which the matching interface will be associated. |
| auth (simple | md5 | sha1 | sha256 | sha384 | sha512) | Specifies authentication method for OSPF protocol messages.
If the parameter is unset, then authentication is not used. |
| auth-id (integer) | The key id is used to calculate message digest (used when MD5 or SHA authentication is enabled). The value should match all OSPF routers from the same region. |
| authentication-key (string) | The authentication key to be used, should match on all the neighbors of the network segment. |
| comment(string) | |
| cost(integer [0..65535]) | Interface cost expressed as link state metric. |
| dead-interval (time; Default: 40s) | 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 |
| disabled(yes | no) | |
| hello-interval (time; Default: 10s) | The interval between HELLO packets that the router sends out 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. |
| instance-id (integer [0..255]; Default: 0) | |
| passive () | If enabled, then do not send or receive OSPF traffic on the matching interfaces |
| prefix-list (name) | Name of the address list containing networks that should be advertised to the v3 interface. |
| priority (integer: 0..255; Default: 128) | 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. ROS v7 default value is 128 (defined in RFC), and the default value in ROS v6 was 1, keep this in mind when if you had strict priorities set for DR/BDR election. |
| retransmit-interval (time; Default: 5s) | Time interval 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; Default: 1s) | Link-state transmit delay is the estimated time it takes to transmit a link-state update packet on the interface. |
| type (broadcast | nbma | ptp | ptmp | ptp-unnumbered | virtual-link; Default: 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.
|
| vlink-neighbor-id (IP) | Specifies the router-id of the neighbor which should be connected over the virtual link. |
| vlink-transit-area (name) | 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. |
/routing/ospf/lsa
List of all the LSAs currently in the LSA database.
| Read-only Property | Description |
|---|---|
| age (integer) | How long ago (in seconds) the last update occurred |
| area (string) | The area this LSA belongs to. |
| body (string) | |
| checksum (string) | LSA checksum |
| dynamic (yes | no) | |
| flushing (yes | no) | |
| id (IP) | LSA record ID |
| instance (string) | The instance name this LSA belongs to. |
| link (string) | |
| link-instance-id (IP) | |
| originator (IP) | An originator of the LSA record. |
| self-originated (yes | no) | Whether LSA originated from the router itself. |
| sequence (string) | A number of times the LSA for a link has been updated. |
| type (string) | |
| wraparound (string) |
/routing/ospf/neighbor
List of currently active OSPF neighbors.
| Read-only Property | Description |
|---|---|
| address (IP) | An IP address of the OSPF neighbor router |
| adjacency (time) | Elapsed time since adjacency was formed |
| area (string) | |
| bdr (string) | An IP address of the Backup Designated Router |
| comment (string) | |
| db-summaries (integer) | |
| dr (IP) | An IP address of the Designated Router |
| dynamic (yes | no) | |
| inactive (yes | no) | |
| instance (string) | |
| ls-requests (integer) | |
| ls-retransmits (integer) | |
| priority (integer) | Priority configured on the neighbor |
| router-id (IP) | neighbor router's RouterID |
| state (down | attempt | init | 2-way | ExStart | Exchange | Loading | full) |
|
| state-changes (integer) | Total count of OSPF state changes since neighbor identification |
/routing/ospf/static-neighbor
Static configuration of the OSPF neighbors. Required for non-broadcast multi-access networks.
| Read-only Property | Description |
|---|---|
| address (IP%iface; mandatory ) | 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. |
| area (name; mandatory ) | Name of the area the neighbor belongs to. |
| comment (string) | |
| disabled (yes | no) | |
| instance-id (integer [0..255]; Default: 0) | |
| poll-interval (time; Default: 2m) | How often to send hello messages to the neighbors which are in a "down" state (i.e. there is no traffic from them) |