PimRouterConfig Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Configuration parameters for a single PIM routing instance.

Parents: EmulatedDevice

Children: Pimv4GroupBlk, Pimv4RegisterBlk, Pimv4RpMap, Pimv6GroupBlk, Pimv6RegisterBlk, Pimv6RpMap

Result children (automatically created): PimRouterResults

Relations:

Side name
(Type)		 Relative Description
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

MPLS control plane binding results.
ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

ResultChild
(ResultChild)

PimRouterResults

Use this to connect a results object to an object.
TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

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).

PimRouterConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AddressListOptionSet

Indicate whether set address list option in Hello message.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Addresss list option is set in Hello message.
FALSE

Addresss list option is not set in Hello message
BiDirOptionSet

If true (selected), the BI-DIR option is included in the Hello messages.

Spirent TestCenter does not support the BI-DIR specification. However, Spirent TestCenter does allow this option to be sent in the Hello message.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables sending BI-DIR option in Hello messages.
FALSE

Disables sending BI-DIR option in Hello messages.
BootstrapMessageInterval

Frequency in seconds with which bootstrap messages are transmitted.

Type: u16

Default: 60

Range: 1 - 3600
BsrPriority

8-bit priority of the emulated bootstrap router (BSR).

Type: u8

Default: 1

Range: 0 - 255
DrPriority

Designated Router (DR) priority of this router. This value is sent as an option in the Hello message.

Type: u32

Default: 1
EnableBsr

PIM routers enabled for bootstrap routing (BSR) functionality generate Bootstrap messages periodically.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables sending Bootstrap messages.
FALSE

Disables sending Bootstrap messages.
GenIdMode

Used in Spirent TestCenter to help negative-test DUTs.

In PIM, routers send the Generation ID as an option in the Hello messages. Every time a router starts up, it selects a random number. The router uses that number as long as it remains operational. If the Generation ID changes, it is an indication to the neighboring routers that this router has gone through a shutdown-restart cycle. This causes the neighboring routers to reset their databases and start fresh. If the generation ID mode is Fixed, it emulates normal PIM router behavior. Incremental or Random means Spirent TestCenter will send different generation IDs in successive Hello messages, causing the DUTs to reset and rebuild their databases often.

The interactive menu option, Increment Generation ID, sends one Hello message with incremented Generation ID.

Type: enum

Default: FIXED

Possible Values:

Value Description
FIXED

Emulates normal PIM router behavior.
INCREMENT

Spirent TestCenter sends different Generation IDs in successive Hello messages, incrementing by one each time.
RANDOM

Spirent TestCenter sends different Generation IDs in successive Hello messages, selecting a random number each time.
HelloHoldtime

Hold time in seconds to keep neighbor state alive.

Type: u16

Default: 105

Range: 1 - 65535
HelloInterval

Periodic interval in seconds for Hello messages.

Type: u16

Default: 30

Range: 1 - 3600
IpVersion

IP version to be used for communication with the neighbor.

Type: enum

Default: V4

Possible Values:

Value Description
V4

Uses IP version 4.
V6

Uses IP version 6.
JoinPruneHoldtime

Hold time in seconds to advertise in Join/Prune messages.

Type: u16

Default: 210

Range: 1 - 65535
JoinPruneInterval

Frequency in seconds at which Join/Prune messages are sent.

Type: u16

Default: 60

Range: 1 - 65535
NullRegisterOnlyMode

Determines whether this PIM router supports full emulation or only NULL register messages.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

This PIM router only supports NULL register messages.
FALSE

This PIM router supports the full emulation.
PimMode

Emulated router's PIM mode.

Type: enum

Default: SM

Possible Values:

Value Description
SM

Router supports all three group types: (S,G), (*,*,RP), and (*,G).
SSM

Router will not send Join/Prune messages for groups that are not (S,G). You cannot add (*,*,RP) or (*,G) groups.
UpstreamNeighborV4

IPv4 upstream neighbor address to be used in Join/Prune messages.

Type: ip

Default: null
UpstreamNeighborV6

IPv6 upstream neighbor address to be used in Join/Prune messages.

Type: ipv6

Default: null
UsePartialBlockState

Use partial block state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use partial block state.
FALSE

Do not use partial block state.

PimRouterConfig Read-Only Attributes

Read-Only Attribute Description
RouterState

Reports the emulated router's status.

Type: enum

Default: NO_STATE

Possible Values:

Value Description
NO_STATE

Initial state of a router after it has been configured. It does not send Hellos or any other messages, and does not process any incoming messages.

Transitions to Hello on receipt of a Start Router interactive event.
STOPPED

State of the router after it has been stopped by the user. It processes incoming messages and updates router statistics.

Transitions to Hello on receipt of a Start Router interactive event.
STARTED

Router is idle, incrementing received counters. It does not send Hellos or any other messages.

Transitions to Stopped on receipt of a Shutdown Router interactive event.

Transitions to Hello on receipt of a Resume Hellos interactive event.
HELLO

Initial state of a router after it has been started. In this state, the router sends periodic Hellos, and counts transmitted and received packets.

Transitions to Stopped on receipt of a Shutdown Router interactive event.

Transitions to Started on receipt of a Stop Hellos interactive event.

Transitions to Neighbor on receipt of a Hello packet from a neighbor.
NEIGHBOR

Router transitions into Neighbor state after it receives a Hello from its neighbor. In this state, the router sends periodic Hellos, periodic Join/Prunes (if groups are configured), and periodic Bootstraps (if RP maps are configured).

Transitions to Stopped on receipt of a Shutdown Router interactive event.

Transitions to Started on receipt of a Stop Hellos interactive event.

Transitions to Hello if all existing neighbors time out (i.e., if the router does not receive a Hello from any neighbor for the duration of Hello Holdtime).
DR

Internal state.