DeviceCreateCommand Object


Description:

Creates a router or host or other device.

Can be used with Command Sequencer: No

Parents: Sequencer

DeviceCreateCommand Writable Attributes

Attribute Description
AffiliatedDevice

Directly Connected Router Handle.

Type: handle

Default: 0

CreateClassId

Class ID of the object to be created. (This parameter is ignored).

Type: classId

Default: 0

CreateCount

Number of device objects to be created.

Type: u32

Default: 1

DeviceCount

Number of devices to be represented by this object. Use 1 for router and N for host.

Type: u32

Default: 1

DeviceRole

Device Role.

Type: string

Default: "" (empty string)

DeviceTags

Device Tags.

Type: string

Default: "" (empty string)

DeviceType

String representing the device type to create - router or host.

Type: string

Default: Router

IfCount

Interface block count for each of the elements specified in the IfStack attribute. Must have the same list count as the IfStack attribute.

Type: u32

Default: 1

IfStack

Interface stack to be added to the device.

Use a list of strings, such as Ipv4If, EthIIIf, and so on, in appropriate order.

Type: string

Default: "" (empty string)

LoopbackIf

Whether the specified interface stack refers to a loopback interface.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Interface stack refers to a loopback interface.

FALSE

Interface stack does not refer to a loopback interface.

ParentList

Parent project under which the device needs to be created. Only a single parent project can be specified.

Type: handle

Default: 0

Port

Logical port to which this device is affiliated.

Type: handle

Default: 0

DeviceCreateCommand Read-Only Attributes

Read-Only Attribute Description
ReturnList

Handles of created devices.

Type: handle

Default: 0