3.15. OSPF Configuration Command Reference

3.15.1. Command Hierarchies

3.15.1.1. Configuration Commands

config
— router
[no] ospf [ospf-instance] [router-id]
advertise-router-capability {link | area | as}
[no] area area-id
area-range ip-prefix/mask [advertise | not-advertise]
— no area-range ip-prefix/mask
[no] bier
[no] shutdown
template template-name
— no template
[no] export policy-name [policy-name]
[no] import policy-name [policy-name]
[no] interface ip-int-name [secondary]
[no] adjacency-set id
adjacency-sid label value
auth-keychain name
authentication-key [authentication-key | hash-key] [hash | hash2 | custom]
authentication-type {password | message-digest}
bfd-enable [remain-down-on-failure]
— no bfd-enable
dead-interval seconds
hello-interval seconds
interface-type {broadcast | point-to-point | non-broadcast}
lfa-policy-map route-nh-template template-name
load-balancing-weight [weight]
lsa-filter-out [all | except-own-rtrlsa | except-own-rtrlsa-and-defaults]
message-digest-key key-id md5 [key | hash-key | hash2-key] [hash | hash2 | custom]
— no message-digest-key key-id
metric metric
— no metric
mtu bytes
— no mtu
[no] neighbor ipv4-address
node-sid index index-value [clear-n-flag]
node-sid label label-value [clear-n-flag]
— no node-sid
[no] passive
poll-interval seconds
priority number
— no priority
rib-priority {high}
[no] shutdown
transit-delay seconds
[no] nssa
area-range ip-prefix/mask [advertise | not-advertise]
— no area-range ip-prefix/mask
originate-default-route [type-7] [no-adjacency-check]
[no] summaries
[no] stub
default-metric metric
[no] summaries
[no] virtual-link router-id transit-area area-id
auth-keychain name
authentication-key [authentication-key | hash-key] [hash | hash2 | custom]
authentication-type {password | message-digest}
dead-interval seconds
hello-interval seconds
message-digest-key key-id md5 [key | hash-key | hash2-key] [hash | hash2 | custom]
— no message-digest-key key-id
[no] shutdown
transit-delay seconds
asbr [trace-path domain-id]
— no asbr
database-export [identifier id] [bgp-ls-identifier bgp-ls-id]
export policy-name [policy-name]
— no export
export-limit number [log percentage]
external-db-overflow limit seconds
external-preference preference
[no] shutdown
family {ipv4 | srv4}
resolution {any | disabled | filter | match-family-ip}
[no] rsvp
[no] sr-te
import policy-name [policy-name]
— no import
[no] ldp-over-rsvp
exclude
prefix-policy prefix-policy [prefix-policy]
remote-lfa [max-pq-cost value]
— no remote-lfa
node-protect [max-pq-nodes value]
— no node-protect
ti-lfa [max-sr-frr-labels value]
— no ti-lfa
[no] node-protect
overload [timeout seconds]
— no overload
overload-on-boot [timeout seconds]
preference preference
— no preference
reference-bandwidth bandwidth-in-kbps
reference-bandwidth [tbps Tera-bps] [gbps Giga-bps] [mbps Mega-bps] [kbps Kilo-bps]
rib-priority high prefix-list-name
router-id ip-address
— no router-id
rtr-adv-lsa-limit limit [log-only] [threshold percent] [overload-timeout {seconds | forever}]
adj-sid-hold seconds
[no] adjacency-set id
parallel [no-advertise]
— no parallel
sid label value
— no sid
backup-node-sid ip-prefix/prefix-length index value
backup-node-sid ip-prefix/prefix-length label value
[no] adj-set
[no] adj-sid
[no] node-sid
entropy-label {force-disable | enable}
[no] adj-set
[no] adj-sid
[no] node-sid
[no] mapping-server
[no] shutdown
sid-map node-sid index index-value [range range-value] prefix ip-address/mask [netmask]
sid-map node-sid index index-value [range range-value] prefix ip-address/mask [netmask] scope {area area-id | as}
[no] sid-map node-sid index index-value
override-bmi value
override-erld value
prefix-sid-range {global | start-label label-value max-index index-value}
[no] shutdown
srlb reserved-label-block-name
— no srlb
tunnel-mtu bytes
— no tunnel-mtu
tunnel-table-pref preference
[no] shutdown
timers
incremental-spf-wait inc-spf-wait
lsa-accumulate lsa-accum-time
lsa-arrival lsa-arrival-time
[no] lsa-generate max-lsa-wait [lsa-initial-wait lsa-initial-wait [lsa-second-wait lsa-second-wait]]
[no] redistribute-delay redist-wait
[no] spf-wait max-spf-wait [spf-initial-wait initial-wait [spf-second-wait second-wait]]
sr-te {legacy | application-specific-link-attributes}
— no sr-te
ospf3 [ospf-instance] [router-id]
— no ospf3 [ospf-instance]
advertise-router-capability {link | area | as}
[no] area area-id
area-range ipv4-prefix/mask | ipv6-prefix/prefix-length [advertise | not-advertise]
— no area-range ipv4-prefix/mask | ipv6-prefix/prefix-length
[no] bier
export policy-name [policy-name]
— no export
extended-lsa {inherit | only}
import policy-name [policy-name]
— no import
interface ip-int-name [secondary]
— no interface ip-int-name
authentication bidirectional sa-name
authentication inbound sa-name outbound sa-name
bfd-enable [remain-down-on-failure]
— no bfd-enable
dead-interval seconds
hello-interval seconds
interface-type {broadcast | point-to-point | non-broadcast}
lfa-policy-map route-nh-template template-name
load-balancing-weight [weight]
lsa-filter-out [all | except-own-rtrlsa | except-own-rtrlsa-and-defaults]
metric metric
— no metric
mtu bytes
— no mtu
[no] neighbor ipv6-address
node-sid index index-value [clear-n-flag]
node-sid label label-value [clear-n-flag]
— no node-sid
[no] passive
poll-interval seconds
priority number
— no priority
rib-priority high
[no] shutdown
transit-delay seconds
[no] nssa
area-range ipv4-prefix/mask | ipv6-prefix/prefix-length [advertise | not-advertise]
— no area-range ipv4-prefix/mask | ipv6-prefix/prefix-length
originate-default-route [type-nssa] [no-adjacency-check]
[no] summaries
[no] stub
default-metric metric
[no] summaries
[no] virtual-link router-id transit-area area-id
authentication bidirectional sa-name
authentication inbound sa-name outbound sa-name
dead-interval seconds
hello-interval seconds
[no] shutdown
transit-delay seconds
[no] asbr
database-export [identifier id] [bgp-ls-identifier bgp-ls-id]
export policy-name [policy-name]
— no export
export-limit number [log percentage]
extended-lsa {sparse | only}
external-db-overflow limit seconds
external-preference preference
[no] shutdown
family ipv6
resolution {any | disabled | filter}
[no] rsvp
[no] sr-te
import policy-name [policy-name]
— no import
exclude
prefix-policy prefix-policy [prefix-policy]
remote-lfa [max-pq-cost value]
— no remote-lfa
node-protect [max-pq-nodes value]
— no node-protect
ti-lfa [max-sr-frr-labels value]
— no ti-lfa
[no] node-protect
overload [timeout seconds]
— no overload
overload-on-boot [timeout seconds]
preference preference
— no preference
reference-bandwidth bandwidth-in-kbps
reference-bandwidth [tbps Tera-bps] [gbps Giga-bps] [mbps Mega-bps] [kbps Kilo-bps]
rib-priority {high} prefix-list-name
— no rib-priority {high}
router-id ip-address
— no router-id
rtr-adv-lsa-limit limit [log-only] [threshold percent] [overload-timeout {seconds | forever}]
[no] segment-routing
adj-sid-hold seconds
— no adj-sid-hold
[no] adj-sid
[no] node-sid
[no] adj-sid
[no] node-sid
prefix-sid-range {global | start-label label-value max-index index-value}
[no] shutdown
tunnel-mtu bytes
— no tunnel-mtu
tunnel-table-pref preference
[no] shutdown
timers
incremental-spf-wait inc-spf-wait
lsa-accumulate lsa-accumulate
lsa-arrival lsa-arrival-time
lsa-generate max-lsa-wait [lsa-initial-wait lsa-initial-wait [lsa-second-wait lsa-second-wait]]
— no] lsa-generate
redistribute-delay redistribute-delay
spf-wait max-spf-wait [spf-initial-wait initial-wait [spf-second-wait second-wait]]
[no] spf-wait

3.15.2. Command Descriptions

3.15.2.1. Generic Commands

shutdown

Syntax 
[no] shutdown
Context 
config>router>ospf
config>router>ospf
config>router>ospf>area>bier
config>router>ospf>area>virtual-link
config>router>ospf>igp-shortcut
config>router>ospf>segm-rtng
config>router>ospf>segm-rtng>mapping-server
config>router>ospf3
config>router>ospf3>area>interface
config>router>ospf3>area>virtual-link
Description 

The shutdown command administratively disables the entity. When disabled, an entity does not change, reset, or remove any configuration settings or statistics. The operational state of the entity is disabled as well as the operational state of any entities contained within.

Many objects must be shut down before they may be deleted. Many entities must be explicitly enabled using the no shutdown command.

Unlike other commands and parameters where the default state is not indicated in the configuration file, shutdown and no shutdown are always indicated in system generated configuration files.

The no form of this command puts an entity into the administratively enabled state.

Special Cases 
OSPF Interface—
When an IP interface is configured as an OSPF interface, OSPF on the interface is in the no shutdown state by default.

3.15.2.2. OSPF Global Commands

ospf

Syntax 
ospf ospf-instance [router-id]
[no] ospf ospf-instance
Context 
config>router
Description 

This command creates an OSPF routing instance and then enters the associated context to configure the associated protocol parameters.

Additionally, the router ID can be specified as another parameter of the OSPF command. This parameter is required for all non-base OSPF instances.

The default value for the base instance is inherited from the configuration in the config>router context. When that is not configured, the following apply:

  1. the system uses the system interface address (which is also the loopback address)
  2. if a system interface address is not configured, it uses the last 32 bits of the chassis MAC address

This is a required command when configuring multiple instances and the instance being configured is not the base instance. When configuring multiple instances of OSPF, there is a risk of loops because networks are advertised by multiple domains configured with multiple interconnections to one another. To prevent this from happening, all routers in a domain should be configured with the same domain ID. Each domain (OSPF-instance) should be assigned a specific bit value in the 32-bit tag mask.

The default value for non-base instances is 0.0.0.0 and is invalid; in this case, the instance of OSPF will not start. When configuring a new router ID, the instance is not automatically restarted with the new router ID. The next time the instance is initialized, the new router ID is used.

Issue the shutdown and no shutdown commands for the instance for the new router ID to be used, or reboot the entire router.

OSPF instances are shutdown when created, so that all parameters can be configured prior to the instance being enabled.

The no form of this command to reverts to the default value.

Default 

no ospf

Parameters 
ospf-instance—
Specifies a unique integer that identifies a specific instance of a version of the OSPF protocol running in the router instance specified by the router ID.
Values—
1 to 31

 

router-id—
Specifies the OSPF router ID to be used with the associated OSPF instance. This IP address must be given a dot decimal notation format.

ospf3

Syntax 
ospf3 [ospf-instance] [router-id]
[no] ospf3 instance-id
Context 
config>router
Description 

This command creates an OSPFv3 routing instance and then enters the associated context to configure associated protocol parameters.

OSPFv3 instances are shutdown when created, so that all parameters can be configured prior to the instance being enabled.

The no form of this command deletes the OSPFv3 protocol instance, removing all associated configuration parameters.

Parameters 
ospf-instance—
Specifies the instance ID for the OSPFv3 instance being created or modified. The instance ID must match the specified range based on the address family.
Values—
0 to 31: IPV6 unicast
64 to 95: IPV4 unicast

 

router-id—
Specifies the OSPF router ID to be used with the associated OSPF instance. This IP address must be given a dot decimal notation format.

advertise-router-capability

Syntax 
advertise-router-capability {link | area | as}
no advertise-router-capability
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables advertisement of a router's capabilities to its neighbors for informational and troubleshooting purposes. A Router Information (RI) LSA as defined in RFC 4970 advertises the following capabilities:

  1. OSPF graceful restart capable: no
  2. OSPF graceful restart helper: yes, when enabled
  3. OSPF stub router support: yes
  4. OSPF traffic engineering support: yes, when enabled
  5. OSPF point-to-point over LAN: yes
  6. OSPF experimental TE: no

The parameters (link, area and as) control the scope of the capability advertisements.

The no form of this command disables this capability.

Default 

no advertise-router-capability

Parameters 
link—
capabilities are only advertised over local links and not flooded beyond.
area—
capabilities are only advertised within the area of origin.
as—
capabilities are advertised throughout the entire autonomous system.

advertise-tunnel-link

Syntax 
advertise-tunnel-link
no advertise-tunnel-link
Context 
config>router>ospf
Description 

This command enables the forwarding adjacency feature. With this feature, IS-IS or OSPF advertises an RSVP LSP as a link so that other routers in the network can include it in their SPF computations. The RSVP LSP is advertised as an unnumbered point-to-point link and the link LSP/LSA has no Traffic Engineering opaque sub-TLVs per RFC 3906.

The forwarding adjacency feature can be enabled independently from the IGP shortcut feature in CLI. If both igp-shortcut and advertise-tunnel-link options are enabled for a given IGP instance, then the advertise-tunnel-link will win.

When the forwarding adjacency feature is enabled, each node advertises a p2p unnumbered link for each best metric tunnel to the router-id of any endpoint node. The node does not include the tunnels as IGP shortcuts in SPF computation directly. Instead, when the LSA/LSP advertising the corresponding P2P unnumbered link is installed in the local routing database, then the node performs an SPF using it like any other link LSA/LSP. The link bidirectional check requires that a link, regular link or tunnel link, exists in the reverse direction for the tunnel to be used in SPF.

That the igp-shortcut option under the LSP name governs the use of the LSP with both the igp-shortcut and the advertise-tunnel-link options in IGP. In other words, the user can exclude a specific RSVP LSP from being used as a forwarding adjacency by entering the command config>router>mpls>lsp>no igp-shortcut.

The resolution and forwarding of IPv6 prefixes to IPv4 forwarding adjacency LSP is not supported.

The no form of this command disables forwarding adjacency and hence disables the advertisement of RSVP LSP into IGP.

Default 

no advertise-tunnel-link

asbr

Syntax 
[no] asbr [trace-path domain-id]
no asbr
[no] asbr
Context 
config>router>ospf
config>router>ospf3
Description 

This command configures the router as an Autonomous System Boundary Router (ASBR) if the router is to be used to export routes from the Routing Table Manager (RTM) into this instance of OSPF. After a router is configured as an ASBR, the export policies into this OSPF domain take effect. If no policies are configured, no external routes are redistributed into the OSPF domain.

The no form of this command removes the ASBR status and withdraws the routes redistributed from the Routing Table Manager into this instance of OSPF from the link state database.

When configuring multiple instances of OSPF, there is a risk of loops because networks are advertised by multiple domains configured with multiple interconnections to one another. To prevent this from happening, all routers in a domain should be configured with the same domain ID. Each domain (OSPF-instance) should be assigned a specific bit value in the 32-bit tag mask.

When an external route is originated by an ASBR using an internal OSPF route in a given domain, the corresponding bit is set in the AS-external LSA. As the route gets redistributed from one domain to another, more bits are set in the tag mask, each corresponding to the OSPF domain the route visited. Route redistribution looping is prevented by checking the corresponding bit as part of the export policy; if the bit corresponding to the announcing OSPF process is already set, the route is not exported there.

 

Domain IDs are incompatible with any other use of normal tags. The domain ID should be configured with a value between 1 and 31 by each router in a given OSPF domain (OSPF Instance).

When an external route is originated by an ASBR using an internal OSPF route in a given domain, the corresponding (1-31) bit is set in the AS-external LSA.

As the route gets redistributed from one domain to another, more bits are set in the tag mask, each corresponding to the OSPF domain the route visited. Route redistribution looping is prevented by checking the corresponding bit as part of the export policy; if the bit corresponding to the announcing OSPF process is already set, the route is not exported there.

Default 

no asbr

Parameters 
domain-id—
Specifies the domain ID.
Values—
1 to 31

 

Default—
0

compatible-rfc1583

Syntax 
[no] compatible-rfc1583
Context 
config>router>ospf
Description 

This command enables OSPF summary and external route calculations in compliance with RFC1583 and earlier RFCs.

RFC1583 and earlier RFCs use a different method to calculate summary and external route costs. To avoid routing loops, all routers in an OSPF domain should perform the same calculation method.

Although it would be favorable to require all routers to run a more current compliance level, this command allows the router to use obsolete methods of calculation.

The no form of this command enables the post-RFC1583 method of summary and external route calculation.

Default 

compatible-rfc1583

database-export

Syntax 
database-export [identifier id] [bgp-ls-identifier bgp-ls-id]
no database-export
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables the population of the extended TE Database (TE-DB) with the link-state information from a given IGP instance.

The extended TE-DB is used as a central point for importing all link-state information, link, node, and prefix, from IGP instances on the router or the vSROS controller of the NSP and to exporting it to BGP-LS on the router and to Java-VM proxy on the vSROS controller. This information includes the IGP, TE, and the SR information, prefix SID sub-TLV, adjacency SID sub-TLV, and router SR capability TLV.

The no form of this command disables database exportation.

Default 

no database-export

Parameters 
identifier—
Identifies the IGP instance in the BGP-LS NLRI when a router has interfaces participating in multiple IGP instances. This parameter defaults to the IGP instance ID assigned by SR OS. However, given that the concept of instance ID defined in IS-IS (RFC 6822) is unique within a routing domain while the one specified for OSPF is local subnet significant (RFC 6549), the user can remove any overlap by configuring the new identifier value to be unique within a given IGP domain when this router sends the IGP link-state information using BGP-LS.
id—
Specifies an entry ID to export.
Values—
0 to 18446744073709551615

 

bgp-ls-identifier—
This parameter is used, along with the Autonomous System Number (ASN), to correlate the BGP-LS NLRI advertisements of multiples BGP-LS speakers of the same IGP domain. If an NRC-P network domain has multiple IGP domains, BGP-LS speakers within each IGP domain must be configured with the same unique {bgp-ls-identifier, asn} tuple.

The BGP-LS identifier is optional and is only sent in a BGP-LS NLRI if configured in the IGP instance of an IGP domain.

Note that if this IGP instance participates in traffic engineering with RSVP-TE or SR-TE, the traffic-engineering option is not strictly required because enabling the extended TE-DB populates this information automatically. It is, however, recommended to enable it to make the configuration consistent with other routers in the network that do not require the enabling of the extended TE-DB.

bgp-ls-id—
Specifies a BGP LS ID to export.
Values—
0 to 4294967295

 

disable-ldp-sync

Syntax 
[no] disable-ldp-sync
Context 
config>router>ospf
config>router>ospf3
Description 

This command disables the IGP-LDP synchronization feature on all interfaces participating in the OSPF routing protocol. When this command is executed, IGP immediately advertises the actual value of the link cost for all interfaces which have the IGP-LDP synchronization enabled if the currently advertised cost is different. It will then disable IGP-LDP synchronization for all interfaces. This command does not delete the interface configuration. The no form of this command has to be entered to re-enable IGP-LDP synchronization for this routing protocol.

The no form of this command restores the default settings and re-enables IGP-LDP synchronization on all interfaces participating in the OSPF or IS-IS routing protocol and for which the ldp-sync-timer is configured.

Default 

no disable-ldp-sync

entropy-label

Syntax 
entropy-label
Context 
config>router>isis
config>router>ospf
Description 

This command enables the context for the configuration of entropy label capabilities for the routing protocol.

override-tunnel-elc

Syntax 
[no] override-tunnel-elc
Context 
config>router>isis>entropy-label
config>router>ospf>entropy-label
Description 

This command configures the ability to override any received entropy label capability advertisement. When enabled, the system assumes that all nodes for an IGP domain are capable of receiving and processing the entropy label on segment routed tunnels. This command can only be configured if entropy-label is enabled via the config>router>isis>segment-routing>entropy-label or config>router>ospf>segment-routing>entropy-label command.

The no form of this command disables the override. The system assumes entropy label capability for other nodes in the IGP instance if capability advertisements are received.

Default 

no override-tunnel-elc

export

Syntax 
export policy-name [policy-name]
no export
Context 
config>router>ospf
config>router>ospf3
Description 

This command associates export route policies to determine which routes are exported from the route table to OSPF. Export polices are only in effect if OSPF is configured as an ASBR.

If no export policy is specified, non-OSPF routes are not exported from the routing table manager to OSPF.

If multiple policy names are specified, the policies are evaluated in the order they are specified. The first policy that matches is applied. If multiple export commands are issued, the last command entered will override the previous command. A maximum of five policy names can be specified.

The no form of this command removes all policies from the configuration.

Default 

no export

Parameters 
policy-name—
Specifies up to 5 export route policy names. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. The specified names must already be defined.

export-limit

Syntax 
export-limit number [log percentage]
no export-limit
Context 
config>router>ospf
config>router>ospf3
Description 

This command configures the maximum number of routes (prefixes) that can be exported into OSPF from the route table. After the maximum is reached, a warning log message is sent and additional routes are ignored.

The no form of this command removes the parameters from the configuration.

Default 

no export-limit

Parameters 
number—
Specifies the maximum number of routes (prefixes) that can be exported into OSPF from the route table.
Values—
1 to 4294967295

 

percentage
Specifies the percentage of the export-limit, at which a warning log message and SNMP notification would be sent.
Values—
1 to 100

 

extended-lsa

Syntax 
extended-lsa {sparse | only}
no extended-lsa
Context 
config>router>ospf3
Description 

This command configures the use of extended LSA format in OSPFv3 as per draft-ietf-ospf-ospfv3-lsa-extend.

Prior to this feature, SR OS used the fixed format LSA to carry the prefix and link information as per RFC 5340, OSPF for IPv6. The fixed format is not extensible and the TLV format of the extended LSA must be used.

With this feature, the default mode of operation for OSPFv3 is referred to as sparse mode, meaning that the router will always advertise the fixed format for existing LSAs and will add the TLV-based extended LSA only when it needs to advertise new sub-TLVs. This mode of operation is similar to the way OSPFv2 advertises the segment routing information. It sends the prefix in the original fixed-format prefix LSA and then follows with the extended prefix TLV which is sent in an extended prefix opaque LSA containing the prefix SID sub-TLV.

The extended-lsa only value enables the full extended LSA mode. This causes all existing and new LSAs to use the extended LSA format.

The OSPFv3 instance must first be shut down before the user can change the mode of operation since the protocol must flush all LSAs and re-establish all adjacencies.

The no form at the OSPFv3 instance level reverts the OSPFv3 instance into the default sparse mode of operation.

Default 

extended-lsa sparse

Parameters 
sparse—
Enables the sparse mode of operation in an OSPFv3 instance.
only—
Enables the full extended LSA mode of operation in an OSPFv3 instance.

external-db-overflow

Syntax 
external-db-overflow limit interval
no external-db-overflow
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables limits on the number of non-default AS-external-LSA entries that can be stored in the LSDB and specifies a wait timer before processing these after the limit is exceeded.

The limit value specifies the maximum number of non-default AS-external-LSA entries that can be stored in the link-state database (LSDB). Placing a limit on the non-default AS-external-LSAs in the LSDB protects the router from receiving an excessive number of external routes that consume excessive memory or CPU resources. If the number of routes reach or exceed the limit, the table is in an overflow state. When in an overflow state, the router will not originate any new AS-external-LSAs. In fact, it withdraws all the self-originated non-default external LSAs.

The interval specifies the amount of time to wait after an overflow state before regenerating and processing non-default AS-external-LSAs. The waiting period acts like a dampening period preventing the router from continuously running Shortest Path First (SPF) calculations caused by the excessive number of non-default AS-external LSAs.

The external-db-overflow must be set identically on all routers attached to any regular OSPF area. OSPF stub areas and not-so-stubby areas (NSSAs) are excluded.

The no form of this command disables limiting the number of non-default AS-external-LSA entries.

Default 

no external-db-overflow

Parameters 
limit—
Specifies the maximum number of non-default AS-external-LSA entries that can be stored in the LSDB before going into an overflow state expressed as a decimal integer.
Values—
-1 to 2147483647

 

Note:

Setting a value of -1 is equivalent to no external-db-overflow.

interval—
The number of seconds after entering an overflow state before attempting to process non-default AS-external-LSAs expressed as a decimal integer.
Values—
0 to 2147483647

 

external-preference

Syntax 
external-preference preference
no external-preference
Context 
config>router>ospf
config>router>ospf3
Description 

This command configures the preference for OSPF external routes.

A route can be learned by the router from different protocols, in which case, the costs are not comparable. When this occurs, the preference is used to decide which route will be used.

Different protocols should not be configured with the same preference, if this occurs the tiebreaker is per the default preference table as defined in the Table 18. If multiple routes are learned with an identical preference using the same protocol, the lowest cost route is used.

If multiple routes are learned with an identical preference using the same protocol and the costs (metrics) are equal, then the decision of what route to use is determined by the configuration of the ecmp in the config>router context.

The no form of this command reverts to the default value.

Default 

external-preference 150

Parameters 
preference—
Specifies the preference for external routes expressed as a decimal integer. Defaults for different route types are listed in Table 18.
Table 18:  Route Preference Defaults by Route Type  

Route Type

Preference

Configurable

Direct attached

0

No

Static routes

5

Yes

OSPF internal

10

Yes 1

IS-IS level 1 internal

15

Yes

IS-IS level 2 internal

18

Yes

RIP

100

Yes

OSPF external

150

Yes

IS-IS level 1 external

160

Yes

IS-IS level 2 external

165

Yes

BGP

170

Yes

    Note:

  1. Preference for OSPF internal routes is configured with the preference command.
Values—
1 to 255

 

graceful-restart

Syntax 
[no] graceful-restart
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables OSPF graceful restart (GR) to minimize service disruption. When the control plane of a GR-capable router fails or restarts, the neighboring routers (GR helpers) temporarily preserve OSPF forwarding information. Traffic continues to be forwarded to the restarting router using the last known forwarding tables. If the control plane of the restarting router comes back up within the grace period, the restarting router resumes normal OSPF operation. If the grace period expires, then the restarting router is presumed inactive and the OSPF topology is recalculated to route traffic around the failure.

The no form of this command disables graceful restart and removes the graceful restart configuration from the OSPF instance.

Default 

no graceful-restart

helper-disable

Syntax 
[no] helper-disable
Context 
config>router>ospf>graceful-restart
config>router>ospf3>graceful-restart
Description 

This command disables helper support for OSPF graceful restart (GR).

When graceful-restart is enabled, the router can be a helper (meaning that the router is helping a neighbor to restart), a restarting router, or both. The router only supports helper mode. It will not act as a restarting router because the high availability feature set already preserves OSPF forwarding information so that this functionality is not needed. This command is a historical command and should not be disabled. Configuring helper-disable has the effect of disabling graceful restart because the router only supports helper mode.

The no form of this command enables helper support and is the default when graceful-restart is enabled.

Default 

no helper-disable

strict-lsa-checking

Syntax 
[no] strict-lsa-checking
Context 
config>router>ospf>graceful-restart
config>router>ospf3>graceful-restart
Description 

This command indicates whether an OSPF restart helper should terminate graceful restart when there is a change to an LSA that would be flooded to the restarting router during the restart process.

The default OSPF behavior is to terminate a graceful restart if an LSA changes, which causes the OSPF neighbor to go down.

The no form of this command disables strict LSA checking.

Default 

strict-lsa-checking

igp-shortcut

Syntax 
igp-shortcut
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables the use of an RSVP-TE or SR-TE shortcut for resolving IGP routes by OSPF or IS-IS routing protocols.

This command instructs IGP to include RSVP LSPs and SR-TE LSPs originating on this node and terminating on the router ID of a remote node as direct links with a metric equal to the metric provided by MPLS.

During the IP reach calculation to determine the reachability of nodes and prefixes, LSPs are overlaid and the LSP metric is used to determine the subset of paths that are equal lowest cost to reach a node or a prefix. If the user enabled the relative-metric option for this LSP, IGP will apply the shortest IGP cost between the endpoints of the LSP plus the value of the offset, instead of the LSP operational metric, when computing the cost of a prefix that is resolved to the LSP.

When a prefix is resolved to a tunnel next hop, the packet is sent labeled with the label stack corresponding to the NHLFE of the RSVP-TE or SR-TE LSP, as well as the explicit-null IPv6 label at the bottom of the stack in the case of an IPv6 prefix. Any network event causing one or more IGP shortcuts to go down will trigger a full SPF computation, which may result in installing a new route over an updated set of tunnel next-hops and IP next-hops.

When igp-shortcut is enabled at the IGP instance level, all RSVP-TE and SR-TE LSPs originating on this node are eligible by default as long as the destination address of the LSP, as configured in config>router>mpls>lsp>to, corresponds to a router ID of a remote node. LSPs with a destination corresponding to an interface address or any other loopback interface address of a remote node are automatically not considered by IGP. The user can, however, exclude a specific RSVP-TE or SR-TE LSP from being used as a shortcut for resolving IGP routes by entering the config>router>mpls>lsp>no igp-shortcut command.

The SPF in IGP only uses RSVP LSPs as forwarding adjacencies, IGP shortcuts, or as endpoints for LDP-over-RSVP. These applications of RSVP LSPs are mutually exclusive at the IGP instance level. If two or more options are enabled in the same IGP instance, then forwarding adjacency takes precedence over the shortcut application, which takes precedence over the LDP-over-RSVP application.

The SPF in IGP uses SR-TE LSPs as IGP shortcuts only.

When ECMP is enabled on the system and multiple equal-cost paths exist for a prefix, the following selection criteria are used to pick up the set of tunnel and IP next-hops to program in the data path.

  1. Where a destination is a tunnel-endpoint (including external prefixes with tunnel-endpoint as the next hop), the tunnel with lowest tunnel-index is selected (the IP next hop is never used in this case).
  2. Where a destination is not a tunnel-endpoint:
    1. LSPs with metric higher than underlying IGP cost between the endpoint of the LSP are excluded
    2. Tunnel next-hops are preferred over IP next-hops
    3. Within tunnel next-hops:
      1. The lowest endpoint-to-destination cost is selected
      2. If the endpoint-to-destination costs are the same, the lowest endpoint node router ID is selected
      3. If the router IDs are the same, the lowest tunnel index is selected
    4. Within IP next-hops:
      1. The lowest downstream router ID is selected
      2. If the downstream router IDs are the same, the lowest interface-index is selected
Note:

Although ECMP is not performed across both the IP and tunnel next-hops, the tunnel endpoint may lie in one of the shortest IGP paths for that prefix. In that case, the tunnel next hop is always selected as long as the prefix cost using the tunnel is equal or lower than the IGP cost.

When both RSVP-TE and SR-TE IGP shortcuts are available, the IP reach calculation, in the unicast routing table, will first follow the above ECMP tunnel and IP next hop selection rules when resolving a prefix over IGP shortcuts. After the set of ECMP tunnel and IP next-hops have been selected, the preference of tunnel type is then applied based on the user setting of the resolution of the family of the prefix. If the user enabled resolution of the prefix family to both RSVP-TE and SR-TE tunnel types, the TTM tunnel preference value is used to select one type for the prefix. In other words, the RSVP-TE LSP type is preferred to an SR-TE LSP type on a per-prefix basis.

The ingress IOM sprays the packets for this prefix over the set of tunnel next-hops and IP next-hops based on the hashing routine currently supported for IPv4 packets.

This feature provides IGP with the capability to populate the multicast RTM with the prefix IP next hop when both the igp-shortcut and the multicast-import options are enabled in IGP. The unicast RTM can still make use of the tunnel next hop for the same prefix. This change is made possible with the enhancement by which SPF keeps track of both the direct first hop and the tunneled first hop of a node which is added to the Dijkstra tree.

tunnel-next-hop

Syntax 
tunnel-next-hop
Context 
config>router>ospf>igp-shortcut
config>router>ospf3>igp-shortcut
Description 

This command enables the context to configure the resolution of IGP IPv4 prefix families, IGP IPv6 prefix families, SR-ISIS IPv4 tunnel families, SR-ISIS IPv6 tunnel families, and SR-OSPF IPv4 tunnel families using IGP shortcuts.

The resolution node is introduced to provide flexibility in the selection of the tunnel types for each of the IP prefix and SR tunnel families.

The IPv4 family option causes the IS-IS or OSPF SPF to include the IPv4 IGP shortcuts in the IP reach calculation of IPv4 nodes and prefixes. RSVP-TE or SR-TE LSPs terminating on a node identified by its router ID can be used to reach IPv4 prefixes owned by this node or for which this node is the IPv4 next hop.

The IPv6 family option causes the IS-IS or OSPFv3 SPF to include the IPv4 IGP shortcuts in the IP reach calculation of IPv6 nodes and prefixes. RSVP-TE or SR-TE LSPs terminating on a node identified by its router ID can be used to reach IPv6 prefixes owned by this node or for which this node is the IPv6 next hop. The resolution of IPv6 prefixes is supported in OSPFv3 and in both IS-IS MT=0 and MT=2.

The IS-IS and OSPFv3 IPv6 routes resolved to IPv4 IGP shortcuts are used to:

  1. forward packets of IS-IS or OSPFv3 prefixes matching these routes
  2. forward CPM-originated IPv6 packets
  3. resolve the BGP next hop of BGP IPv6 prefixes
  4. resolve the indirect next hop of static IPv6 routes

In the data path, a packet for an IPv6 prefix has a label stack that consists of the IPv6 Explicit-Null label value of 2 at the bottom of the label stack followed by the label stack of the IPv4 RSVP-TE LSP.

There is no default behavior for IPv4 prefixes to automatically resolve to RSVP-TE or SR-TE LSPs used as IGP shortcuts by only enabling the igp-shortcut context. Instead, the user must enable the ipv4 family or ipv6 family and set the resolution to the value of rsvp-te to select the RSVP-TE tunnel type, or to the value of sr-te to select the SR-TE tunnel type.

Setting the resolution to the any value means that IGP selects the tunnels used as IGP shortcuts according to the TTM preference for the tunnel type. The RSVP-TE LSP type is of higher priority than the SR-TE LSP type.

An IP prefix of family=ipv4 or family= ipv6 always resolves to a single type of tunnel rsvp-te or sr-te. Rsvp-te type is preferred if both types are allowed by the prefix family resolution and both types exist in the set of tunnel next-hops of the prefix. The feature does not support mixing tunnel types per prefix.

If resolution for the IPv4 or IPv6 family is set to disabled, the corresponding prefixes are resolved to IP next-hops in the multicast routing table.

The srv4 family enables the resolution of SR-OSPF IPv4 tunnels and SR-ISIS IPv4 tunnels in MT=0 over RSVP-TE IPv4 IGP shortcuts. A maximum of 32 ECMP tunnel next-hops can be programmed for an SR-OSPF or an SR-ISIS IPv4 tunnel.

The srv6 family enables the resolution of SR-ISIS IPv6 tunnels in MT=0 over RSVP-TE IPv4 IGP shortcuts. A maximum of 32 ECMP tunnel next-hops can be programmed for an SR-ISIS IPv6 tunnel.

One or more RSVP-TE LSPs can be selected if resolution=match-family-ip and the corresponding IPv4 or IPv6 prefix resolves to RSVP-TE LSPs.

Note:

An SR tunnel cannot resolve to SR-TE IGP shortcuts.

If resolution for the SRv4 or SRv6 tunnel family is set to disabled, the corresponding tunnels are resolved to IP next-hops in the multicast routing table.

To enable or disable IGP shortcuts in the IGP instance, the user must perform a shutdown or no shutdown in the igp-shortcut context.

family

Syntax 
family {ipv4 | srv4}
Context 
config>router>ospf>igp-shortcut>tunnel-next-hop
Description 

This command enables the context to configure the resolution of the IGP IPv4 prefix family or SR-OSPF IPv4 tunnel using IGP shortcuts.

Parameters 
ipv4
Selects the IPv4 address family.
srv4
Selects the SR-OSPF IPv4 tunnel family.

family

Syntax 
family ipv6
Context 
config>router>ospf3>igp-shortcut>tunnel-next-hop
Description 

This command enables the context to configure the resolution of the IGP IPv6 prefix family using IGP shortcuts.

Parameters 
ipv6
Selects the IPv6 address family.

resolution

Syntax 
resolution {any | disabled | filter | match-family-ip}
Context 
config>router>ospf>igp-shortcut>tunnel-next-hop>family
Description 

This command configures resolution mode in the resolution of the IP prefix or SR tunnel family using IGP shortcuts.

Parameters 
any
Enables the binding to any supported tunnel type following TTM preference.
disabled
Disables the resolution of the IP prefix or SR tunnel family using IGP shortcuts.
filter
Enables the binding to the subset of tunnel types configured under resolution-filter.
match-family-ip
Enables the resolution of the SR tunnel family to match that of the corresponding IP prefix family.

resolution

Syntax 
resolution {any | disabled | filter}
Context 
config>router>ospf3>igp-shortcut>tunnel-next-hop>family
Description 

This command configures resolution mode in the resolution of the IPv6 prefix using IGP shortcuts.

Parameters 
any
Enables the binding to any supported tunnel type following TTM preference.
disabled
Disables the resolution of the IPv6 prefix using IGP shortcuts.
filter
Enables the binding to the subset of tunnel types configured under resolution-filter.

resolution-filter

Syntax 
resolution-filter
Context 
config>router>ospf>igp-shortcut>tunnel-next-hop>family
config>router>ospf3>igp-shortcut>tunnel-next-hop>family
Description 

This command enables the context to configure the subset of tunnel types that can be used in the resolution of the IP prefix or SR tunnel family using IGP shortcuts.

rsvp

Syntax 
[no] rsvp
Context 
config>router>ospf>igp-shortcut>tunnel-next-hop>family
config>router>ospf3>igp-shortcut>tunnel-next-hop>family
Description 

This command selects the RSVP-TE tunnel type in the resolution of the IP prefix or SR tunnel family using IGP shortcuts.

sr-te

Syntax 
[no] sr-te
Context 
config>router>ospf>igp-shortcut>tunnel-next-hop>family
config>router>ospf3>igp-shortcut>tunnel-next-hop>family
Description 

This command selects the SR-TE tunnel type in the resolution of the IP prefix or SR tunnel family using IGP shortcuts.

import

Syntax 
import policy-name [policy-name]
no import
Context 
config>router>ospf
config>router>ospf3
Description 

This command applies one or more (up to 5) route polices as OSPF import policies. When a prefix received in an OSPF LSA is accepted by an entry in an OSPF import policy, it is installed in the routing table if it is the most preferred route to the destination. When a prefix received in an OSPF LSA is rejected by an entry in an OSPF import policy, it is not installed in the routing table, even if it has the lowest preference value among all the routes to that destination. The flooding of LSAs is unaffected by OSPF import policy actions. The no form of this command removes all policies from the configuration.

Default 

no import

Parameters 
policy-name—
Specifies up to 5 export route policy names. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. The specified names must already be defined.

ldp-over-rsvp

Syntax 
[no] ldp-over-rsvp
Context 
config>router>ospf
Description 

This command allows LDP-over-RSVP processing in this OSPF instance.

Default 

no ldp-over-rsvp

loopfree-alternates

Syntax 
[no] loopfree-alternates
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables Loop-Free Alternate (LFA) computation by SPF under the OSPF or OSPFv3 routing protocol instance.

When this command is enabled, it instructs the IGP SPF to attempt to precalculate both a primary next hop and an LFA next hop for every learned prefix. When found, the LFA next hop is populated into the routing table along with the primary next hop for the prefix.

The user enables the remote LFA next hop calculation by the IGP LFA SPF by appending the remote-lfa option. When this option is enabled in an IGP instance, SPF performs the remote LFA additional computation following the regular LFA next hop calculation when the latter resulted in no protection for one or more prefixes which are resolved to a particular interface.

Remote LFA extends the protection coverage of LFA-FRR to any topology by automatically computing and establishing or tearing down shortcut tunnels, also referred to as repair tunnels, to a remote LFA node that puts the packets back into the shortest path without looping them back to the node that forwarded them over the repair tunnel. The remote LFA node is referred to as a PQ node. A repair tunnel can, in theory, be an RSVP-TE LSP, an LDP-in-LDP tunnel, or a segment routing (SR) tunnel. In this command, remote-lfa is restricted to using an SR repair tunnel to the remote LFA node.

The remote LFA algorithm is a per-link LFA SPF calculation and not a per-prefix calculation like the regular LFA algorithm. The remote LFA algorithm provides protection for all destination prefixes that share the protected link by using the neighbor on the other side of the protected link as a proxy for all the destinations.

The Topology-Independent LFA (TI-LFA) further improves the protection coverage of a network topology by computing and automatically instantiating a repair tunnel to a Q node which is not in shortest path from the computing node. The repair tunnel uses shortest path to the P node and a source routed path from the P node to the Q node.

In addition, the TI-LFA algorithm selects the backup path which matches the post-convergence path. This helps the capacity planning in the network since traffic will always flow on the same path when transitioning to the FRR next hop and then onto the new primary next hop.

At a high level, the TI-LFA protection algorithm is searching for a candidate P-Q set separated with a number of hops such that the label stack size does not exceed the value of ti-lfa max-sr-frr-labels, on each of the post-convergence paths to each destination node or prefix D.

When the ti-lfa option is enabled in OSPF, it provides TI-LFA node-protect or link-protect backup path for a SR-OSPF IPV4 tunnel (node SID and adjacency SID), and for a IPv4 SR-TE LSP.

The max-sr-frr-labels parameter is used to limit the search for the TI-LFA backup next hop:

  1. 0 — The IGP LFA SPF restricts the search to TI-LFA backup next hop which does not require a repair tunnel, meaning that P node and Q node are the same and match a neighbor. This is also the case when both P and Q node match the advertising router for a prefix.
  2. 1 to 3 — The IGP LFA SPF will widen the search to include a repair tunnel to a P node which itself is connected to the Q nodes with a 0-to-2 hops for a total of maximum of three labels: one node SID to P node and two adjacency SIDs from P node to the Q node. If the P node is a neighbor of the computing node, its node SID is compressed and meaning that up to three adjacency SIDs can separate the P and Q nodes.
  3. 2 (default) — Corresponds to a repair tunnel to a non-adjacent P which is adjacent to the Q node. If the P node is a neighbor of the computing node, then the node SID of the P node is compressed and the default value of two labels corresponds to two adjacency SIDs between the P and Q nodes.

The TI-LFA repair tunnel can have a maximum of three labels pushed in addition to the label of the destination node or prefix. The user can set a lower maximum value for the additional FRR labels by configuring the CLI option max-sr-frr-labels labels. The default value is 2.

When the node-protect command is enabled, the router will prefer a node-protect over a link-protect repair tunnel for a given prefix if both are found in the Remote LFA or TI-LFA SPF computations. The SPF computations may only find a link-protect repair tunnel for prefixes owned by the protected node. This node-protect backup protects against the failure of a downstream node in the path of the prefix of a node SID except for the node owner of the node SID.

The parameter max-pq-nodes in Remote LFA controls the maximum number of PQ nodes found in the LFA SPFs for which the node protection check is performed. The node-protect condition means the router must run the original Remote LFA algorithm plus one extra forward SPF on behalf of each PQ node found, potentially after applying the max-pq-cost parameter, to check if the path from the PQ node to the destination does not traverse the protected node. Setting this parameter to a lower value means the LFA SPFs will use less computation time and resources but may result in not finding a node-protect repair tunnel.

The no form of this command disables the LFA computation by the IGP SPF.

Default 

no loopfree-alternates

exclude

Syntax 
exclude
Context 
config>router>ospf>loopfree-alternates
config>router>ospf3>loopfree-alternates
Description 

This command provides the context for configuring a prefix policy for excluding specific prefixes in the LFA calculation by ISIS or OSPF.

prefix-policy

Syntax 
prefix-policy prefix-policy [prefix-policy]
no prefix-policy
Context 
config>router>ospf>loopfree-alternates>exclude
config>router>ospf3>loopfree-alternates>exclude
Description 

This command excludes from LFA SPF calculation prefixes that match a prefix entry or a tag entry in a prefix policy.

The implementation already allows the user to exclude an interface in IS-IS or OSPF, an OSPF area, or an IS-IS level from the LFA SPF.

If a prefix is excluded from LFA, then it will not be included in LFA calculation regardless of its priority. The prefix tag will, however, be used in the main SPF.

This command specifies the name of the policy for the prefixes to exclude from the LFA SPF calculation in this OSPF or OSPF3 instance.

Note:

Prefix tags are defined for the IS-IS protocol but not for the OSPF protocol.

The default action, when not explicitly specified by the user in the prefix policy, is a “reject”. Thus, regardless if the user did or did not explicitly add the statement “default-action reject” to the prefix policy, a prefix that did not match any entry in the policy will be accepted into LFA SPF.

The no form of this command deletes the exclude prefix policy.

Default 

no prefix-policy

Parameters 
prefix-policy—
Specifies the name of the prefix policy, up to 32 characters. Up to five prefix policies can be specified. The specified name must have been already defined.

remote-lfa

Syntax 
remote-lfa [max-pq-cost value]
no remote-lfa
Context 
config>router>ospf>loopfree-alternates
config>router>ospf3>loopfree-alternates
Description 

This command enables the use of the Remote LFA algorithm in the LFA SPF calculation in this OSPF or OSPF3 instance.

The no form of this command disables the use of the Remote LFA algorithm in the LFA SPF calculation in this OSPF or OSPF3 instance.

Default 

no remote-lfa

Parameters 
max-pq-cost value
Specifies the integer used to limit the search of candidate P and Q nodes in the remote LFA by setting the maximum IGP cost from the router performing the remote LFA calculation to the candidate P or Q node.
Values—
0 to 4294967295

 

Default—
4261412864

node-protect

Syntax 
node-protect [max-pq-nodes value]
no node-protect
Context 
config>router>ospf>loopfree-alternates>remote-lfa
config>router>ospf3>loopfree-alternates>remote-lfa
Description 

This command enables node-protect in which the router prefers a node-protect over a link-protect repair tunnel for a given prefix if both are found in the Remote LFA or TI-LFA SPF computations. The SPF computations may only find a link-protect repair tunnel for prefixes owned by the protected node.

The no form of this command disables node-protect.

Default 

no node-protect

Parameters 
max-pq-nodes value
Specifies the maximum number of PQ nodes found in the LFA SPFs for which the node protection check is performed. The node-protect condition means the router must run the original Remote LFA algorithm plus one extra forward SPF on behalf of each PQ node found, potentially after applying the max-pq-cost parameter, to check if the path from the PQ node to the destination does not traverse the protected node. Setting this parameter to a lower value means the LFA SPFs will use less computation time and resources but may result in not finding a node-protect repair tunnel.
Values—
1 to 32

 

Default—
16

ti-lfa

Syntax 
ti-lfa [max-sr-frr-labels value]
no ti-lfa
Context 
config>router>ospf>loopfree-alternates
config>router>ospf3>loopfree-alternates
Description 

This command enables the use of the Topology-Independent LFA algorithm in the LFA SPF calculation in this OSPF or OSPF3 instance.

The no form of this command disables the use of the Topology-Independent LFA algorithm in the LFA SPF calculation in this OSPF or OSPF3 instance.

Default 

no ti-lfa

Parameters 
max-sr-frr-labels [value]
Specifies the maximum number of labels that the TI-LFA backup next hop can use. The TI-LFA algorithm uses this value to limit the search for the Q node from the P node on the post-convergence path.
Values—
0 to 3

 

Default—
2

node-protect

Syntax 
[no] node-protect
Context 
config>router>ospf>loopfree-alternates>ti-lfa
config>router>ospf3>loopfree-alternates>ti-lfa
Description 

This command enables node-protect in which the router prefers a node-protect over a link-protect repair tunnel for a given prefix if both are found in the Remote LFA or TI-LFA SPF computations. The SPF computations may only find a link-protect repair tunnel for prefixes owned by the protected node.

The no form of this command disables node-protect.

Default 

no node-protect

multicast-import

Syntax 
[no] multicast-import
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables the submission of routes into the multicast Route Table Manager (RTM) by OSPF.

The no form of this command disables the submission of routes into the multicast RTM.

Default 

no multicast-import

overload

Syntax 
overload [timeout seconds]
no overload
Context 
config>router>ospf
config>router>ospf3
Description 

This command changes the overload state of the local router so that it appears to be overloaded. When overload is enabled, the router can participate in OSPF routing, but is not used for transit traffic. Traffic destined to directly attached interfaces continues to reach the router.

To put the IGP in an overload state enter a timeout value. The IGP will enter the overload state until the timeout timer expires or a no overload command is executed.

If the overload command is encountered during the execution of an overload-on-boot command then this command takes precedence. This could occur as a result of a saved configuration file where both parameters are saved. When the file is saved by the system the overload-on-boot command is saved after the overload command. However, when overload-on-boot is configured under OSPF with no timeout value configured, the router will remain in overload state indefinitely after a reboot.

The no form of this command reverts to the default. When the no overload command is executed, the overload state is terminated regardless of the reason the protocol entered overload state.

Default 

no overload

Parameters 
timeout seconds—
Specifies the number of seconds to reset overloading.
Values—
1 to 1800 in the config>router>ospf context
60 to 1800 in the config>router>ospf3 context

 

overload-include-ext-1

Syntax 
[no] overload-include-ext-1
Context 
config>router>ospf
config>router>ospf3
Description 

This command controls whether external type-1 routes should be re-advertised with a maximum metric value when the system goes into overload state for any reason. When this command is enabled and the router is in overload, all external type-1 routes are advertised with the maximum metric.

The no form of this command reverts to the default value.

Default 

no overload-include-ext-1

overload-include-ext-2

Syntax 
[no] overload-include-ext-2
Context 
config>router>ospf
config>router>ospf3
Description 

This command controls whether external type-2 routes should be re-advertised with a maximum metric value when the system goes into overload state for any reason. When this command is enabled and the router is in overload, all external type-2 routes are advertised with the maximum metric.

The no form of this command reverts to the default value.

Default 

no overload-include-ext-2

overload-include-stub

Syntax 
[no] overload-include-stub
Context 
config>router>ospf
config>router>ospf3
Description 

This command controls whether the OSPF stub networks should be advertised with a maximum metric value when the system goes into overload state for any reason. When enabled, the system uses the maximum metric value. When this command is enabled and the router is in overload, all stub interfaces, including loopback and system interfaces, are advertised at the maximum metric.

The no form of this command reverts to the default value.

Default 

no overload-include-stub

overload-on-boot

Syntax 
overload-on-boot [timeout seconds]
no overload
Context 
config>router>ospf
config>router>ospf3
Description 

When the router is in an overload state, the router is used only if there is no other router to reach the destination. This command configures the IGP upon bootup in the overload state until one of the following events occur:

  1. the timeout timer expires
  2. a manual override of the current overload state is entered with the no overload command

The no overload command does not affect the overload-on-boot function.

The no form of this command removes the overload-on-boot functionality from the configuration.

The default timeout value is 60 seconds, which means after 60 seconds overload status the SR will recover (change back to non-overload status). However, when overload-on-boot is configured under OSPF with no timeout value the router will remain in overload state indefinitely after a reboot.

Default 

no overload-on-boot

Parameters 
timeout seconds—
Specifies the number of seconds to reset overloading.
Values—
1 to 1800 in the config>router>ospf context
60 to 1800 in the config>router>ospf3 context

 

preference

Syntax 
preference preference
no preference
Context 
config>router>ospf
config>router>ospf3
Description 

This command configures the preference for OSPF internal routes.

A route can be learned by the router from different protocols, in which case, the costs are not comparable. When this occurs, the preference is used to decide which route will be used.

Different protocols should not be configured with the same preference, if this occurs the tiebreaker is per the default preference table as defined in Table 19. If multiple routes are learned with an identical preference using the same protocol, the lowest cost route is used.

If multiple routes are learned with an identical preference using the same protocol and the costs (metrics) are equal, then the decision of what route to use is determined by the configuration of the ecmp in the config>router context.

The no form of this command reverts to the default value.

Default 

preference 10

Parameters 
preference—
Specifies the preference for internal routes expressed as a decimal integer. Defaults for different route types are listed in Table 19.
Table 19:  Route Preference Defaults by Route Type  

Route Type

Preference

Configurable

Direct attached

0

No

Static routes

5

Yes

OSPF internal

10

Yes 1

IS-IS level 1 internal

15

Yes

IS-IS level 2 internal

18

Yes

RIP

100

Yes

OSPF external

150

Yes

IS-IS level 1 external

160

Yes

IS-IS level 2 external

165

Yes

BGP

170

Yes

    Note:

  1. Preference for OSPF internal routes is configured with the preference command.
Values—
1 to 255

 

reference-bandwidth

Syntax 
reference-bandwidth bandwidth-in-kbps
reference-bandwidth [zbps Zetta-bps] [ebps Exa-bps] [pbps Peta-bps] [tbps Tera-bps] [gbps Giga-bps] [mbps Mega-bps] [kbps Kilo-bps]
no reference-bandwidth
Context 
config>router>ospf
config>router>ospf3
Description 

This command configures the reference bandwidth in kilobits per second (kb/s) that provides the reference for the default costing of interfaces based on their underlying link speed.

The default interface cost is calculated as follows:

cost = reference-bandwidth ÷ bandwidth

The default reference-bandwidth is 100,000,000 kb/s or 100 Gb/s, the default auto-cost metrics for various link speeds are as follows:

  1. 10 Mb/s link default cost of 10000
  2. 100 Mb/s link default cost of 1000
  3. 1 Gb/s link default cost of 100
  4. 10 Gb/s link default cost of 10
  5. 100 Gb/s link default cost of 1
  6. 400 Gb/s link default cost of 1
Note:

The default reference-bandwidth must be manually configured to a higher value if interface speeds are greater than 100 Gb/s, and metrics based on link speed are used. When the default reference-bandwidth is used, a metric of 1 is set on all interface speeds ≥ 100 Gb/s. For example, 100 GE, 100 GE LAG, 400 GE, and 400 GE LAG interfaces will all have a metric of 1.

If the reference bandwidth is configured as 10 Gb (reference-bandwidth 10000000000), a 100 Mb/s interface has a default metric of 100.

When a very large reference bandwidth value is configured, a metric calculation may result in a value higher than the supported protocol cost value. If this occurs, OSPF automatically reverts to the maximum configurable cost metric.

The reference-bandwidth command assigns a default cost to the interface based on the interface speed. To override this default cost on a particular interface, use the metric metric command configured in the config>router>ospf>area>interface ip-int-name context.

The no form of this command reverts to the default value.

Default 

reference-bandwidth 100000000

Parameters 
bandwidth-in-kbps—
Specifies the reference bandwidth in kilobits per second, expressed as a decimal integer.
Values—
1 to 18446744073709551615

 

Zetta-bps—
Specifies the reference bandwidth in zettabits per second, expressed as a decimal integer.
Values—
1 to 18

 

Exa-bps—
Specifies the reference bandwidth in exabits per second, expressed as a decimal integer.
Values—
1 to 999

 

Peta-bps—
Specifies the reference bandwidth in petabits per second, expressed as a decimal integer.
Values—
1 to 999

 

Tera-bps—
Specifies the reference bandwidth in terabits per second, expressed as a decimal integer.
Values—
1 to 999

 

Giga-bps—
Specifies the reference bandwidth in gigabits per second, expressed as a decimal integer.
Values—
1 to 999

 

Mega-bps—
Specifies the reference bandwidth in megabits per second, expressed as a decimal integer.
Values—
1 to 999

 

Kilo-bps—
Specifies the reference bandwidth in kilobits per second, expressed as a decimal integer.
Values—
1 to 999

 

rib-priority

Syntax 
rib-priority {high} prefix-list-name
no rib-priority {high}
Context 
config>router>ospf
config>router>ospf3
Description 

This command enabled RIB prioritization for the OSPF protocol and specifies the prefix list that will be used to select the specific routes that should be processed through the OSPF route calculation process at a higher priority.

The no form of this command disables RIB prioritization at the associated level.

Default 

no rib-priority high

Parameters 
prefix-list-name—
Specifies the prefix list, up to 32 characters, which is used to select the routes that are processed at a higher priority through the route calculation process.

router-id

Syntax 
router-id ip-address
no router-id
Context 
config>router>ospf
config>router>ospf3
Description 

This command configures the router ID for the OSPF instance. This command configures the router ID for the OSPF instance.

When configuring the router ID in the base instance of OSPF it overrides the router ID configured in the config>router context.

The default value for the base instance is inherited from the configuration in the config>router context. If the router ID in the config>router context is not configured, the following applies:

  1. the system uses the system interface address (which is also the loopback address)
  2. if a system interface address is not configured, it uses the last 32 bits of the chassis MAC address

This is a required command when configuring multiple instances and the instance being configured is not the base instance.

When configuring a new router ID, the instance is not automatically restarted with the new router ID. The next time the instance is initialized, the new router ID is used.

To force the new router ID to be used, issue the shutdown and no shutdown commands for the instance, or reboot the entire router.

It is possible to configure an SR OS to operate with an IPv6 only BOF and no IPv4 system interface address. When configured in this manner, the operator must explicitly define IPv4 router IDs for protocols such as OSPF and BGP as there is no mechanism to derive the router ID from an IPv6 system interface address.

The no form of this command to reverts to the default value.

rtr-adv-lsa-limit

Syntax 
rtr-adv-lsa-limit limit [log-only] [threshold percent]
rtr-adv-lsa-limit limit [log-only] [threshold percent] [overload-timeout {seconds | forever}]
no rtr-adv-lsa-limit
Context 
config>router>ospf
config>router>ospf3
Description 

This command configures the maximum number of LSAs OSPF can learn from another router, in order to protect the system from a router that accidentally advertises a large number of LSAs. When the number of advertised LSAs reaches the configured percentage of this limit, an SNMP trap is sent. If the limit is exceeded, OSPF goes into overload.

The overload-timeout option allows the administrator to control how long OSPF is in overload as a result of the advertised LSA limit being reached. At the end of this duration of time the system automatically attempts to restart OSPF. One possible value for the overload-timeout is forever, which means OSPF is never restarted automatically and this corresponds to the default behavior when the overload-timeout option is not configured.

The no form of this command removes the rtr-adv-lsa-limit.

Default 

no rtr-adv-lsa-limit

Parameters 
log-only—
Enables the warning message to be sent at the specified threshold percentage, and also when the limit is exceeded. However, overload is not set.
percent—
Specifies the threshold value (as a percentage) that triggers a warning message to be sent.
Values—
0 to 100

 

limit—
Specifies the number of LSAs that can be learned expressed as a decimal integer.
Values—
1 to 4294967295

 

second—
Specifies duration in minutes before restarting OSPF.
Values—
Values 1 to 1800

 

forever—
Specifies that OSPF is restarted only after the clear router ospf | ospf3 overload rtr-adv-lsa-limit command is executed.

segment-routing

Syntax 
[no] segment-routing
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables the context to configure segment routing parameters within an IGP instance.

Segment routing adds to IS-IS, OSPF, or OSPF3 routing protocols the ability to perform shortest path routing and source routing using the concept of abstract segment. A segment can represent a local prefix of a node, a specific adjacency of the node (interface or next hop), a service context, or a specific explicit path over the network. For each segment, the IGP advertises an identifier referred to as a segment ID (SID).

When segment routing is used together with the MPLS data plane, the SID is a standard MPLS label. A router forwarding a packet using segment routing will thus push one or more MPLS labels.

Segment routing using MPLS labels can be used in both shortest path routing applications and traffic engineering applications. This feature implements the shortest path forwarding application.

After segment routing is successfully enabled in the IS-IS, OSPF, or OSPF3 instance, the router will perform the following operations:

  1. Advertise the Segment Routing Capability sub-TLV to routers in all areas or levels of the IGP instance. However, only neighbors with which the IGP instance established an adjacency will interpret the SID and label range information and use it for calculating the label to swap to or push for a particular resolved prefix SID.
  2. Advertise the assigned index for each configured node SID in the new prefix SID sub-TLV with the N-flag (node SID flag) set. The segment routing module then programs the incoming label map (ILM) with a pop operation for each local node SID in the data path.
  3. Automatically assign and advertise an adjacency SID label for each formed adjacency over a network IP interface in the new adjacency SID sub-TLV. The segment routing module programs the incoming label map (ILM) with a pop operation, in effect with a swap to an implicit null label operation, for each advertised adjacency SID.
  4. Resolve received prefixes, and if a prefix SID sub-TLV exists, the segment routing module programs the ILM with a swap operation and programs an LSP ID to NHLFE (LTN) with a push operation, both pointing to the primary/LFA NHLFE. An SR tunnel is also added to the TTM.

When the user enables segment routing in an IGP instance, the main SPF and LFA SPF are computed normally and the primary next hop and LFA backup next hop for a received prefix are added to the RTM without the label information advertised in the prefix SID sub-TLV.

adjacency-set

Syntax 
[no] adjacency-set id
Context 
config>router>ospf>segm-rtng
config>router>isis>segm-rtng
Description 

This command creates an adjacency set. An adjacency set consists of one or more adjacency SIDs originating on this node. The constituent adjacencies may terminate on different nodes.

The no form of this command removes the specified adjacency set.

Parameters 
id—
Specifies an unsigned integer representing the identifier of the adjacency set.
Values—
1 to 4294967295

 

parallel

Syntax 
parallel [no-advertise]
no parallel
Context 
config>router>ospf>segm-rtng>adjacency-set
config>router>isis>segm-rtng>adjacency-set
Description 

This command indicates that all members of the adjacency set must terminate on the same neighboring node. The system raises a trap if a user attempts to add an adjacency terminating on a neighboring node that differs from the existing members of the adjacency set. In addition, the system stops advertising the adjacency set in IS-IS or OSPF and locally deprograms it.

By default, parallel adjacency sets are advertised in the IGP. The no-advertise option prevents an adjacency set from being advertised in the IGP. It is only allowed in CLI and SNMP if the parallel command is configured.

The no form of this command indicates that the adjacency set can include adjacencies to different next hop nodes.

Default 

parallel

sid

Syntax 
sid label value
Context 
config>router>ospf>segm-rtng>adjacency-set
config>router>isis>segm-rtng>adjacency-set
Description 

This command allows a static SID value to be assigned to an adjacency set in IS-IS or OSPF segment routing.

The label option specifies the value is assigned to an MPLS label.

The no form of this command removes the adjacency SID.

Parameters 
label value—
Specifies the value of adjacency SID label.
Values—
18432 to 524287 | 1048575 (FP4 only)

 

adj-sid-hold

Syntax 
adj-sid-hold seconds
no adj-sid-hold
Context 
config>router>ospf>segm-rtng
config>router>ospf3>segm-rtng
Description 

This command configures a timer to hold the ILM or LTM of an adjacency SID following a failure of the adjacency.

When an adjacency to a neighbor fails, the IGP will withdraw the advertisement of the link TLV information as well as its adjacency SID sub-TLV. However, the LTN or ILM record of the adjacency SID must be kept in the data path to maintain forwarding using the LFA or remote LFA backup for sufficient length of time to allow the ingress LER and other routers that use this adjacency SID to activate a new path after the IGP converges.

If the adjacency is restored before the timer expires, the timer is aborted as soon as the new ILM or LTN records are updated with the new primary and backup NHLFE information.

The no form of this command removes the adjacency SID hold time.

Default 

adj-sid-hold 15

Parameters 
seconds—
Specifies the adjacency SID hold time, in seconds.
Values—
1 to 300

 

backup-node-sid

Syntax 
backup-node-sid ip-prefix/prefix-length index index
backup-node-sid ip-prefix/prefix-length label label
no backup-node-sid
Context 
config>router>ospf>segm-rtng
Description 

This command enables LFA Protection using segment routing backup node SID.

The objective of this feature is to reduce the label stack pushed in a LFA tunnel next hop of inter-area and inter-domain prefixes. This is applicable in MPLS deployments across multiple IGP areas or domains such in seamless MPLS design.

The user enables the feature by configuring a backup node SID at an ABR/ASBR that is acting as a backup to the primary exit ABR/ASBR of inter-area or inter-as routes learned as BGP labeled routes. The user can enter either a label or an index for the backup node SID.

When a node in a IGP domain resolves a BGP label route for an inter-area or inter-domain prefix via the primary ABR exit router, it will use the backup node SID of this router, which is advertised by the backup ABR/ABR, as the LFA backup instead of the SID to the remote LFA PQ node to save on the pushed label stack.

This feature only allows the configuration of a single backup node SID per IGP instance and per ABR/ASBR. In other words, only a pair of ABR/ASBR nodes can back up each other in an IGP domain. Each time the user invokes the above command within the same IGP instance, it will override any previous configuration of the backup node SID. The same ABR/ASBR can, however, participate in multiple IGP instances and provide backup support within each instance.

Default 

no backup-node-sid

Parameters 
ip-prefix/prefix-length—
Specifies the IP prefix in dotted decimal notation for the range used by the ABR to advertise that summarizes the area into another area.
Values—
ip-prefix/mask:
  1. ip-prefix a.b.c.d (host bits must be 0)
ipv6-prefix:
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D
prefix-length: 0 to 128

 

index—
Specifies the index for this backup node SID.
Values—
0 to 4294967295

 

label—
Specifies the SID value for this backup node SID.
Values—
1 to 4294967295

 

class-forwarding

Syntax 
[no] class-forwarding
Context 
config>router>ospf>segm-rtng
config>router>isis>segm-rtng
Description 

This command enables Class Based Forwarding with ECMP for SR-ISIS or SR-OSPF resolved to RSVP-TE LSPs as IGP shortcuts. For CBF+ECMP to be effective, a class forwarding policy must be defined. In addition, FC to set associations and RSVP-TE LSPs to set associations must be defined.

The no form of this command disables Class Based Forwarding with ECMP for SR-ISIS or SR-OSPF resolved to RSVP-TE LSPs as IGP shortcuts.

Default 

no class-forwarding

egress-statistics

Syntax 
egress-statistics
Context 
config>router>isis>segm-rtng
config>router>ospf>segm-rtng
config>router>ospf3>segm-rtng
Description 

This command enables the context to configure the egress statistics for IGP SIDs.

adj-set

Syntax 
[no] adj-set
Context 
config>router>isis>segm-rtng>egress-statistics
config>router>ospf>segm-rtng>egress-statistics
config>router>isis>segm-rtng>ingress-statistics
config>router>ospf>segm-rtng>ingress-statistics
Description 

This command enables the allocation of statistic indices to each adjacency set. All adjacencies of a set share the same statistics index. If a statistics index is not available at allocation time, the allocation fails, then the system re-tries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

The no form of this command disables the allocation of statistic indices to each adjacency set, releases the statistic indices, and clears the associated counters.

Default 

no adj-set

adj-sid

Syntax 
[no] adj-sid
Context 
config>router>isis>segm-rtng>egress-statistics
config>router>ospf>segm-rtng>egress-statistics
config>router>ospf3>segm-rtng>egress-statistics
config>router>isis>segm-rtng>ingress-statistics
config>router>ospf>segm-rtng>ingress-statistics
config>router>ospf3>segm-rtng>ingress-statistics
Description 

This command enables the allocation of statistic indices to each programmed NHLFE corresponding to Adjacency SIDs (local and received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails, then the system re-tries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

The no form of this command disables the allocation of statistic indices to each adjacency SID, releases the statistic indices, and clears the associated counters.

Default 

no adj-sid

node-sid

Syntax 
[no] node-sid
Context 
config>router>isis>segm-rtng>egress-statistics
config>router>ospf>segm-rtng>egress-statistics
config>router>ospf3>segm-rtng>egress-statistics
config>router>isis>segm-rtng>ingress-statistics
config>router>ospf>segm-rtng>ingress-statistics
config>router>ospf3>segm-rtng>ingress-statistics
Description 

This command enables the allocation of statistic indices to each node SID (received by means of IGP advertisement). All NHLFEs associated to a given SID share the same index. If a statistics index is not available at allocation time, the allocation fails, then the system re-tries the allocation. The system generates a log on the first fail and a log on the final successful allocation.

The no form of this command disables the allocation of statistic indices to each node SID, releases the statistic indices, and clears the associated counters.

Default 

no node-sid

entropy-label

Syntax 
entropy-label {force-disable | enable}
no entropy-label
Context 
config>router>isis>segm-rtng
config>router>ospf>segm-rtng
Description 

This command instructs the system to ignore any received IGP advertisements of entropy label capability relating to remote nodes in the network. It also prevents a user from configuring override-tunnel-elc for the IGP instance.

The no version of this command enables the processing of any received IGP advertisements of entropy label capability.

Default 

entropy-label enable

Parameters 
force-disable —
Forces the system to ignore any received entropy label capability signaled in the IGP.
enable —
Enables the system to process any received entropy label capability signaled in the IGP.

export-tunnel-table

Syntax 
[no] export-tunnel-table ldp
Context 
config>router>ospf>segm-rtng
Description 

This command enables exporting, to an IGP instance, the LDP tunnels for the purpose of stitching a SR tunnel to a LDP FEC for the same destination IPv4 /32 prefix.

In the SR-to-LDP data path direction, the SR mapping server provides a global policy for the prefixes corresponding to the LDP FECs that the SR stitches to.

When this command is enabled in the segment-routing context of an IGP instance, IGP listens to LDP tunnel entries in the TTM. Whenever a LDP tunnel destination matches a prefix for which IGP received a prefix-SID sub-TLV from a mapping server, it instructs the SR module to program the SR ILM and to stitch it to the LDP tunnel endpoint. The LDP FEC can be resolved via a static route, a IS-IS instance, or an OSPF instance.

When an SR tunnel is stitched to a LDP FEC, packets forwarded will benefit from the protection of the LFA backup next hop of the LDP FEC.

When resolving a node SID, IGP will prefer resolution of prefix SID received in a IP Reach TLV over a prefix SID received via the mapping server. In other words, the swapping of the SR ILM to a SR NHLFE is preferred over stitching it to a LDP tunnel endpoint.

It is recommended to enable the bfd-enable option on the interfaces in both LDP and IGP instance contexts, to speed up the failure detection and the activation of the LFA/remote-LFA backup next hop in either direction of the stitching.

This feature is limited to IPv4 /32 prefixes in both LDP and SR.

The no form of this command disables the exporting of LDP tunnels to the IGP instance.

ingress-statistics

Syntax 
ingress-statistics
Context 
config>router>isis>segm-rtng
config>router>ospf>segm-rtng
config>router>ospf3>segm-rtng
Description 

This command enters the context to configure the ingress statistics for IGP SIDs.

mapping-server

Syntax 
[no] mapping-server
Context 
config>router>ospf>segm-rtng
Description 

This command configures the context for the Segment Routing mapping server feature in an OSPF instance.

The mapping server feature allows the configuration and advertisement in OSPF of the node SID index for OSPF prefixes of routers which are in the LDP domain. This is performed in the router acting as a mapping server and using a prefix-SID sub-TLV within the Extended Prefix Range TLV in OSPF.

The no form of this command deletes all node SID entries in the OSPF instance.

maximum-sid-depth

Syntax 
maximum-sid-depth
Context 
config>router>ospf>segm-rtng
Description 

This command enables the context to configure a manual override of the Maximum Segment Depths (MSD) that is announced by the router.

override-bmi

Syntax 
override-bmi value
no override-bmi
Context 
config>router>ospf>segm-rtng>msd
Description 

This command provides the ability to override the announced MSD node Base MPLS Imposition (BMI). The MSD-BMI value announced by a router can be used by recipients to understand the number of MPLS labels that can be imposed inclusive of all service, transport, or special labels.

When override-bmi is not configured, the router announces the node maximum supported BMI assuming themost simple services and Layer 2 encapsulation.

The no form of this command reverts to the default.

Default 

no override-bmi

Parameters 
values—
Specifies the override BMI.The upper limit depends on the FP chipset used.
Values—
0 to 12

 

override-erld

Syntax 
override-erld value
no override-erld
Context 
config>router>ospf>segm-rtng>msd
Description 

This command provides the ability to override the announced MSD node Entropy Readable Label Depth (ERLD). It is useful for ingress LSRs to know each intermediate LSR's capability of reading the maximum label stack depth and performing EL-based load balancing.

When override-erld is not configured, then the router announces the node maximum supported ERLD assuming the most simple Layer 2 encapsulation.

Default 

no override-erld

Parameters 
values—
Specifies the override ERLD.The upper limit depends on the FP chipset used.
Values—
0 to 15

 

sid-map

Syntax 
sid-map node-sid index index-value [range range-value] prefix ip-address/mask [netmask]
sid-map node-sid index index-value [range range-value] prefix ip-address/mask [netmask] scope {area area-id | as}
no sid-map node-sid index index-value
Context 
config>router>ospf>segm-rtng>mapping-server
Description 

This command configures the Segment Routing mapping server database in OSPF.

The user enters the node SID index for one or a range of prefixes by specifying the first index value and optionally a range value. The default value for the range option is 1. Only the first prefix in a consecutive range of prefixes must be entered. If the user enters the first prefix with a mask lower than 32, the OSPF Extended Prefix Range TLV is advertised but a router which receives it will not resolve SID and instead originates a trap.

The user specifies the mapping server own flooding scope for the generated OSPF Extended Prefix Range TLV using the scope option. There is no default value. If the scope is a specific area, then the TLV is flooded only in that area.

An ABR that propagates an intra-area OSPF Extended Prefix Range TLV flooded by the mapping server in that area into other areas, sets the inter-area flag (IA-flag). The ABR also propagates the TLV if received with the inter-area flag set from other ABR nodes but only from the backbone to leaf areas and not vice-versa. However, if the exact same TLV is advertised as an intra-area TLV in a leaf area, the ABR will not flood the inter-area TLV into that leaf area.

Note:

SR OS does not leak this TLV between OSPF instances.

Each time a prefix or a range of prefixes is configured in the SR mapping database in any routing instance, the router issues for this prefix, or range of prefixes, a prefix-SID sub-TLV within a OSPF Extended Prefix Range TLV in that instance. The flooding scope of the TLV from the mapping server is determined as previously explained. No further check of the reachability of that prefix in the mapping server route table is performed and no check if the SID index is duplicate with some existing prefix in the local IGP instance database or if the SID index is out of range with the local SRGB.

The no form of this command deletes the range of node SIDs beginning with the specified index value.

Default 

no prefix-sid-range

Parameters 
index index-value—
Specifies the index.
Values—
0 to 4294967295

 

range range-value—
Specifies the range.
Values—
1 to 65535

 

prefix ip-address/mask—
Specifies the IP address in dotted decimal notation.
Values—
ip-address/mask:
  1. ip-address a.b.c.d (host bits must be 0)
mask: 0 to 132

 

netmask—
Specifies the netmask.
Values—
netmask — a.b.c.d (network bits all 1 and host bits all 0)

 

area area-id —
Configures the mapping server own flooding scope for the generated OSPF Extended Prefix Range TLV.
Values—
ip-address | 0 to 4294967295

 

prefix-sid-range

Syntax 
prefix-sid-range global
prefix-sid-range start-label label-value max-index index-value
no prefix-sid-range
Context 
config>router>ospf>segm-rtng
config>router>ospf3>segm-rtng
Description 

This command configures the prefix SID index range and offset label value for an IGP instance.

The key parameter is the configuration of the prefix SID index range and the offset label value that this IGP instance will use. Because each prefix SID represents a network global IP address, the SID index for a prefix must be unique network-wide. Therefore, all routers in the network are expected to configure and advertise the same prefix SID index range for an IGP instance. However, the label value used by each router to represent this prefix, that is, the label programmed in the ILM, can be local to that router by the use of an offset label, referred to as a start label:

Local Label (Prefix SID) = start-label + {SID index}

The label operation in the network is very similar to LDP when operating in independent label distribution mode (RFC 5036, LDP Specification), with the difference being that the label value used to forward a packet to each downstream router is computed by the upstream router based on the advertised prefix SID index using the above formula.

There are two mutually exclusive modes of operation for the prefix SID range on the router. In the global mode of operation, the user configures the global value and this IGP instance will assume the start label value is the lowest label value in the SRGB and the prefix SID index range size equal to the range size of the SRGB. After one IGP instance selected the global option for the prefix SID range, all IGP instances on the system will be restricted to do the same. The user must shutdown the segment routing context and delete the prefix-sid-range command in all IGP instances in order to change the SRGB. After the SRGB is changed, the user must re-enter the prefix-sid-range command again. The SRGB range change will be failed if an already allocated SID index/label goes out of range.

In per-instance mode, the user partitions the SRGB into non-overlapping sub-ranges among the IGP instances. The user configures a subset of the SRGB by specifying the start label value and the prefix SID index range size. All resulting net label values (start-label + index) must be within the SRGB or the configuration will fail. The 7750 SR checks for overlaps of the resulting net label value range across IGP instances and will strictly enforce no overlapping of these ranges. The user must shut down the segment routing context of an IGP instance in order to change the SID index/label range of that IGP instance using the prefix-sid-range command. A range change will fail if an already allocated SID index/label goes out of range. The user can change the SRGB without shutting down the segment routing context as long as it does not reduce the current per-IGP instance SID index/label range defined with the prefix-sid-range command. Otherwise, shut down the segment routing context of the IGP instance, and disable and re-enable the prefix-sid-range command.

Default 

no prefix-sid-range

Parameters 
label-value—
Specifies the label offset for the SR label range of this IGP instance.
Values—
0 to 524287

 

index-value—
Specifies the maximum value of the prefix SID index range for this IGP.
Values—
1 to 524287

 

srlb

Syntax 
srlb reserved-label-block-name
no srlb
Context 
config>router>ospf>segm-rtng
config>router>isis>segm-rtng
Description 

This command specifies the reserved label block to use for the Segment Routing Local Block (SRLB) for the specified IS-IS or OSPF instance. The named reserved label block must already have been configured under config>router>mpls>mpls-labels.

The no form of this command removes an SRLB.

Parameters 
reserved-label-block-name—
Specifies the name of the reserved label block, up to 64 characters.

tunnel-mtu

Syntax 
tunnel-mtu bytes
no tunnel-mtu
Context 
config>router>ospf>segm-rtng
config>router>ospf3>segm-rtng
Description 

This command configures the MTU of all SR tunnels within each IGP instance.

The MTU of a SR tunnel populated into the TTM is determined as the same as an IGP tunnel; for example, for an LDP LSP, based on the outgoing interface MTU minus the label stack size. Remote LFA can add, at most, one more label to the tunnel for a total of two labels. There is no default value for this command. If the user does not configure an SR tunnel MTU, the MTU will be determined by IGP as follows:

The MTU of the SR tunnel in bytes is then determined as follows:

SR_Tunnel_MTU = MIN {Cfg_SR_MTU, IGP_Tunnel_MTU- (1+frr—overhead)×4}

Where:

  1. Cfg_SR_MTU is the MTU configured by the user for all SR tunnels within an IGP instance using the tunnel-mtu command. If no value is configured by the user, the SR tunnel MTU is determined by the IGP interface calculation explained in the next bullet point.
  2. IGP_Tunnel_MTU is the minimum of the IS-IS or OSPF interface MTU among all the ECMP paths or among the primary and LFA backup paths of this SR tunnel.
  3. frr-overhead is set to 1 if the segment-routing and remote-lfa options are enabled in the IGMP instance. Otherwise, it is set to 0.

The SR tunnel MTU is dynamically updated whenever any of the above parameters used in its calculation changes. This includes if the set of the tunnel next-hops changes or the user changes the configured SR MTU or interface MTU value.

Default 

no tunnel-mtu

Parameters 
bytes—
Specifies the size of the MTU in bytes.
Values—
512 to 9786

 

tunnel-table-pref

Syntax 
tunnel-table-pref preference
no tunnel-table-pref
Context 
config>router>ospf>segm-rtng
config>router>ospf3>segm-rtng
Description 

This command configures the TTM preference of shortest path SR tunnels created by the IGP instance. This is used for BGP shortcuts, VPRN auto-bind, or BGP transport tunnel when the tunnel binding commands are configured to the any value, which parses the TTM for tunnels in the protocol preference order. The user can choose to either accept the global TTM preference or explicitly list the tunnel types they want to use. If the user lists the tunnel types explicitly, the TTM preference is still used to select one type over the other. In both cases, a fallback to the next preferred tunnel type is performed if the selected type fails. A reversion to a more preferred tunnel type is performed as soon as one is available.

The segment routing module adds to the TTM an SR tunnel entry for each resolved remote node SID prefix and programs the data path having the corresponding LTN with the push operation pointing to the primary and LFA backup NHLFEs.

The default preference for shortest path SR tunnels in the TTM is set lower than LDP tunnels but higher than BGP tunnels to allow controlled migration of customers without disrupting their current deployment when they enable segment routing. The following is the value of the default preference for the various tunnel types. This includes the preference of SR tunnels based on shortest path (referred to as SR-ISIS and SR-OSPF).

Note:

The preference of an SR-TE LSP is not configurable and is the second most preferred tunnel type after RSVP-TE. The preference is the same whether if the SR-TE LSP was resolved in IS-IS or OSPF.

The global default TTM preference for the tunnel types is as follows:

  1. ROUTE_PREF_RSVP 7
  2. ROUTE_PREF_SR_TE 8
  3. ROUTE_PREF_LDP 9
  4. ROUTE_PREF_OSPF_TTM 10
  5. ROUTE_PREF_ISIS_TTM 11
  6. ROUTE_PREF_BGP_TTM 12
  7. ROUTE_PREF_GRE 255

The default value for SR-ISIS or SR-OSPF is the same regardless if one or more IS-IS or OSPF instances programmed a tunnel for the same prefix. The selection of a SR tunnel in this case will be based on the lowest IGP instance ID. Similarly, IPv6 SR-ISIS and SR-OSPF3 tunnels are programmed into TTMv6 with the same default preference value as IPv4 SR-ISIS and IPv4 SR-OSPF respectively.

Default 

tunnel-table-pref 10

Parameters 
preference—
Specifies the integer value to represent the preference of IS-IS, OSPF, or OSPF3 SR tunnels in the TTM.
Values—
1 to 255

 

timers

Syntax 
timers
Context 
config>router>ospf
config>router>ospf3
Description 

This command enables the context that allows for the configuration of OSPF timers. Timers control the delay between receipt of a link state advertisement (LSA) requiring a Dijkstra (Shortest Path First (SPF)) calculation and the minimum time between successive SPF calculations.

Changing the timers affects CPU utilization and network re-convergence times. Lower values reduce convergence time but increase CPU utilization. Higher values reduce CPU utilization but increase re-convergence time.

incremental-spf-wait

Syntax 
incremental-spf-wait inc-spf-wait
no incremental-spf-wait
Context 
config>router>ospf>timers
config>router>ospf3>timers
Description 

This command sets the delay before an incremental SPF calculation is performed when LSA types 3, 4, 5, or 7 are received. This allows multiple updates to be processed in the same SPF calculation. Type 1 or type 2 LSAs are considered a topology change and will always trigger a full SPF calculation.

The no form of this command resets the timer value back to the default value.

Note:

The timer granularity is 10 ms if the value is less than 500 ms, and 100 ms if the value is greater than or equal to 500 ms. Timer values are rounded down to the nearest granularity, for example a configured value of 550 ms is internally rounded down to 500 ms.

Default 

incremental-spf-wait 1000

Parameters 
inc-spf-wait—
Specifies the OSPF incremental SPF calculation delay in milliseconds.
Values—
0 to 1000

 

lsa-accumulate

Syntax 
lsa-accumulate lsa-accumulate
no lsa-accumulate
Context 
config>router>ospf>timers
config>router>ospf3>timers
Description 

This command sets the internal OSPF delay to allow for the accumulation of multiple LSA so OSPF messages can be sent as efficiently as possible. The lsa-accumulate timer applies to all LSAs except Type 1 and Type 2 LSAs, which are sent immediately. LSAs are accumulated and then sent when:

  1. its size reaches the MTU size of the interface
  2. a new LSA is received on the interface
  3. the lsa-accumulate timer expires

Shorting this delay can speed up the advertisement of LSAs to OSPF neighbors but may increase the number of OSPF messages sent.

Note:

The timer granularity is 10 ms if the value is less than 500 ms, and 100 ms if the value is greater than or equal to 500 ms. Timer values are rounded down to the nearest granularity, for example a configured value of 550 ms is internally rounded down to 500 ms.

Default 

lsa-accumulate 1000

Parameters 
lsa-accumulate—
Specifies the LSA accumulation delay in milliseconds.
Values—
0 to 1000

 

lsa-arrival

Syntax 
lsa-arrival lsa-arrival-time
no lsa-arrival
Context 
config>router>ospf>timers
config>router>ospf3>timers
Description 

This parameter defines the minimum delay that must pass between receipt of the same Link State Advertisements (LSAs) arriving from neighbors.

It is recommended that the neighbors configured lsa-generate lsa-second-wait interval is equal or greater than the lsa-arrival timer configured here.

The no form of this command reverts to the default.

Note:

The timer granularity is 10 ms if the value is less than 500 ms, and 100 ms if the value is greater than or equal to 500 ms. Timer values are rounded down to the nearest granularity, for example a configured value of 550 ms is internally rounded down to 500 ms.

Default 

lsa-arrival 1000

Parameters 
lsa-arrival-time—
Specifies the timer, in milliseconds.
Values—
0 to 600000

 

lsa-generate

Syntax 
lsa-generate max-lsa-wait [lsa-initial-wait lsa-initial-wait [lsa-second-wait lsa-second-wait]]
no lsa-generate
Context 
config>router>ospf>timers
config>router>ospf3>timers
Description 

This parameter customizes the throttling of OSPF LSA-generation. Timers that determine when to generate the first, second, and subsequent LSAs can be controlled with this command. Subsequent LSAs are generated at increasing intervals of the lsa-second-wait timer until a maximum value is reached.

Configuring the lsa-arrival interval to equal or less than the lsa-second-wait interval configured in the lsa-generate command is recommended.

The no form of this command reverts to the default.

Note:

The timer granularity is 10 ms if the value is less than 500 ms, and 100 ms if the value is greater than or equal to 500 ms. Timer values are rounded down to the nearest granularity, for example a configured value of 550 ms is internally rounded down to 500 ms.

Default 

lsa-generate 5000

Parameters 
max-lsa-wait—
Specifies the maximum interval in milliseconds between two consecutive occurrences of an LSA being generated.
Values—
10 to 600000

 

Default—
5000
lsa-initial-wait—
Specifies the first waiting period between link-state advertisements (LSA) originate(s), in milliseconds. When the LSA exceeds the lsa-initial-wait timer value and the topology changes, there is no wait period and the LSA is immediately generated.

When an LSA is generated, the initial wait period commences. If, within the specified lsa-initial-wait period and another topology change occurs, then the lsa-initial-wait timer applies.

Values—
10 to 600000

 

Default—
5000
lsa-second-wait—
Specifies the hold time in milliseconds between the first and second LSA generation. The next topology change is subject to this second wait period. With each subsequent topology change, the wait time doubles (this is 2x the previous wait time). This assumes that each failure occurs within the relevant wait period.
Values—
10 to 600000

 

Default—
5000

redistribute-delay

Syntax 
redistribute-delay redistribute-delay
no redistribute-delay
Context 
config>router>ospf>timers
config>router>ospf3>timers
Description 

This command sets the internal OSPF hold down timer for external routes being redistributed into OSPF.

Shorting this delay can speed up the advertisement of external routes into OSPF but can result in additional OSPF messages if that source route is not yet stable.

The no form of this command resets the timer value back to the default value.

Note:

The timer granularity is 10 ms if the value is less than 500 ms, and 100 ms if the value is greater than or equal to 500 ms. Timer values are rounded down to the nearest granularity, for example a configured value of 550 ms is internally rounded down to 500 ms.

Default 

redistribute-delay 1000

Parameters 
redistribute-delay—
Specifies the OSPF redistribution hold down time in milliseconds for external routes being advertised into OSPF.
Values—
0 to 1000

 

spf-wait

Syntax 
spf-wait max-spf-wait [spf-initial-wait spf-initial-wait [spf-second-wait spf-second-wait]]
no spf-wait
Context 
config>router>ospf>timers
config>router>ospf3>timers
Description 

This command defines the maximum interval between two consecutive SPF calculations in milliseconds. Timers that determine when to initiate the first, second, and subsequent SPF calculations after a topology change occurs can be controlled with this command. Subsequent SPF runs (if required) will occur at exponentially increasing intervals of the spf-second-wait interval. For example, if the spf-second-wait interval is 1000, then the next SPF will run after 2000 milliseconds, and then next SPF will run after 4000 milliseconds, and so on, until it reaches the spf-wait value. The SPF interval will stay at the spf-wait value until there are no more SPF runs scheduled in that interval. After a full interval without any SPF runs, the SPF interval will drop back to spf-initial-wait.

The timer must be entered in increments of 100 milliseconds. Values entered that do not match this requirement will be rejected.

Use the no form of this command to return to the default.

Note:

The timer granularity is 10 ms if the value is less than 500 ms, and 100 ms if the value is greater than or equal to 500 ms. Timer values are rounded down to the nearest granularity, for example a configured value of 550 ms is internally rounded down to 500 ms.

Default 

spf-wait 10000

Parameters 
max-spf-wait—
Specifies the maximum interval in milliseconds between two consecutive SPF calculations.
Values—
10 to 120000

 

Default—
10000
spf-initial-wait —
Specifies the initial SPF calculation delay in milliseconds after a topology change.
Values—
10 to 100000

 

Default—
1000
spf-second-wait —
Specifies the hold time in milliseconds between the first and second SPF calculation.
Values—
10 to 100000

 

Default—
1000

traffic-engineering

Syntax 
[no] traffic-engineering
Context 
config>router>ospf
Description 

This command enables the advertisement of the traffic engineering information for the router and its links.

Traffic engineering enables the router to perform route calculations constrained by nodes or links. The traffic engineering of this router are limited to calculations based on link and nodal constraints.

The no form of this command disables the advertisement of the traffic engineering information.

Default 

no traffic-engineering

traffic-engineering-options

Syntax 
[no] traffic-engineering-options
Context 
config>router>ospf
Description 

This command enables the context to configure the advanced traffic-engineering options.

The no form of this command removes the context to configure the advanced traffic-engineering options.

Default 

no traffic-engineering-options

sr-te

Syntax 
sr-te {legacy | application-specific-link-attributes}
no sr-te
Context 
config>router>ospf>traffic-engineering-options
Description 

This command configures the advertisement of TE attributes of each link on a per-application basis. Two applications are supported in SR OS: RSVP-TE and SR-TE. Although the legacy mode of advertising TE attributes is supported, additional configurations are possible.

The no form of this command deletes the context.

Default 

no sr-te

Parameters 
legacy
Advertises the TE attributes for MPLS-enabled SR links using TE Opaque LSAs.
Note:

Do not configure the legacy mode if the network has both RSVP-TE and SR-TE attributes and the links are not congruent.

application-specific-link-attributes
Advertises TE information for MPLS-enabled SR links using the new Application Specific Link Attributes (ASLA) TLVs.

unicast-import-disable

Syntax 
[no] unicast-import-disable
Context 
config>router>ospf
config>router>ospf3
Description 

This command allows one IGP to import its routes into RPF RTM while another IGP imports routes only into the unicast RTM. Import policies can redistribute routes from an IGP protocol into the RPF RTM (the multicast routing table). By default, the IGP routes will not be imported into RPF RTM as such an import policy must be explicitly configured.

Default 

no unicast-import-disable

3.15.2.3. OSPF Area Commands

area

Syntax 
[no] area area-id
Context 
config>router>ospf
config>router>ospf3
Description 

This command creates the context to configure an OSPF or OSPF3 area. An area is a collection of network segments within an AS that have been administratively grouped together. The area ID can be specified in dotted decimal notation or as a 32-bit decimal integer.

The no form of this command deletes the specified area from the configuration. Deleting the area also removes the OSPF configuration of all the interfaces, virtual-links, and address-ranges and so on, that are currently assigned to this area.

Default 

no area

Parameters 
area-id—
The OSPF area ID expressed in dotted decimal notation or as a 32-bit decimal integer.
Values—
0.0.0.0 to 255.255.255.255 (dotted decimal), 0 to 4294967295 (decimal integer)

 

adjacency-set

Syntax 
[no] adjacency-set id
Context 
config>router>ospf>area>interface
config>router>isis>interface
Description 

This command associates an interface with an adjacency set. The adjacency set must have been defined under the IS-IS or OSPF segment-routing context.

The no form of this command removes the association.

Parameters 
id—
Specifies an unsigned integer representing the identifier of the adjacency set.
Values—
1 to 4294967295

 

adjacency-sid

Syntax 
adjacency-sid label value
no adjacency-sid
Context 
config>router>ospf>area>interface
Description 

This command allows a static value to be assigned to an adjacency SID in OSPF segment routing.

The label option specifies that the value is assigned to an MPLS label.

The no form of this command removes the adjacency SID.

Parameters 
label value—
Specifies the value of adjacency SID label.
Values—
18432 to 52428 | 1048575 (FP4 only)

 

advertise-router-capability

Syntax 
[no] advertise-router-capability
Context 
config>router>ospf>area
config>router>ospf>area>interface
config>router>ospf3>area
config>router>ospf3>area>interface
Description 

This command enables advertisement of a router’s capabilities to its neighbors for informational and troubleshooting purposes. A Router Information (RI) LSA as defined in RFC 4970 advertises the following capabilities:

  1. OSPF graceful restart capable: no
  2. OSPF graceful restart helper: yes, when enabled
  3. OSPF stub router support: yes
  4. OSPF traffic engineering support: yes, when enabled
  5. OSPF point-to-point over LAN: yes
  6. OSPF experimental TE: no

The no form of this command disables this capability.

Default 

advertise-router-capability

area-range

Syntax 
area-range ip-prefix/mask [advertise | not-advertise]
no area-range ip-prefix/mask
Context 
config>router>ospf>area
config>router>ospf>area>nssa
Description 

This command creates ranges of addresses on an Area Border Router (ABR) for the purpose of route summarization or suppression. When a range is created, the range is configured to be advertised or not advertised into other areas. Multiple range commands may be used to summarize or hide different ranges. In the case of overlapping ranges, the most specific range command applies.

ABRs send summary link advertisements to describe routes to other areas. To minimize the number of advertisements that are flooded, you can summarize a range of IP addresses and send reachability information about these addresses in an LSA.

The no form of this command deletes the range (non) advertisement.

Default 

no area-range

Special Cases 
NSSA Context—
In the NSSA context, the option specifies that the range applies to external routes (via type-7 LSAs) learned within the NSSA when the routes are advertised to other areas as type-5 LSAs.
Area Context—
If this command is not entered under the NSSA context, the range applies to summary LSAs even if the area is an NSSA.
Parameters 
ip-prefix—
Specifies the IP prefix in dotted decimal notation for the range used by the ABR to advertise that summarizes the area into another area.
Values—
ip-prefix/mask: ip-prefix a.b.c.d (host bits must be 0)

 

mask—
Specifies the subnet mask for the range expressed as a decimal integer mask length or in dotted decimal notation.
Values—
0 to 32 (mask length), 0.0.0.0 to 255.255.255.255 (dotted decimal)

 

advertise | not-advertise—
Specifies whether to advertise the summarized range of addresses into other areas. The advertise keyword indicates the range will be advertised, and the keyword not-advertise indicates the range will not be advertised.
Default—
advertise

bier

Syntax 
[no] bier
Context 
config>router>ospf>area
Description 

This command enables BIER capabilities.

The no form of this command disables BIER capabilities.

Default 

no bier

template

Syntax 
template template-name
no template
Context 
config>router>ospf>area>bier
Description 

This command configures an OSPF BIER template at the OSPF area level.

The no form of this command removes templates from the OSPF area.

Parameters 
template-name—
The name of the template, up to 32 characters.

area-range

Syntax 
area-range ipv4-prefix/mask | ipv6-prefix/prefix-length [advertise | not-advertise]
no area-range ipv4-prefix/mask | ipv6-prefix/prefix-length
Context 
config>router>ospf3>area
config>router>ospf3>area>nssa
Description 

This command creates ranges of addresses on an Area Border Router (ABR) for the purpose of route summarization or suppression. When a range is created, the range is configured to be advertised or not advertised into other areas. Multiple range commands may be used to summarize or hide different ranges. In the case of overlapping ranges, the most specific range command applies.

ABRs send summary link advertisements to describe routes to other areas. To minimize the number of advertisements that are flooded, you can summarize a range of IP addresses and send reachability information about these addresses in an LSA.

The no form of this command deletes the range (non) advertisement.

Default 

no area-range

Special Cases 
NSSA Context—
In the NSSA context, the option specifies that the range applies to external routes (via type-7 LSAs) learned within the NSSA when the routes are advertised to other areas as type-5 LSAs.
Area Context—
If this command is not entered under the NSSA context, the range applies to summary LSAs even if the area is an NSSA.
Parameters 
ip-prefix/prefix-length—
Specifies the IP prefix in dotted decimal notation for the range used by the ABR to advertise that summarizes the area into another area.
Values—
ip-prefix/mask:
  1. ip-prefix a.b.c.d (host bits must be 0)
ipv6-prefix:
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D
prefix-length: 0 to 128

 

advertise | not-advertise—
Specifies whether or not to advertise the summarized range of addresses into other areas. The advertise keyword indicates the range will be advertised, and the keyword not-advertise indicates the range will not be advertised.
Default—
advertise

blackhole-aggregate

Syntax 
[no] blackhole-aggregate
Context 
config>router>ospf>area
config>router>ospf3>area
Description 

This command installs a low priority blackhole route for the entire aggregate. Existing routes that make up the aggregate will have a higher priority and only the components of the range for which no route exists are blackholed.

When performing area aggregation, addresses may be included in the range for which no actual route exists, which can cause routing loops. To avoid this problem, configure the blackhole-aggregate option.

The no form of this command removes this option.

Default 

blackhole-aggregate

database-export-exclude

Syntax 
[no] database-export-exclude
Context 
config>router>ospf>area
Description 

This command allows the user to prune the IGP link-state information of a specific OSPF level or OSPF area from being exported into the extended TE-DB.The no form of this command returns to the default behavior inherited from the database-export command at the IS-IS or OSPF instance level.

Default 

no database-export-exclude

export

Syntax 
[no] export policy-name [policy-name]
Context 
config>router>ospf>area
config>router>ospf3>area
Description 

This command configures ABR export policies to filter OSPFv2 Type 3 Summary-LSAs or OSPFv3 Inter-Area-Prefix-LSA between areas, in order to only permit the specified routes from being exported into an area.

This command cannot be used in OSPF area 0.

The no form of this command reverts to the default value.

Default 

no export

Parameters 
policy-name—
Specifies up to five export route policy names. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. The specified names must already be defined.

extended-lsa

Syntax 
extended-lsa {inherit | only}
no extended-lsa
Context 
config>router>ospf3>area
Description 

This command configures the use of extended LSA format in a OSPFv3 area as per draft-ietf-ospf-ospfv3-lsa-extend.

By default, the area inherits the instance level configuration. The latter defaults to sparse mode of operation. The extended-lsa only value enables the full extended LSA mode and this will cause all existing and new LSAs to use the extended LSA format.

The OSPFv3 instance must first be shut down before the user can change the mode of operation since the protocol must flush all LSAs and re-establish all adjacencies.

The no form at the area level returns the area into the default mode of inheriting the mode from the OSPFv3 instance level.

Default 

extended-lsa inherit

Parameters 
inherit—
Configures the area to inherit the mode of operation enabled at the OSPFv3 instance level.
only—
Enables the full extended LSA mode of operation in an OSPFv3 area.

import

Syntax 
[no] import policy-name [policy-name]
Context 
config>router>ospf>area
config>router>ospf3>area
Description 

This command configures ABR import policies to filter OSPFv2 Type 3 Summary-LSAs or OSPFv3 Inter-Area-Prefix-LSA between areas, in order to only permit the specified routes from being imported into an area.

This command cannot be used in OSPF area 0.

The no form of this command reverts to the default value.

Default 

no import

Parameters 
policy-name—
Specifies up to five import route policy names. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. The specified names must already be defined.

key-rollover-interval

Syntax 
key-rollover-interval seconds
Context 
config>router>ospf3>area
Description 

This command configures the key rollover interval.

Default 

key-rollover-interval 10

Parameters 
seconds—
Specifies the time, in seconds, after which a key rollover will start.
Values—
10 to 300

 

lfa-policy-map

Syntax 
lfa-policy-map route-nh-template template-name
no lfa-policy-map
Context 
config>router>ospf>area>interface
Description 

This command specifies the next hop template to be applied to those prefixes which primary next-hops use.

Parameters 
template-name—
Specifies a template name, up to 32 characters.

load-balancing-weight

Syntax 
load-balancing-weight [weight]
no load-balancing-weight
Context 
config>router>ospf>area>if
config>router>ospf3>area>if
Description 

This command configures the weighted ECMP load-balancing weight for an OSPF or OSPF3 interface. If the interface becomes an ECMP next hop for an IPv4 or IPv6 route, and all the other ECMP next hops are interfaces with configured (non-zero) load-balancing weights, then the traffic distribution over the ECMP interfaces is proportional to the weights. This means that the interface with the largest load-balancing weight receives the most forwarded traffic if weighted ECMP is applicable.

The no form of this command disables weighted ECMP for the interface which effectively disables weighted ECMP for any IP prefix that has this interface as a next hop.

Default 

no load-balancing-weight

Parameters 
weight—
Specifies the load balancing weight.
Values—
1 to 4294967295

 

loopfree-alternate-exclude

Syntax 
loopfree-alternate-exclude prefix-policy prefix-policy [prefix-policy)]
no loopfree-alternate-exclude
Context 
config>router>ospf
config>router>ospf3
Description 

This command excludes from the LFA SPF calculation those prefixes that match a prefix entry or a tag entry in a prefix policy. If a prefix is excluded from LFA, it is not included in LFA calculations regardless of its priority. The prefix tag will, however, be used in the main SPF.

The implementation also allows the user to exclude a specific interface in IS-IS or OSPF, a or all interfaces in an OSPF area or IS-IS level from the LFA SPF.

Note:

Prefix tags are defined for the IS-IS protocol but not for the OSPF protocol.

The default action of the loopfree-alternate-exclude command, when not explicitly specified by the user in the prefix policy, is “reject”. Therefore, regardless of whether the user explicitly added the statement “default-action reject” to the prefix policy, a prefix that does not match any entry in the policy will be accepted into LFA SPF.

The no form of this command deletes the exclude prefix policy.

Default 

no loopfree-alternate-exclude

Parameters 
prefix-policy—
Specifies up to five policy prefix names. The specified policy name must already be defined. Prefix policies are created with the command config>router>policy-options>prefix-list (For information on prefix lists, see Route Policies).

loopfree-alternate-exclude

Syntax 
[no] loopfree-alternate-exclude
Context 
config>router>ospf>area
config>router>ospf>area>interface
config>router>ospf3>area
config>router>ospf3>area>interface
Description 

This command instructs IGP to not include a specific interface or all interfaces participating in a specific IS-IS level or OSPF area in the SPF LFA computation. This provides a way of reducing the LFA SPF calculation where it is not needed.

When an interface is excluded from the LFA SPF in IS-IS, it is excluded in both level 1 and level 2. When it is excluded from the LFA SPF in OSPF, it is excluded in all areas. However, the above OSPF command can only be executed under the area in which the specified interface is primary and once enabled, the interface is excluded in that area and in all other areas where the interface is secondary. If the user attempts to apply it to an area where the interface is secondary, the command will fail.

The no form of this command re-instates the default value for this command.

Default 

no loopfree-alternate-exclude

multi-instance

Syntax 
[no] multi-instance
Context 
config>router>ospf
Description 

This command enables OSPF multi-instance RFC 6549, OSPFv2 Multi-Instance Extensions, support in the BASE router. This support is enabled per instance and allows flexibility when migrating a particular instance from classic OSPFv2 to a multi-instance OSPFv2.

The no form of the command reverts to the default.

Default 

no multi-instance

nssa

Syntax 
[no] nssa
Context 
config>router>ospf>area
config>router>ospf3>area
Description 

This command creates the context to configure an OSPF or OSPF3 Not So Stubby Area (NSSA) and adds/removes the NSSA designation from the area.

NSSAs are similar to stub areas in that no external routes are imported into the area from other OSPF areas. The major difference between a stub area and an NSSA is an NSSA has the capability to flood external routes that it learns throughout its area and via an ABR to the entire OSPF or OSPF3 domain.

Existing virtual links of a non-stub or NSSA area will be removed when the designation is changed to NSSA or stub.

An area can be designated as stub or NSSA but never both at the same time.

By default, an area is not configured as an NSSA area.

The no form of this command removes the NSSA designation and configuration context from the area.

Default 

no nssa

originate-default-route

Syntax 
originate-default-route [type-7] [no-adjacency-check]
originate-default-route [type-nssa] [no-adjacency-check]
no originate-default-route
Context 
config>router>ospf>area>nssa
config>router>ospf3>area>nssa
Description 

This command enables the generation of a default route and its LSA type (3 or 7) into a Not So Stubby Area (NSSA) by an NSSA Area Border Router (ABR).

When configuring an NSSA with no summaries, the ABR will inject a type 3 LSA default route into the NSSA area. Some older implementations expect a type 7 LSA default route.

The no form of this command disables origination of a default route.

Default 

no originate-default-route

Parameters 
type-7—
Specifies a type 7 LSA should be used for the default route in the config>router>ospf>area>nssa context.

Configure this parameter to inject a type-7 LSA default route instead the type 3 LSA into the NSSA configured with no summaries.

To revert to a type 3 LSA, enter originate-default-route without the type-7 parameter.

Default—
Type 3 LSA default route.
type-nssa—
Specifies an NSSA-LSA type should be used for the default route in the config>router>ospf3>area>nssa context.
no-adjacency-check—
Specifies whether or not adjacency checks are performed before originating a default route. If this parameter is configured, then no area 0 adjacency is required for the ABR to advertise the default route.
Default—
Adjacency checks are performed, and an area 0 adjacency is required for the ABR to advertise the default route.

redistribute-external

Syntax 
[no] redistribute-external
Context 
config>router>ospf>area>nssa
config>router>ospf3>area>nssa
Description 

This command enables the redistribution of external routes into the Not So Stubby Area (NSSA) or an NSSA area border router (ABR) that is exporting the routes into non-NSSA areas.

NSSA or Not So Stubby Areas are similar to stub areas in that no external routes are imported into the area from other OSPF or OSPF3 areas. The major difference between a stub area and an NSSA is that the NSSA has the capability to flood external routes that it learns (providing it is an ASBR) throughout its area and via an Area Border Router to the entire OSPF or OSPF3 domain.

The no form of this command disables the default behavior to automatically redistribute external routes into the NSSA area from the NSSA ABR.

Default 

redistribute-external

summaries

Syntax 
[no] summaries
Context 
config>router>ospf>area>nssa
config>router>ospf>area>stub
config>router>ospf3>area>nssa
config>router>ospf3>area>stub
Description 

This command enables sending summary (type 3) advertisements into a stub area or Not So Stubby Area (NSSA) on an Area Border Router (ABR).

This parameter is particularly useful to reduce the size of the routing and Link State Database (LSDB) tables within the stub or NSSA area (default: summary).

By default, summary route advertisements are sent into the stub area or NSSA.

The no form of this command disables sending summary route advertisements and, for stub areas; only the default route is advertised by the ABR.

Default 

summaries

stub

Syntax 
[no] stub
Context 
config>router>ospf>area
config>router>ospf3>area
Description 

This command enables access to the context to configure an OSPF or OSPF3 stub area and adds/removes the stub designation from the area.

External routing information is not flooded into stub areas. All routers in the stub area must be configured with the stub command. An OSPF or OSPF3 area cannot be both an NSSA and a stub area.

Existing virtual links of a non STUB or NSSA area will be removed when its designation is changed to NSSA or STUB.

By default, an area is not a stub area.

The no form of this command removes the stub designation and configuration context from the area.

Default 

no stub

default-metric

Syntax 
default-metric metric
no default-metric
Context 
config>router>ospf>area>stub
config>router>ospf3>area>stub
Description 

This command configures the metric used by the area border router (ABR) for the default route into a stub area.

The default metric should only be configured on an ABR of a stub area.

An ABR generates a default route if the area is a stub area.

The no form of this command reverts to the default value.

Default 

default-metric 1

Parameters 
metric—
Specifies the metric expressed as a decimal integer for the default route cost to be advertised into the stub area.
Values—
1 to 16777214

 

3.15.2.4. Interface/Virtual Link Commands

interface

Syntax 
[no] interface ip-int-name [secondary]
Context 
config>router>ospf>area
config>router>ospf3>area
Description 

This command creates a context to configure an OSPF interface.

By default, interfaces are not activated in any interior gateway protocol, such as OSPF, unless explicitly configured.

The no form of this command deletes the OSPF interface configuration for this interface. The shutdown command in the config>router>ospf>interface context can be used to disable an interface without removing the configuration for the interface.

Default 

no interface

Parameters 
ip-int-name—
Specifies the IP interface name. Interface names must be unique within the group of defined IP interfaces for config>router>interface and config>service>ies>interface commands. An interface name cannot be in the form of an IP address. Interface names can be any string, up to 32 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

If the IP interface name does not exist or does not have an IP address configured an error message will be returned.

If the IP interface exists in a different area it will be moved to this area.

secondary—
Allows multiple secondary adjacencies to be established over a single IP interface.

virtual-link

Syntax 
[no] virtual-link router-id transit-area area-id
Context 
config>router>ospf>area
config>router>ospf3>area
Description 

This command configures a virtual link to connect area border routers to the backbone via a virtual link.

The backbone area (area 0.0.0.0) must be contiguous and all other areas must be connected to the backbone area. If it is not practical to connect an area to the backbone (see area 0.0.0.2 in the picture below) then the area border routers (routers 1 and 2 in the picture below) must be connected via a virtual link. The two area border routers will form a point-to-point like adjacency across the transit area. (area 0.0.0.1 in the picture below). A virtual link can only be configured while in the area 0.0.0.0 context.

The router-id specified in this command must be associated with the virtual neighbor. The transit area cannot be a stub area or a Not So Stubby Area (NSSA).

The no form of this command deletes the virtual link.

By default, no virtual link is defined.

Default 

no virtual-link

Parameters 
router-id—
Specifies the router ID of the virtual neighbor in IP address dotted decimal notation.
area-id—
Specifies the area-id that identifies the transit area that links the backbone area with the area that has no physical connection with the backbone.

The OSPF backbone area, area 0.0.0.0, must be contiguous and all other areas must be connected to the backbone area. The backbone distributes routing information between areas. If it is not practical to connect an area to the backbone (see Area 0.0.0.5 in Figure 14) then the area border routers (such as routers Y and Z) must be connected via a virtual link. The two area border routers form a point-to-point-like adjacency across the transit area (see Area 0.0.0.4).

Figure 14:  OSPF Areas 

advertise-subnet

Syntax 
[no] advertise-subnet
Context 
config>router>ospf>area>interface
Description 

This command enables advertising point-to-point interfaces as subnet routes (network number and mask). When disabled, point-to-point interfaces are advertised as host routes.

The no form of this command disables advertising point-to-point interfaces as subnet routes meaning they are advertised as host routes.

Default 

advertise-subnet

auth-keychain

Syntax 
auth-keychain
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
Description 

This command configures an authentication keychain to use for the protocol interface. The keychain allows the rollover of authentication keys during the lifetime of a session.

Default 

no auth-keychain

Parameters 
name —
Specifies the name of the keychain, up to 32 characters, to use for the specified protocol session or sessions.

authentication

Syntax 
authentication bidirectional sa-name
authentication [inbound sa-name outbound sa-name]
no authentication
Context 
config>router>ospf3>area>interface
config>router>ospf3>area>virtual-link
Description 

This command configures the password used by the OSPF3 interface or virtual-link to send and receive OSPF3 protocol packets on the interface when simple password authentication is configured.

All neighboring routers must use the same type of authentication and password for proper protocol communication.

By default, no authentication key is configured.

The no form of this command removes the authentication.

Default 

no authentication

Parameters 
bidirectional sa-name—
Specifies bidirectional OSPF3 authentication.
inbound sa-name—
Specifies the inbound security association (SA) name for OSPF3 authentication.
outbound sa-name—
Specifies the outbound SA name for OSPF3 authentication.

authentication-key

Syntax 
authentication-key [authentication-key | hash-key] [hash | hash2 | custom]
no authentication-key
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
Description 

This command configures the password used by the OSPF interface or virtual-link to send and receive OSPF protocol packets on the interface when simple password authentication is configured.

All neighboring routers must use the same type of authentication and password for proper protocol communication. If the authentication-type is configured as password, then this key must be configured.

By default, no authentication key is configured.

The no form of this command removes the authentication key.

Default 

no authentication-key

Parameters 
authentication-key—
Specifies the authentication key. The key can be any combination of ASCII characters up to 8 characters in length (unencrypted). If spaces are used in the string, enclose the entire string in quotation marks (“ ”).
hash-key—
Specifies the hash key. The key can be any combination of ASCII characters up to 22 characters (encrypted). If spaces are used in the string, enclose the entire string in quotation marks (“ ”).

This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.

hash—
Specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
hash2—
Specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
custom—
Specifies the custom encryption to management interface.

authentication-type

Syntax 
authentication-type {password | message-digest}
no authentication-type
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
Description 

This command enables authentication and specifies the type of authentication to be used on the OSPF interface.

Both simple password and message-digest authentication are supported.

By default, authentication is not enabled on an interface.

The no form of this command disables authentication on the interface.

Default 

no authentication-type

Parameters 
password—
Enables the simple password (plain text) authentication. If authentication is enabled and no authentication type is specified in the command, simple password authentication is enabled.
message-digest—
Enables message digest MD5 authentication in accordance with RFC1321. If this option is configured, then at least one message-digest-key must be configured.

bfd-enable

Syntax 
[no] bfd-enable [remain-down-on-failure]
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command enables the use of bidirectional forwarding detection (BFD) to control the state of the associated protocol interface. By enabling BFD on a given protocol interface, the state of the protocol interface is tied to the state of the BFD session between the local node and the remote node. The parameters used for the BFD are set via the BFD command under the IP interface.

The no form of this command removes BFD from the associated OSPF protocol adjacency.

Default 

no bfd-enable

Parameters 
remain-down-on-failure—
If the BFD session does not come back up within 10 seconds, then OSPF brings down the adjacency and wait on BFD again. This can cause OSPF neighbors to flap, because OSPF will form the adjacency and then bring it down if the BFD session is still down. If this parameter is not configured, the OSPF adjacency will form even if the BFD adjacency does not come back up after a failure.

dead-interval

Syntax 
dead-interval seconds
no dead-interval
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
config>router>ospf3>area>interface
config>router>ospf3>area>virtual-link
Description 

This command configures the time, in seconds, that OSPF waits before declaring a neighbor router down. If no hello packets are received from a neighbor for the duration of the dead interval, the router is assumed to be down. The minimum interval must be two times the hello interval.

The no form of this command reverts to the default value.

Default 

dead-interval 40

Special Cases 
OSPF Interface—
If the dead-interval configured applies to an interface, then all nodes on the subnet must have the same dead interval.
Virtual Link—
If the dead-interval configured applies to a virtual link, then the interval on both termination points of the virtual link must have the same dead interval.
Parameters 
seconds—
The dead interval expressed in seconds.
Values—
1 to 65535

 

hello-interval

Syntax 
hello-interval seconds
no hello-interval
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
config>router>ospf3>area>interface
config>router>ospf3>area>virtual-link
Description 

This command configures the interval between OSPF hellos issued on the interface or virtual link.

The hello interval, in combination with the dead-interval, is used to establish and maintain the adjacency. Use this parameter to edit the frequency that hello packets are sent.

Reducing the interval, in combination with an appropriate reduction in the associated dead-interval, allows for faster detection of link and/or router failures at the cost of higher processing costs.

The no form of this command reverts to the default value.

Default 

hello-interval 10

Special Cases 
OSPF Interface—
If the hello-interval configured applies to an interface, then all nodes on the subnet must have the same hello interval.
Virtual Link—
If the hello-interval configured applies to a virtual link, then the interval on both termination points of the virtual link must have the same hello interval.
Parameters 
seconds—
Specifies the hello interval, in seconds, expressed as a decimal integer.
Values—
1 to 65535

 

interface-type

Syntax 
interface-type {broadcast | point-to-point |non-broadcast}
no interface-type
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command configures the interface type to be one of broadcast, point-to-point, or non-broadcast.

Use this command to set the interface type of an Ethernet link to point-to-point to avoid having to carry the broadcast adjacency maintenance overhead of the Ethernet link provided the link is used as point-to-point.

If the interface type is not known at the time the interface is added to OSPF and subsequently the IP interface is bound (or moved) to a different interface type, this command must be entered manually.

The no form of this command returns the setting to the default value.

Default 

interface-type point-to-point  (if the physical interface is SONET)

interface-type broadcast  (if the physical interface is Ethernet or unknown)

Special Cases 
Virtual-Link—
A virtual link is always regarded as a point-to-point interface and not configurable.
Parameters 
broadcast—
Configures the interface as a broadcast network. To significantly improve adjacency forming and network convergence, configure a network as point-to-point if only two routers are connected, even if the network is a broadcast media such as Ethernet.
point-to-point—
Configures the interface as a point-to-point link.
non-broadcast—
Configures the interface as a non-broadcast network.

lfa-policy-map

Syntax 
lfa-policy-map route-nh-template template-name
no lfa-policy-map
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command applies a route next hop policy template to an OSPF or IS-IS interface.

When a route next hop policy template is applied to an interface in IS-IS, it is applied in both level 1 and level 2. When a route next hop policy template is applied to an interface in OSPF, it is applied in all areas. However, the command in an OSPF interface context can only be executed under the area in which the specified interface is primary and then applied in that area and in all other areas where the interface is secondary. If the user attempts to apply it to an area where the interface is secondary, the command will fail.

If the user excluded the interface from LFA using the command loopfree-alternate-exclude, the LFA policy, if applied to the interface, has no effect.

Finally, if the user applied a route next hop policy template to a loopback interface or to the system interface, the command will not be rejected, but it will result in no action being taken.

The no form of this command deletes the mapping of a route next hop policy template to an OSPF or IS-IS interface.

Default 

no lfa-policy-map

Parameters 
template-name—
Specifies the name of the template, up to 32 characters.

lsa-filter-out

Syntax 
lsa-filter-out [all | except-own-rtrlsa | except-own-rtrlsa-and-defaults]
no lsa-filter-out
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command enables filtering of outgoing OSPF LSAs on the selected OSPFv2 or OSPFv3 interface. Three filtering options are provided:

  1. Do not flood any LSAs out the interface. This option is suitable if the neighbor is simply-connected and has a statically configured default route with the address of this interface as next hop.
  2. Flood the router’s own router-LSA out the interface and suppress all other flooded LSAs. This option is suitable if the neighbor is simply-connected and has a statically configured default route with a loopback or system interface address (contained in the router-LSA) as next hop.
  3. Flood the router’s own router-LSA and all self-generated type-3, type-5 and type-7 LSAs advertising a default route (0/0) out the interface; suppress all other flooded LSAs. This option is suitable if the neighbor is simply-connected and does not have a statically configured default route.

The no form of this command disables OSPF LSA filtering (normal operation).

Default 

no lsa-filter-out

message-digest-key

Syntax 
message-digest-key key-id md5 [key | hash-key | hash2-key] [hash | hash2 | custom]
no message-digest-key key-id
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
Description 

This command configures a message digest key when MD5 authentication is enabled on the interface. Multiple message digest keys can be configured.

The no form of this command removes the message digest key identified by the key-id.

By default, no message keys are defined.

Parameters 
key-id—
The keyid is expressed as a decimal integer.
Values—
1 to 255

 

key—
Specifies the MD5 key. The key can be any alphanumeric string up to 16 characters in length.
hash-key | hash2-key—
Specifies the MD5 hash or hash2 key. the hash key. The key can be any combination of ASCII characters up to 32 (hash1-key) or 55 (hash2-key) characters in length (encrypted). If spaces are used in the string, enclose the entire string in quotation marks (“ ”).

This is useful when a user must configure the parameter, but, for security purposes, the actual unencrypted key value is not provided.

hash—
Specifies the key is entered in an encrypted form. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
hash2—
Specifies the key is entered in a more complex encrypted form that involves more variables than the key value alone, meaning that the hash2 encrypted variable cannot be copied and pasted. If the hash or hash2 parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash or hash2 parameter specified.
custom—
Specifies the custom encryption to management interface.

metric

Syntax 
metric metric
no metric
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command configures an explicit route cost metric for the OSPF interface that overrides the metrics calculated based on the speed of the underlying link.

The no form of this command deletes the manually configured interface metric, so the interface uses the computed metric based on the reference-bandwidth command setting and the speed of the underlying link.

Default 

no metric

Parameters 
metric—
Specifies the metric to be applied to the interface expressed as a decimal integer.
Values—
1 to 65535

 

mtu

Syntax 
mtu bytes
no mtu
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command configures the OSPF packet size used on this interface. If this parameter is not configured OSPF derives the MTU value from the MTU configured (default or explicitly) in the following contexts:

  1. config>port>ethernet
  2. config>port>sonet-sdh>path
  3. config>port>tdm>t3-e3
  4. config>port>tdm>t1-e1>channel-group

If this parameter is configured, the smaller value between the value configured here and the MTU configured (default or explicitly) in an above-mentioned context is used.

To determine the actual packet size, add 14 bytes for an Ethernet packet and 18 bytes for a tagged Ethernet packet to the size of the OSPF (IP) packet MTU configured in this command.

The no form of this command reverts to the default derived from the MTU configured in the config>port context.

Default 

no mtu

Parameters 
bytes—
Specifies the MTU to be used by OSPF for this logical interface in bytes.
Values—
512 to 9786 in the config>router>ospf>area>interface context.
1280 to 9786 in the config>router>ospf3>area>interface context.

 

neighbor

Syntax 
[no] neighbor ipv4-address
[no] neighbor ipv6-address
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command configures an OSPF non-broadcast multi-access (NBMA) neighbor. The OSPF interface must be configured as an NBMA interface with the interface-type non-broadcast command. An NBMA network has no broadcast or multicast capabilities, so the router cannot discover its neighbors dynamically. All neighbors must be configured statically with the neighbor command.

In addition to configuring the OSPF NBMA neighbor’s IP address, the neighbor’s MAC address may need to be configured with the config>router>interface>static-arp command for OSPFv2 neighbors using its IPv4 address, and the config>router>interface>ipv6>neighbor command for OSPFv3 neighbors using its IPv6 link-local address.

The no form of this command removes the neighbor configuration.

Default 

no neighbor

Parameters 
ipv4-address—
Specifies the OSPFv2 neighbor’s IPv4 address.
Values—
ipv4-address — a.b.c.d

 

ipv6-address—
Specifies the OSPFv3 neighbor’s IPv6 link-local address.
Values—

ipv6-address:

x:x:x:x:x:x:x:x [-interface]

x:x:x:x:x:x:d.d.d.d [-interface]

x: [0..FFFF]H

d: [0..255]D

interface — 32 characters maximum for link local addresses.

 

node-sid

Syntax 
node-sid index index-value [clear-n-flag]
node-sid label label-value [clear-n-flag]
no node-sid
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command assigns a node SID index or label value to the prefix representing the primary address of an IPv4 network interface of type loopback. Only a single node SID can be assigned to an interface. The secondary address of an IPv4 interface cannot be assigned a node SID index and does not inherit the SID of the primary IPv4 address.

The above command should fail if the network interface is not of type loopback or if the interface is defined in an IES or a VPRN context. Assigning the same SID index/label value to the same interface in two different IGP instances is not allowed within the same node.

The value of the label or index SID is taken from the range configured for this IGP instance. When using the global mode of operation, the segment routing module checks that the same index or label value is not assigned to more than one loopback interface address. When using the per-instance mode of operation, this check is not required because the index and therefore the label ranges, of IGP instances are not allowed to overlap.

The clear-n-flag option allows the user to clear the N-flag (node-sid flag) in an OSPF or OSPF3 prefix SID sub-TLV originated for the prefix of a loopback interface on the system. By default, the prefix SID sub-TLV for the prefix of a loopback interface is tagged as a node SID, meaning that it belongs to this node only. However, when the user wants to configure and advertise an anycast SID using the same loopback interface prefix on multiple nodes, you must clear the N-flag to assure interoperability with third-party implementations, which may perform a strict check on the receive end and drop duplicate prefix SID sub-TLVs when the N-flag is set.

The SR OS implementation is relaxed on the receive end and accepts duplicate prefix SIDs with the N-flag set or clear. SR OS will resolve to the closest owner, or owners if ECMP, of the prefix SID cost-wise.

Parameters 
index-value—
Specifies the node SID index value.
Values—
0 to 4294967295

 

label-value—
Specifies the node SID label value.
Values—
0 to 4294967295

 

clear-n-flag—
Clears the node SID flag.
Default—
no clear-n-flag

passive

Syntax 
[no] passive
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command adds the passive property to the OSPF interface where passive interfaces are advertised as OSPF interfaces but do not run the OSPF protocol.

By default, only interface addresses that are configured for OSPF will be advertised as OSPF interfaces. The passive parameter allows an interface to be advertised as an OSPF interface without running the OSPF protocol.

While in passive mode, the interface will ignore ingress OSPF protocol packets and not transmit any OSPF protocol packets.

Service interfaces defined in config>router>service-prefix are passive. All other interfaces are not passive.

The no form of this command removes the passive property from the OSPF interface.

Default 

no passive

poll-interval

Syntax 
poll-interval seconds
no poll-interval
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command configures the poll interval, in seconds. The poll interval is the time between two Hello packets to a dead (non-adjacent) OSPF NBMA neighbor. The default value of the poll interval timer is higher than the hello interval timer to avoid wasting bandwidth on non-broadcast networks, since OSPF messages are unicast to each configured neighbor. The poll interval timer is used only on non-broadcast interface types and has no effect if configured on other interface types.

The no form of this command removes the poll-interval configuration.

Default 

120

Parameters 
seconds—
Specifies the poll interval, in seconds.
Values—
0 to 4294967295

 

priority

Syntax 
priority number
no priority
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command configures the priority of the OSPF interface that is used in an election of the designated router on the subnet.

This parameter is only used if the interface is of type broadcast. The router with the highest priority interface becomes the designated router. A router with priority 0 is not eligible to be Designated Router or Backup Designated Router.

The no form of this command reverts the interface priority to the default value.

Default 

priority 1

Parameters 
number—
Specifies the interface priority expressed as a decimal integer. A value of 0 indicates the router is not eligible to be the Designated Router or Backup Designated Router on the interface subnet.
Values—
0 to 255

 

retransmit-interval

Syntax 
retransmit-interval seconds
no retransmit-interval
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
config>router>ospf3>area>interface
config>router>ospf3>area>virtual-link
Description 

This command specifies the length of time, in seconds, that OSPF will wait before retransmitting an unacknowledged link state advertisement (LSA) to an OSPF neighbor.

The value should be longer than the expected round trip delay between any two routers on the attached network. After the retransmit-interval expires and no acknowledgment has been received, the LSA will be retransmitted.

The no form of this command reverts to the default interval.

Default 

retransmit-interval 5

Parameters 
seconds—
Specifies the retransmit interval in seconds expressed as a decimal integer.
Values—
1 to 1800

 

rib-priority

Syntax 
rib-priority {high}
no rib-priority
Context 
config>router>ospf>area>interface
config>router>ospf3>area>interface
Description 

This command enables RIB prioritization for the OSPF/OSPFv3 protocol. When enabled at the OSPF interface level, all routes learned through the associated OSPF interface will be processed through the OSPF route calculation process at a higher priority.

The no form of rib-priority command disables RIB prioritization at the associated level.

Default 

no rib-priority

Parameters 
high—
Specifies that the name of the prefix list which contains prefixes get high priority for RIB-download. The high priority prefixes are downloaded first to the RIB. In doing so, the convergence time for these prefixes is better.

sid-protection

Syntax 
[no] sid-protection
Context 
config>router>ospf>area>interface
Description 

This command enables or disables adjacency SID protection by LFA and remote LFA.

LFA and remote LFA Fast-Reroute (FRR) protection is enabled for all node SIDs and local adjacency SIDs when the user enables the loopfree-alternate option in IS-IS or OSPF at the LER and LSR. However, may be applications where the user never wants traffic to divert from the strict hop computed by CSPF for an SR-TE LSP. In this case, the user can disable protection for all adjacency SIDs formed over a particular network IP interface using this command.

The protection state of an adjacency SID is advertised in the B-FLAG of the IS-IS or OSPF Adjacency SID sub-TLV.

Default 

sid-protection

transit-delay

Syntax 
transit-delay seconds
no transit-delay
Context 
config>router>ospf>area>interface
config>router>ospf>area>virtual-link
config>router>ospf3>area>interface
config>router>ospf3>area>virtual-link
Description 

This command configures the estimated time, in seconds, that it takes to transmit a link state advertisement (LSA) on the interface or virtual link.

The no form of this command reverts to the default delay time.

Default 

transit-delay 1

Parameters 
seconds—
Specifies the transit delay in seconds expressed as a decimal integer.
Values—
1 to 1800