EmulatedDeviceGenParams Object


Description:

Defines parameters for generating EmulatedDevice 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 devices on.

EmulatedDeviceGenParams Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
BlockIndex

Starting device block index.

Type: u32

Default: 1

BlockMode

EmulatedDevice objects may be used to represent a single device or a block of many devices for higher scalability. EmulatedDevice blocks are not supported by all protocols (for example, routing protocols) and have less granularity of control at the protocol level and in traffic configuration.

Type: enum

Default: ONE_NETWORK_PER_BLOCK

Possible Values:

Value Description
ONE_HOST_PER_BLOCK

One EmulatedDevice block is created for each device (Deprecated).

ONE_DEVICE_PER_BLOCK

One EmulatedDevice block is created for each device.

ONE_NETWORK_PER_BLOCK

One EmulatedDevice block is created for each network.

MULTIPLE_NETWORKS_PER_BLOCK

One EmulatedDevice block may represent multiple networks. Note: There are limitations to what can be represented as a single EmulatedDevice block using this mode.

MULTIPLE_DEVICE_PER_BLOCK

Multiple devices per block

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

DeviceName

Template string for defining device names. $(BlockIndex) will be replaced with the block index of the device block in the current device generator expansion.

Type: string

Default: Device $(BlockIndex)

DeviceTags

Device tags

Type: string

Default: "" (empty string)

DuplicateNameResolution

How duplicate device names are handled.

Type: enum

Default: SKIP_BLOCK_INDEX

Possible Values:

Value Description
ALLOW

Allows duplicate names to be used. When this mode is used, the device generator does not do any checks for duplicate names.

APPEND_INDEX

Appends an integer value to the end of the name to create a unique name.

SKIP_BLOCK_INDEX

Increments the block index until a unique name is found.

GroupAssignmentMode

Group assignment mode.

Type: enum

Default: GROUPS_PER_PORT

Possible Values:

Value Description
ALL_SAME_GROUPS

All devices 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.

Ipv6RouterId

IPv6 router ID

Type: ipv6

Default: 2000::1

Ipv6RouterIdSrc

IPv6 router ID source

Type: enum

Default: MANUAL

Possible Values:

Value Description
MANUAL

Manual

USE_IPV6_GLOBAL_ADDR

Use IPv6 global address

USE_IPV6_LL_ADDR

Use IPv6 link local address

Ipv6RouterIdStep

IPv6 router id step

Type: ipv6

Default: ::1

PortType

Type of port to generate devices 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 devices to return in the preview.

Type: u32

Default: 1000

Range: 1 - 100000

PreviewMaxCountPerIncrementLevel

Maximum number of devices to show in the preview for each increment level (for example, port, VLAN, device, 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 devices in the preview.

PARTIAL

Show a subset of the devices in the preview.

BLOCK

Show all device blocks in the preview.

Role

Role to assign to the devices that are created (for example, Host, Router).

Type: string

Default: "" (empty string)

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)

EmulatedDeviceGenParams Read-Only Attributes

There are no read-only attributes.