TrafficDescriptor Object

Description:

Traffic descriptor configuration.

Writable Attributes
Read-Only Attributes

Parents: TrafficDescriptorGroup

Result children (automatically created): TrafficDescriptorResult

Relations:

Side name (Type)	Relative	Description
DstBinding (DstBinding)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, Port, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Specifies destination endpoints bound to StreamBlock.
AllocatedHosts (HostBinding)	EmulatedDevice	Relation describing the hosts allocated to the traffic descriptor.
MonitorPorts (MonitorPortBinding)	Port	Link to ports acting as monitor ports for test.
ResultChild (ResultChild)	TrafficDescriptorResult	Use this to connect a results object to an object.
SrcBinding (SrcBinding)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, Port, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Specifies the source endpoint bound to StreamBlock.
AllocatedStreamBlocks (StreamBlockBinding)	StreamBlock	Describes the stream block allocated to the traffic descriptor.

TrafficDescriptor Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

DeviceCount

Host device count.

Type: u32

Default: 1

EnableBidirectionalTraffic

Whether traffic is bidirectional.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Traffic is bidirectional.
FALSE	Traffic is unidirectional (one-way).

EnableIpv4

Whether to enable IPv4.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	IPv4 is enabled.
FALSE	IPv4 is disabled.

EnableIpv6

Whether to enable IPv6.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	IPv6 is enabled.
FALSE	IPv6 is disabled.

EnableMapToVlanPriority

Whether to enable the application to enable the VlanPriorityList.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable the VLAN priority list.
FALSE	Disable the VLAN priority list.

EnableStreamOnlyGeneration

Whether to use stream to simulate the traffic between source and destination endpoints.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use stream for flow.
FALSE	Do not use stream for flow.

EnableTxPortSendingTrafficToSelf

Flag to allow the transmitting port to send traffic to itself.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Allow transmitting port to send traffic to itself.
FALSE	Do not allow transmitting port to send traffic to itself.

EnableVlan

Whether using VLANs is enabled.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	VLANs are enabled.
FALSE	VLANs are disabled.

EndpointCreation

Specifies using existing or creating new endpoints.

Type: enum

Default: USE_EXISTING_ENDPOINTS

Possible Values:

Value	Description
USE_EXISTING_ENDPOINTS	Use existing endpoints.
CREATE_NEW_ENDPOINTS	Create new endpoints.

EndpointMapping

Mapping between source and destination endpoints.

Type: enum

Default: ONE_TO_ONE

Possible Values:

Value	Description
ONE_TO_ONE	Endpoint mapping is one-to-one.
ONE_TO_MANY	Endpoint mapping is one-to-many.

EtherType

EtherType value in Ethernet II header.

Type: enum

Default: EXPERIMENTAL

Possible Values:

Value	Description
ARP	ARP
CHAOSNET	CHAOSNET
Custom	CUSTOM
DLOG	DLOG
DLOG2	DLOG2
ECMA_INTERNET	ECMA INTERNET
EXPERIMENTAL	EXPERIMENTAL
FCOE	FCOE
FRAME_RELAY_ARP	FRAME RELAY ARP
HOMEPLUG	HOMEPLUG
IPV4	IPv4
IPV6	IPv6
MPLS_MULTICAST	MPLS Multicast
MPLS_UNICAST	MPLS Unicast
NBS_INTERNET	NBS Internet
NIXDORF	NIXDORF
PPP	PPP
PPPOE_DISCOVERY	PPPoE discovery
PPPOE_SESSION	PPPoE session
PUP_ADDR_TRANS	PUP address translation
RARP	RARP
VLAN	VLAN
X25_LEVEL3	X25 Level3
X75_INTERNET	X75 Internet
XEROX_NS_IDP	XEROX NS IDP
XEROX_PUP	XEROX PUP
XNS_COMPATIBILITY	XNS COMPATIBILITY

EthIfStep

Ethernet interface step amount.

Type: mac

Default: 00:00:00:00:00:01

EthIfStepMask

Ethernet interface mask.

Type: mac

Default: 00:00:FF:FF:FF:FF

IpsNextProtocolDstPortBase

Base value for the destination port number for the selected IPS next protocol header. The destination port values start from the base value and increment by the step value for the value specified as the count value.

Type: u16

Default: 7

Range: 0 - 65535

IpsNextProtocolDstPortCount

Count value for the destination port number for the selected IPS next protocol header. The destination port values start from the base value and increment by the step value for the value specified as the count value.

Type: u16

Default: 1

Range: 1 - 65535

IpsNextProtocolDstPortStep

Step value for the destination port number for the selected IPS next protocol header. The destination port values start from the base value and increment by the step value for the value specified as the count value.

Type: u16

Default: 1

Range: 0 - 65535

IpsNextProtocolList

List of IPS next protocol header.

Type: string

Default: 0

IpsNextProtocolSrcPortBase

Base value for the source port number for the selected IPS next protocol header. The source port values start from the base value and increment by the step value for the value specified as the count value.

Type: u16

Default: 7

Range: 0 - 65535

IpsNextProtocolSrcPortCount

Count value for the source port number for the selected IPS next protocol header. The source port values start from the base value and increment by the step value for the value specified as the count value.

Type: u16

Default: 1

Range: 1 - 65535

IpsNextProtocolSrcPortStep

Step value for the source port number for the selected IPS next protocol header. The source port values start from the base value and increment by the step value for the value specified as the count value.

Type: u16

Default: 1

Range: 0 - 65535

IpsNextProtocolUseRandomPorts

Flag to use random port numbers for the selected IPS next protocol header.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use random port numbers for the selected IPS next protocol header.
FALSE	Do not use random port numbers for the selected IPS next protocol header.

IpsNextTcpUdpDestPortList

List of TCP/UDP destination ports for the IPS next protocol header.

Type: string

Default: 0

IpsNextTcpUdpSrcPortList

IPs next TCP/UDP source port list.

Type: string

Default: 0

Ipv4AddrDest

IPv4 address of the destination endpoint.

Type: ip

Default: 192.086.001.002

Ipv4AddrSrc

IPv4 address of the source endpoint.

Type: ip

Default: 192.085.001.002

Ipv4AddrStart

Starting IPv4 address for the emulated hosts under the emulated home gateways.

Type: ip

Default: 192.85.1.2

Ipv4AddrStep

Step value for the generated IPv4 addresses for the emulated hosts.

Type: ip

Default: 1.0.0.0

Ipv4GatewayAddrStart

Starting IPv4 address for the emulated home gateways.

Type: ip

Default: 192.085.001.001

Ipv4GatewayAddrStep

Step value for the generated IPv4 addresses for the emulated gateways.

Type: ip

Default: 001.000.000.000

Ipv4IfStep

IPv4 interface step value.

Type: ip

Default: 0.0.0.1

Ipv4IfStepMask

Mask value to be applied to the IPv4 address when stepping over it.

Type: ip

Default: 0.0.0.255

Ipv4PrefixLength

IPv4 prefix length in bits. Identifies the network portion of the IP address.

Type: u8

Default: 24

Range: 1 - 32

Ipv6AddrDest

IPv6 address of the destination endpoint.

Type: ipv6

Default: 2000:1::2:2

Ipv6AddrSrc

IPv6 address of the source endpoint.

Type: ipv6

Default: 2000:1::1:2

Ipv6AddrStart

Starting IPv6 address for the emulated hosts under emulated home gateways.

Type: ipv6

Default: 2000::2

Ipv6AddrStep

Step value for the generated IPv6 addresses for the emulated hosts.

Type: ipv6

Default: 0:0:1::

Ipv6GatewayAddrStart

Starting IPv6 address for the emulated home gateways.

Type: ipv6

Default: 2000::1

Ipv6GatewayAddrStep

Step value for the generated IPv6 addresses for the emulated gateways.

Type: ipv6

Default: 0:0:1::

Ipv6IfStep

Step value to increment the IPv6 address by.

Type: ipv6

Default: 0000::1

Ipv6IfStepMask

Mask value to be applied to the IPv6 address when stepping over it.

Type: ipv6

Default: 0000::FFFF:FFFF:FFFF:FFFF

Ipv6PrefixLength

IPv6 prefix length in bits. Identifies the network portion of the IP address.

Type: u8

Default: 64

Range: 1 - 128

MacAddrStart

Starting MAC address for the emulated hosts under the emulated home gateways.

Type: mac

Default: 00:10:94:00:00:01

MacAddrStep

Step value for the generated MAC addresses for the emulated hosts.

Type: mac

Default: 00:00:01:00:00:00

QosDiffservList

List of QoS Diffserv parameters.

Type: string

Default: 0

TrafficPattern

Traffic pattern type.

Type: enum

Default: PAIR

Possible Values:

Value	Description
PAIR	Source and destination pair.
MESH	Mesh traffic topology.
BACKBONE	Traffic on a backbone.
BROADCAST	Broadcast traffic.
CONGESTION	Tx1, Tx2, uncongested Rx, congested Rx.
LEARNING	Tx port, Rx port, monitor port.
MICROBURST	Unidirectional traffic with congested Rx.
HOLB	HOLB Traffic.
INCAST	INCAST Traffic.
BUFFER	BUFFER Traffic.

Ttl

Time to live value.

Type: u8

Default: 10

Range: 0 - 255

VlanIfStep

Step value to increment the VLAN interface by.

Type: u16

Default: 1

VlanPriority

Single VLAN priority for 2889 test.

Type: u8

Default: 7

Range: 0 - 7

VlanPriorityList

List of VLAN priorities.

Type: u8

Default: 0

VlanStart

Initial VLAN.

Type: u16

Default: 1

Range: 1 - 4095

VlanStep

Step VLAN to increment BaseVlan by.

Type: u16

Default: 1

Range: 0 - 4095

TrafficDescriptor Read-Only Attributes

There are no read-only attributes.