Ospfv2RouterConfig Object

Description:

Defines the characteristics of an emulated OSPF version 2 router that will form an adjacency with the DUT. This is the OSPFv2 main router configuration object.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: AsbrSummaryLsa, ExtendedInterAreaAsbrLsa, ExtendedLinkLsa, ExtendedPrefixLsa, ExternalLsaBlock, NetworkLsa, Ospfv2SessionDetails, RouterInfoLsa, RouterLsa, SummaryLsaBlock, TeLsa

Automatically-created children: Ospfv2AreaIdModifier, Ospfv2AuthenticationParams, Ospfv2SimplifiedSegmentRoutingParams, TeParams

Result children (automatically created): Ospfv2RouterResults

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	MPLS ControlPlane Binding Result
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	Primary Path Protocol Config
(ResolvesInterface)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Use this to link the traffic binding interfaces and traffic binding resolver.
ResultChild (ResultChild)	Ospfv2RouterResults	Use this to connect a results object to an object.
TimeComparisonPair (TimeComparisonPairSrcProtocol)	TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair	Time Comparison Pair Source Protocol
UsesIf (UsesIf)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

Ospfv2RouterConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AreaId

Area to which the emulated router belongs. It must match an area ID configured for the DUT to enable communication with the DUT.

Type: ip

Default: 0.0.0.0

EnableBfd

Enable or disable BFD (Bidirectional Forwarding Detection) for this router. You must also create a BfdRouterConfig object under the parent Router object.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable BFD.
FALSE	Disable BFD.

EnableGracefulRestart

Enable or disable Graceful Restart.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable graceful restart.
FALSE	Disable graceful restart.

EnableSrLabelManagement

Enable or disable SR label management for Simplified Segment Routing.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable SR Label Management.
FALSE	Disable SR Label Management.

FloodDelay

Flood delay in milliseconds. This is the interval parameter to control the rate at which LSAs are generated by each emulated OSPF router (inter-LSA delay).

Type: u32

Default: 100

Range: 0 - 2147483647

GracefulRestartMaxLoad

Enable or disable requesting all the LSA packets from the router during adjacency establishment.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Protocol will request all LSAs advertised by the router during adjacency establishment.
FALSE	Protocol will request no LSAs advertised by the router during adjacency establishment.

GracefulRestartReason

Specifies the graceful restart reason.

Type: enum

Default: UNKNOWN

Possible Values:

Value	Description
UNKNOWN	Unknown.
SOFTWARE	Software restart.
RELOAD	Software reload or upgrade.
SWITCH	Switch to redundant control processor.

GracefulRestartStrictHelper

If an emulated router is a strict helper (per RFC 3623 or Cisco LLS Signalling drafts), it will cease to be a helper if its Link State Database changes while it is helping a restarting router. When a router ceases to be a helper, graceful restart procedures will be terminated and the restarting router will follow normal restart and adjacency forming procedures.

Type: enum

Default: NO

Possible Values:

Value	Description
NO	Not a strict helper.
YES	Yes, a strict helper.

GracefulRestartTimer

Graceful Restart Timer (seconds).

Type: u32

Default: 40

Range: 40 - 1800

GracefulRestartType

Specifies the type of graceful restart.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	No graceful restart.
RFCSTANDARD	Follows RFC 3623.
LLSIGNALLING	Link Layer Signalling.

GuaranteeDelivery

Determines how LSA configuration changes are handled.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Protocol will transmit LSA configuration changes in one or more LS Update packets. The protocol will wait for acknowledgement or the Retransmit Interval before sending the next packet.
FALSE	Protocol will transmit LSA configuration changes in one or more LS Update packets separated by the interval defined in the Flood Delay field. The protocol will not wait for acknowledgement before sending the next packet.

HelloInterval

Hello Interval in seconds. The time interval used by the emulated routers to pace Hello packet transmissions.

Type: u32

Default: 10

Range: 1 - 65535

IfCost

Interface Cost. The cost of the interface connecting the emulated router to the neighbor SUT router.

Type: u16

Default: 1

Range: 1 - 65535

LsaRefreshInterval

Maximum time in seconds between originations of an LSA. The time interval used to refresh the LS database to the neighbor SUT router.

Type: u32

Default: 1800

Range: 10 - 21600

NetworkType

Network Type. This setting is used to override the physical link type to emulate a P2P adjacency over Ethernet (VLAN) or over POS, or Broadcast adjacency over Ethernet non-VLAN.

Type: enum

Default: NATIVE

Possible Values:

Value	Description
NATIVE	Network type = Native (Default).
BROADCAST	Network type = Broadcast.
P2P	Network type = Point-to-point (P2P).

Options

A bit mask that specifies the settings of the Options field in Hello packets sent to the DUT. The Options field describes the optional OSPF capabilities of the router. Section A.2 in RFC 2328 describes the Options field. Use hexadecimal for this value. The default, 0x02, sets the E-bit (binary 00000010).

Type: enum

Default: EBIT

Possible Values:

Value	Description
TBIT	Type of Service (TOS) (T,0).
EBIT	Specifies the way AS-external-LSAs are flooded (E,1).
MCBIT	Specifies whether IP multicast datagrams are forwarded (MC,2).
NPBIT	Specifies the handling of Type-7 LSAs (NSSA) (N/P,3).
EABIT	Specifies the router's willingness to receive and forward External-Attributes-LSAs (EA,4).
DCBIT	Specifies the router's handling of demand circuits (DC,5).
OBIT	Specifies the router's willingness to receive and forward Opaque LSAs as specified in RFC 2370 (O,6).
UNUSED7	This bit is not used.

RetransmitInterval

Retransmit interval in seconds. The interval before which the application transmits the packet again if an LSA transmission fails.

Type: u32

Default: 5

Range: 1 - 2147483647

RouterDeadInterval

Router Dead interval in seconds. The time interval that the emulated router waits to receive packets from the neighbor SUT router before deleting that neighbor from its topology.

Type: u32

Default: 40

Range: 1 - 65535

RouterPriority

Router priority for this router. This is used in the designated router election procedure. A router priority of 0 (the default) makes the router ineligible to be the designated router.

Type: u8

Default: 0

Range: 0 - 255

TeInfoPresent

Indicates if TE Information is available.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	TE Info is available.
FALSE	TE Info is not available.

TeMetric

Traffic engineering metric. The traffic engineering metric of a link from the Spirent TestCenter port to the DUT. This becomes TE Metrics in the Link TLV of the TE LSA originated by the emulated router.

Type: u32

Default: 0

Range: 0 - 2147483647

UsePartialBlockState

Whether to use partial block state.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use partial block state.
FALSE	Do not use partial block state.

ViewRoutes

If enabled, the stack will start to collect routes/LSAs it receives from the peer. Then later if a "View Routes" command is issued, the stack can send the stored routes for display.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	View routes is enabled.
FALSE	View routes is disabled.

Ospfv2RouterConfig Read-Only Attributes

Read-Only Attribute

Description

AdjacencyStatus

OSPFv2 Adjacency State.

Type: enum

Default: DOWN

Possible Values:

Value	Description
DOWN	Initial state of a neighbor conversation. It indicates that there has been no recent information received from the neighbor.
ATTEMPT	This state is only valid for neighbors attached to non-broadcast networks. It indicates that no recent information has been received from the neighbor, but that a more concerted effort should be made to contact the neighbor. This is done by sending the neighbor Hello packets at intervals of HelloInterval.
INIT	An Hello packet has recently been seen from the neighbor. However, bidirectional communication has not yet been established with the neighbor (the router itself did not appear in the neighbor's Hello packet). All neighbors in this state (or higher) are listed in the Hello packets sent from the associated interface.
TWOWAYS	Communication between the two routers is bidirectional. This has been assured by the operation of the Hello Protocol. This is the most advanced state short of beginning adjacency establishment. The Backup Designated Router (BDR) is selected from the set of neighbors in the TWOWAYS state or greater.
EXSTART	This is the first step in creating an adjacency between the two neighboring routers. The goal of this step is to decide which router is the master, and to decide upon the initial database description (DD) sequence number. Neighbor conversations in this state or greater are called adjacencies.
EXCHANGE	In this state the router is describing its entire link state database by sending Database Description packets to the neighbor. Each Database Description Packet has a DD sequence number, and is explicitly acknowledged. Only one Database Description Packet is allowed outstanding at any one time. In this state, Link State Request Packets may also be sent asking for the neighbor's more recent advertisements. All adjacencies in Exchange state or greater are used by the flooding procedure. In fact, these adjacencies are fully capable of transmitting and receiving all types of OSPF routing protocol packets.
LOADING	Link State Request packets are sent to the neighbor asking for the more recent advertisements that have been discovered (but not yet received) in the Exchange state.
FULL	Neighboring routers are fully adjacent. These adjacencies will now appear in router links and network links advertisements.

LearnedLabelCount

Learned label count by OSPFv2 SR.

Type: u32

Default: 0

LearnedSidCount

Learned SRv6-SID count by OSPFv2 SR.

Type: u32

Default: 0

NeighborState

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

OSPFv2 neighbor state.

Type: enum

Default: DOWN

Possible Values:

Value	Description
DOWN	Initial state of a neighbor conversation. It indicates that there has been no recent information received from the neighbor.
ATTEMPT	This state is only valid for neighbors attached to non-broadcast networks. It indicates that no recent information has been received from the neighbor, but that a more concerted effort should be made to contact the neighbor. This is done by sending the neighbor Hello packets at intervals of HelloInterval.
INIT	An Hello packet has recently been seen from the neighbor. However, bidirectional communication has not yet been established with the neighbor (the router itself did not appear in the neighbor's Hello packet). All neighbors in this state (or higher) are listed in the Hello packets sent from the associated interface.
TWOWAYS	Communication between the two routers is bidirectional. This has been assured by the operation of the Hello Protocol. This is the most advanced state short of beginning adjacency establishment. The Backup Designated Router (BDR) is selected from the set of neighbors in the TWOWAYS state or greater.
EXSTART	This is the first step in creating an adjacency between the two neighboring routers. The goal of this step is to decide which router is the master, and to decide upon the initial database description (DD) sequence number. Neighbor conversations in this state or greater are called adjacencies.
EXCHANGE	In this state the router is describing its entire link state database by sending Database Description packets to the neighbor. Each Database Description Packet has a DD sequence number, and is explicitly acknowledged. Only one Database Description Packet is allowed outstanding at any one time. In this state, Link State Request Packets may also be sent asking for the neighbor's more recent advertisements. All adjacencies in Exchange state or greater are used by the flooding procedure. In fact, these adjacencies are fully capable of transmitting and receiving all types of OSPF routing protocol packets.
LOADING	Link State Request packets are sent to the neighbor asking for the more recent advertisements that have been discovered (but not yet received) in the Exchange state.
FULL	Neighboring routers are fully adjacent. These adjacencies will now appear in router links and network links advertisements.

ResolvedLabelCount

Resolved label count by OSPFv2 SR.

Type: u32

Default: 0

RouterState

Reports the state of adjacency on the current port.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	Configuration information has not been sent to the card.
NO_OSPFV2	No OSPFv2.
DOWN	No recent information received from any device.
LOOPBACK	Loopback.
WAITING	Emulating router is treating the network as Broadcast and it has a non-zero router priority. The emulated router will stay in this state until the end of the Designated Router election process.
POINT_TO_POINT	Emulated router is treating the network as point-to-point. There is no Designated Router election process, so the emulated router goes to this state immediately.
DR_OTHER	Emulated router is treating the network as Broadcast. If the emulated router's priority is zero, it will immediately switch to this state when it is started (because it cannot become either DR or Backup DR). If the emulated router's priority is non-zero, it will switch to this state if other routers are elected DR and Backup DR.
BACKUP	Emulated router is treating the network as Broadcast, it has a non-zero router priority, and it has been elected the Backup Designated Router.
DR	Emulated router is treating the network as Broadcast, it has a non-zero router priority, and it has been elected the Designated Router.
GR_BIT_MASK	The emulated router state is GR.
HLPR_BIT_MASK	The emulated router state is GR Helper.
STATE_BIT_MASK	No state.
GR_DOWN	The emulated router state is GR Down.
GR_LOOPBACK	The emulated router state is GR Loopback.
GR_WAITING	The emulated router state is GR Waiting.
GR_POINT_TO_POINT	The emulated router state is GR Point-to-Point.
GR_DR_OTHER	The emulated router state is GR DR Other.
GR_BACKUP	The emulated router state is GR Backup.
GR_DR	The emulated router state is GR DR.
HLPR_DOWN	The emulated router state is Helper Down.
HLPR_LOOPBACK	The emulated router state is Helper Loopback.
HLPR_WAITING	The emulated router state is Helper Waiting.
HLPR_POINT_TO_POINT	The emulated router state is Helper Point-to-Point.
HLPR_DR_OTHER	The emulated router state is Helper DR Other.
HLPR_BACKUP	The emulated router state is Helper Backup.
HLPR_DR	The emulated router state is Helper DR.
GR_HLPR_DOWN	The emulated router state is GR Helper Down.
GR_HLPR_LOOPBACK	The emulated router state is GR Helper Loopback.
GR_HLPR_WAITING	The emulated router state is GR Helper Waiting.
GR_HLPR_POINT_TO_POINT	The emulated router state is GR Helper Point-to-Point.
GR_HLPR_DR_OTHER	The emulated router state is GR Helper DR Other.
GR_HLPR_BACKUP	The emulated router state is GR Helper backup.
GR_HLPR_DR	The emulated router state is GR Helper DR.

UnResolvedLabelCount

UnResolved label count by OSPFv2 SR

Type: u32

Default: 0