HostGenParams Object


Description:

Defines parameters for generating Host 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 hosts on.

HostGenParams Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
BlockMode

Host objects may be used to represent a single host or a block of many hosts for higher scalability. Host blocks are not supported by all 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 Host block is created for each host.

ONE_DEVICE_PER_BLOCK

One Host block is created for each host.

ONE_NETWORK_PER_BLOCK

One Host block is created for each network.

MULTIPLE_NETWORKS_PER_BLOCK

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

MULTIPLE_DEVICE_PER_BLOCK

Multiple devices per block

Count

Number of Hosts 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 hosts 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 hosts 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 Hosts to return in the preview.

Type: u32

Default: 1000

Range: 1 - 100000

PreviewMaxCountPerIncrementLevel

Maximum number of hosts 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 hosts in the preview.

PARTIAL

Show a subset of the hosts in the preview.

BLOCK

Show all host blocks in the preview.

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)

HostGenParams Read-Only Attributes

There are no read-only attributes.