RouterGenParams Object


Description:

Defines parameters for generating Router objects.

Parents: AccessConcentratorGenParams, AccessStabilityGenParams, AccessVplsGenCeDeviceParams, DeviceGenConfigExpandCommand, FcDeviceGenProtocolParams, FcoeDeviceGenProtocolParams, Ieee80211ConfigParams, LldpDeviceGenProtocolParams, OpenflowOptions, Project, SaaDeviceGenProtocolParams, VqAnalyzerGenParams

Children: AbstPppoeDeviceGenProtocolParams, AncpDeviceGenProtocolParams, BfdDeviceGenProtocolParams, BgpDeviceGenProtocolParams, CuspDeviceGenProtocolParams, DeviceGenAal5IfParams, DeviceGenEthIIIfParams, DeviceGenFcIfParams, DeviceGenGreIfParams, DeviceGenGroupParams, DeviceGenHdlcIfParams, DeviceGenIpv4IfParams, DeviceGenIpv6IfParams, DeviceGenLinkedStep, DeviceGenPppIfParams, DeviceGenPppoeIfParams, DeviceGenTrillIfParams, DeviceGenVlanIfParams, Dhcpv4DeviceGenProtocolParams, Dhcpv4ServerDeviceGenProtocolParams, Dhcpv6DeviceGenProtocolParams, Dhcpv6ServerDeviceGenProtocolParams, Dot1xDeviceGenProtocolParams, Ieee1588v2DeviceGenProtocolParams, IsisDeviceGenProtocolParams, L2tpDeviceGenProtocolParams, L2tpv2DeviceGenProtocolParams, L2tpv3DeviceGenProtocolParams, LdpDeviceGenProtocolParams, MulticastDeviceGenProtocolParams, MulticastHostGenProtocolParams, MulticastRouterGenProtocolParams, NetconfClientDeviceGenProtocolParams, NetconfDeviceGenProtocolParams, Ospfv2DeviceGenProtocolParams, Ospfv3DeviceGenProtocolParams, PimDeviceGenProtocolParams, PppoaDeviceGenProtocolParams, PppoeDeviceGenProtocolParams, PppoeoaDeviceGenProtocolParams, PppoL2tpv2DeviceGenProtocolParams, PppoL2tpv3DeviceGenProtocolParams, RipDeviceGenProtocolParams, RsvpDeviceGenProtocolParams, StpDeviceGenProtocolParams, TrillDeviceGenProtocolParams

Relations:

Side name
(Type)
Relative Description
TopLevelIf
(DeviceGenTopLevelIf)

DeviceGenAal5IfParams, DeviceGenEthIIIfParams, DeviceGenFcIfParams, DeviceGenGreIfParams, DeviceGenHdlcIfParams, DeviceGenIpv4IfParams, DeviceGenIpv6IfParams, DeviceGenPppIfParams, DeviceGenPppoeIfParams, DeviceGenTrillIfParams, DeviceGenVlanIfParams

Used to assign the top level interface parameters in the device generator.

Port
(SelectedPort)

Port

Collection of ports to generate routers on.

RouterGenParams Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Count

Number of routers to create per port/VLAN.

Type: u32

Default: 1

Range: 1 - 4294967295

CountBlockPerPort

Count block per port

Type: u32

Default: 1

Range: 1 - 4294967295

CountPerBlock

Count per block

Type: u32

Default: 1

Range: 1 - 4294967295

GroupAssignmentMode

Group assignment mode.

Type: enum

Default: GROUPS_PER_PORT

Possible Values:

Value Description
ALL_SAME_GROUPS

All routers are assigned to the same group(s).

GROUPS_PER_PORT

Multiple groups are created for each port.

PORTS_PER_GROUP

Multiple ports are grouped together.

PortType

Type of port to generate routers on.

Type: enum

Default: ETHERNET

Possible Values:

Value Description
ETHERNET

Ethernet.

POS

POS (PPP/HDLC).

ATM

ATM.

FC

FC

IEEE80211

IEEE80211

PreviewMaxCount

Maximum number of routers to return in the preview.

Type: u32

Default: 1000

Range: 1 - 100000

PreviewMaxCountPerIncrementLevel

Maximum number of routers to show in the preview for each increment level (for example, port, VLAN, host, and so on). This is used to reduce the number of items in the preview. This option is only applicable in PARTIAL preview mode.

Type: u32

Default: 3

Range: 1 - 100000

PreviewMode

Preview mode.

Type: enum

Default: FULL

Possible Values:

Value Description
FULL

Show all routers in the preview.

PARTIAL

Show a subset of the routers in the preview.

BLOCK

Show all router blocks in the preview.

RouterId

Router ID value.

Type: ip

Default: 192.0.0.1

RouterIdSrc

How the Router ID value is determined.

Type: enum

Default: MANUAL

Possible Values:

Value Description
MANUAL

Use the configured Router ID value and step.

USE_IPV4ADDR

Use the Router ID from the IPv4 interface address.

RouterIdStep

Router ID step value.

Type: ip

Default: 0.0.0.1

StepOrder

Order in which the interfaces will be stepped. For example, a StepOrder of "VlanIf1 VlanIf2" will step the outer VLAN interface before the inner VLAN interface. If StepOrder is not specified, the interfaces are stepped from the innermost (closest to top of stack) interface outward.

Type: string

Default: "" (empty string)

RouterGenParams Read-Only Attributes

There are no read-only attributes.