StreamBlock Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

A group of one or more streams. This object holds the definition of data plane traffic.

Parents: Port, Project

Children: Aal5, AcceptedReply, AccessAggregationCircuitIdAsciiTlv, AccessAggregationCircuitIdBinaryAtmTlv, AccessAggregationCircuitIdBinaryVlanTlv, AccessLineAttributes, AccessLoopCircuitIdTlv, AccessLoopEncapsulationTlv, AccessLoopRemoteIdTlv, ActualInterleavingDelayDownstreamTlv, ActualInterleavingDelayUpstreamTlv, ActualNetDataRateDownstreamTlv, ActualNetDataRateUpstreamTlv, AddrArrayTLV, AECTlv, AncpOamLoopback, AncpPmMsgHeader, ApplicationPriorityTlv, ARP, ATM, AttainableExpectedThroughputL2Tlv, AttainableExpectedThroughputTlv, AttainableGammaDataRateDownstreamTlv, AttainableGammaDataRateUpstreamTlv, AttainableNetDataRateDownstreamTlv, AttainableNetDataRateUpstreamTlv, AuthenticationTlv, AvtpAudioFormat, BFD, BFDCC, BFDCryptoAuth, BFDCV, BfdHeader, BFDSimpleAuth, BoundStreamFlowTracking, CallBody, CanType, CCM, CDB10, CDB6, CdcpTlv, ChassisIdTlv, CiscoDCE8021adSTag, CiscoDCECiscoStag, CiscoHDLC, CompressedVideoFormat, CongestionNotificationTlv, ControlFrame, ControlWord, CRH16, CRH32, CSF, CtrlChanCapTLV, Custom, CustomRepeat, CustomTlv, CustomTLV, DaId, DataFrame, DataTLV, DcbxTlvt1, DcbxTlvt2, DelayReq, Dhcpclientmsg, Dhcpservermsg, DiaAcc, DiaReq, DMM, DMR, Dpall, Dpl, Dplm, Dpln, DslLineAttributesCustomTlv, DslTypeTlv, ECP, EfpAcc, EfpReq, EightOctetType, ELSFLOGI, ELSFLOGILSACC, ELSLOGO, ELSLOGOLSACC, ELSLSACC, ELSLSRJT, ELSPLOGI, ELSReserved, ELSRSCNAffectedPortIdPages, ELSRSCNREQUEST, ELSSCRREQUEST, ELSSvcAvailabilityAndLoginExtDataLength, EncapEthernet8022, EncapEthernet8023Raw, EncapEthernetII, EncapEthernetIIPbb, EncapEthernetSnap, EncapHeader, EncapMAC-in-MAC, EndTlv, EndTLV, EntropyLabel, EscAcc, EscReq, Ethernet8022, Ethernet8023Raw, EthernetCapTLV, EthernetII, EthernetPause, EthernetSnap, EthernetSSM, ETSConfigurationTlv, ETSRecommendationTlv, EvbTlv, EventNoteOAMPDU, ExpectedThroughputL2DownstreamTlv, ExpectedThroughputL2UpstreamTlv, ExtendedTableModifier, FairnessFrame, FaultMgmtMsg, FC, FCoE, FcoeCapTLV, FCoEHeader, FcpCmnd, FcpCmndDl, FcSofEof, FIP, FlexRayType, Flow, FollowUp, FourOctetType, Fpng, FpngAccept, Ftr, FtrAccept, FxPortClkSyncQos, GACH, GammaDataRateDownstreamTlv, GammaDataRateUpstreamTlv, GaNxtAccept, GapnlAccept, Gatin, GatinAccept, GcsIdAccept, GdidAccept, GestAccept, GffIdAccept, GfnAccept, GfpnIdAccept, GftIdAccept, GidFfAccept, GidFpnAccept, GidFpnRequest, GidFtAccept, GidNnAccept, GidPnAccept, GidPtAccept, GieilAccept, Giel, GielAccept, GielnAccept, GietAccept, GmalAccept, GmidAccept, Gnid, GnidAccept, GnnFfAccept, GnnFtAccept, GnnIdAccept, Gnpl, GnplAccept, GpabAccept, GpfcpAccept, GplAccept, GpliAccept, GplmlAccept, GplnlAccept, GpltAccept, GpnFfAccept, GpnFtAccept, GpnIdAccept, Gpnl, GpnlAccept, GpnSdfcpAccept, GpnSdfcpRequest, GppnAccept, GppnIdAccept, GpsAccept, GpscAccept, GptAccept, GptIdAccept, Gre, GsAccept, GsDeregisterWithPlatformName, GsesAccept, GsnnNnAccept, GspnIdAccept, GsReject, GsRequestWithBasicCtIuPreamble, GsRequestWithFc4FeaturesAndFc4Type, GsRequestWithFc4Type, GsRequestWithInterconnectElementName, GsRequestWithNodeName, GsRequestWithPlatformName, GsRequestWithPortIdentifier, GsRequestWithPortName, GsRequestWithPortType, Gtin, GtinAccept, GTPv1, GTPv1Ext, GTPv1ExtHdr, GTPv1Opt, GzcAccept, HloReq, IcmpDestUnreach, IcmpEchoReply, IcmpEchoRequest, IcmpInfoReply, IcmpInfoRequest, IcmpMaskReply, IcmpMaskRequest, IcmpParameterProblem, IcmpRedirect, IcmpRouterAdvertisement, IcmpRouterSolicitation, IcmpSourceQuench, IcmpTimeExceeded, IcmpTimestampReply, IcmpTimestampRequest, Icmpv6DestUnreach, Icmpv6EchoReply, Icmpv6EchoRequest, Icmpv6PacketTooBig, Icmpv6ParameterProblem, Icmpv6TimeExceeded, IdleFrame, IEC_61883_IIDC, Igmpv1, Igmpv2, Igmpv2Query, Igmpv2Report, Igmpv3Query, Igmpv3Report, InfoOAMPDU, IntStat, IP, IPv4, Ipv4SrcAddrTlv, IPv6, Ipv6AuthenticationHeader, Ipv6DestinationHeader, Ipv6EncapsulationHeader, Ipv6FragmentHeader, Ipv6HopByHopHeader, IPv6LL, Ipv6RoutingHeader, Ipv6SrcAddrTlv, iTag, L2TPv2, L2TPv3, LACP, LBM, LBR, LinkAggregationTlv, LinType, Lisp, LispControlEncapsulatHeader, LispMapRegister, LispMapReply, LispMapRequest, LlcBridgedEth8023, LlcRoutedNlpid, LlcRoutedSnap, LlcSnapIana, LMM, LMR, LoopbackControlOAMPDU, LsaReq, LspPing, LspReply, LspRequest, LsuReq, LTM, LTMEgrID, LTR, LTREgrID, MacControl, MAC-in-MAC, MacPhyConfigStatusTlv, ManagementAddrTlv, Marker, MaxFrameSizeTlv, MaximumInterleavingDelayDownstreamTlv, MaximumInterleavingDelayUpstreamTlv, MaximumNetDataRateDownstreamTlv, MaximumNetDataRateUpstreamTlv, MepLspTlv, MepPwTlv, MepSectionTlv, MinimumNetDataRateDownstreamTlv, MinimumNetDataRateUpstreamTlv, MinimumNetLowPowerDataRateDownstreamTlv, MinimumNetLowPowerDataRateUpstreamTlv, MismatchInfo, MLDv1, MLDv2Query, MLDv2Report, ModeSense10, ModeSense6, MostType, Mpls, MplsTpOAMAIS, MplsTpOAMCCM, MplsTpOAMCSF, MplsTpOAMDMM, MplsTpOAMDMR, MplsTpOAMLBM, MplsTpOAMLBR, MplsTpOAMLCK, MplsTpOAMLMM, MplsTpOAMLMR, MplsTpOAMTST, MReq, MReqAcc, MsgTypeArrayTLV, NeighborAdvertisement, NeighborSolicitation, NivSupportTlv, NPortClkSyncQos, NTSCF, NullTlv, OneOctetType, ONUAssuredDataRateUpstreamTlv, ONUAverageDataRateDownstreamTlv, ONUMaximumDataRateUpstreamTlv, ONUPeakDataRateDownstreamTlv, OrganizationallySpecificTlv, OrgSpec, OrgSpecOAMPDU, Ospfv2DatabaseDescription, Ospfv2Hello, Ospfv2LinkStateAcknowledge, Ospfv2LinkStateRequest, Ospfv2LinkStateUpdate, Ospfv2Unknown, PathDescriptor, PauseMacControl, PbbTeMip, PFC, Pimv4Assert, Pimv4Hello, Pimv4JoinPrune, Pimv4NullRegister, Pimv4Register, Pimv4RegisterStop, Pimv6Assert, Pimv6Hello, Pimv6JoinPrune, Pimv6Register, Pimv6RegisterStop, PonAccessTypeTlv, PONTreeMaximumDataRateDownstreamTlv, PONTreeMaximumDataRateUpstreamTlv, PortAndProtocolVlanIdTlv, PortDescriptionTlv, PortIdTlv, PortVlanIdTlv, POS, PowerViaMdiTlv, PPP, PPPoEDiscovery, PPPoESession, PreviewData, PriorityBasedFlowControlTlv, ProtocolIdentityTlv, ProvisioningInfoTLV, PrtStat, PseudowireStatusMsg, PTPSignaling, QlTlv, RandomModifier, RangeModifier, R-APS, RARP, RawStreamFlowTracking, RcsId, Rdi, Read10, Read6, ReadBuffer, ReadCapacity10, ReadLong10, Redirect, RejectedReply, RejectedReplyAuthStat, ReplyBody, ReportLUNs, ReservedTLV99, ReservedTLV9A, ResourceLimitCapTLV, RffId, RftId, Rieln, Ripng, Ripv1, Ripv2, RnnId, RouterAdvertisement, RouterSolicitation, Rpab, RpcMsg, Rpfcp, Rpl, Rpli, Rplm, Rpln, Rplt, RplyEgr, RplyIng, RpnId, RptId, RsnnNn, RspnId, RtpHeader, Sctp, SLM, SLR, SndrID, SrHeader, StartStopUnit, StreamCollectionListModifier, StreamCollectionRangeModifier, Sync, SystemCapabilitiesTlv, SystemDescriptionTlv, SystemNameTlv, TableModifier, Tcp, TestIdTLV, TestTLV, ThreeOctetType, Timestamp, TimeToLiveTlv, TrafficPathInfo, TRILL, TSCF, TwampServerGreeting, TwoOctetType, Udp, VariableRequestOAMPDU, VariableResponseOAMPDU, VcMuxBridgedEth8023, VdpAssociationTlv, VdpManagerIdTlv, Verify10, VFT, VifIdTLV, VifStateTLV, VlanNameTlv, VxLAN, Write10, Write6, WriteAndVerify10, WriteBuffer, WriteLong10, XDRead10, XDWrite10, XPWrite10

Result children (automatically created): RxStreamBlockResults, RxStreamSummaryResults, TxStreamBlockResults, TxStreamResults

Relations:

Side name
(Type)		 Relative Description
Ieee80211ClientConfig
(AffiliatedStreamBlockClient)

Ieee80211ClientConfig

AffiliationAnalyzerPreloadProfile
(AffiliationAnalyzerPreloadStreamBlock)

AnalyzerPreloadProfile

AffiliationCustomFillPattern
(AffiliationCustomFillPattern)

CustomFillPattern

AffiliationFrameLengthDistribution
(AffiliationFrameLengthDistribution)

FrameLengthDistribution

AffiliationHighResolutionStreamBlockConfig
(AffiliationHighResolutionStreamBlock)

HighResolutionSamplingStreamBlockConfig

ManualScheduleEntry
(AffiliationManualScheduleEntryStreamBlock)

ManualScheduleEntry

AffiliationProjectStreamBlock
(AffiliationStreamBlock)

StreamBlock

Internal use only.
AffiliationStreamBlockDevice
(AffiliationStreamBlockDevice)

EmulatedDevice

AffiliationStreamBlockLoadProfile
(AffiliationStreamBlockLoadProfile)

Stream block to which load profile binds.
AffiliationTrafficGroup
(AffiliationTrafficGroup)

TrafficGroup

Traffic group to which stream block belongs.
AudioRtcpStreamBlockParent
(AudioRtcpStreamBlock)

SipUaProtocolConfig

AudioStreamBlockParent
(AudioStreamBlock)

SipUaProtocolConfig

SbParent
(BfdStreamBlock)

BfdIpv4ControlPlaneIndependentSession, BfdIpv6ControlPlaneIndependentSession, BfdRouterConfig, Ieee1588v2ClockConfig, Ieee8021asClockConfig

Rfc5180Config
(CoexistingStreamBlockBinding)

Rfc5180Config

ContainerResultChild
(ContainerResult)

RxTrafficGroupResults, TxTrafficGroupResults

General-purpose relation for result objects. For example, RxTrafficGroupResults objects are linked to the StreamBlock object with this relation.
DstBinding
(DstBinding)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies destination endpoints bound to StreamBlock.
MaintenancePoint
(EoamMpToStreamBlock)

EoamMaintenancePointConfig

ExpectedRxPort
(ExpectedRx)

Port

Expected receive port for this stream block. All the receive ports in the relation are expected to receive all the packets from this stream block. A stream block with no expected port relation configured means any port is expected to receive packets. If you configure source/destination binding, they will override the ExpectedRxPort relation.
MacGroup
(MacGroupBinding)

MacGroup

Config
(MulticastStreamBlockBinding)

DcbErroredFramesFilteringTestCaseConfig, Rfc3918Config

OpenflowTrafficSource
(OpenflowTraffic)

OpenflowFlowBlock

RedundancyDuplicate
(RedundancyPrimaryDuplicate)

StreamBlock

TSN Redundancy primary duplicate relation
ResultChild
(ResultChild)

RxStreamBlockResults, RxStreamSummaryResults, TxStreamBlockResults, TxStreamResults

Use this to connect a results object to an object.
SrcBinding
(SrcBinding)

Aal5If, Dhcpv4ServerDefaultPoolConfig, Dhcpv4ServerPoolConfig, Dhcpv6ServerAddrPoolConfig, Dhcpv6ServerDefaultAddrPoolConfig, Dhcpv6ServerDefaultPrefixPoolConfig, Dhcpv6ServerPrefixPoolConfig, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv4NetworkBlock, Ipv4VpnMcastNetworkBlock, Ipv6If, Ipv6NetworkBlock, Ipv6SrhIf, Ipv6VpnMcastNetworkBlock, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacBlock, MacsecIf, MplsIf, Pimv4JoinSrc, Pimv4PruneSrc, Pimv6JoinSrc, Pimv6PruneSrc, PppIf, PppoeIf, PppoeServerIpv4PeerPool, PppoxServerIpv4PeerPool, PppoxServerIpv6PeerPool, TrillIf, VbrasIf, VlanBlock, VlanIf, VxlanGpeIf, VxlanIf

Specifies the source endpoint bound to StreamBlock.
TrafficDescriptorStreamBlockSrc
(StreamBlockBinding)

TrafficDescriptor

Information associated with pairs of source and destination end points bound to the stream block.
Profile
(StreamBlockBinding)

Rfc2544BackToBackFramesProfile, Rfc2544FrameLossProfile, Rfc2544LatencyProfile, Rfc2544ThroughputProfile

TestCaseConfig
(UnicastStreamBlockBinding)

Rfc3918MixedClassThroughputTestCaseConfig

VideoRtcpStreamBlockParent
(VideoRtcpStreamBlock)

SipUaProtocolConfig

VideoStreamBlockParent
(VideoStreamBlock)

SipUaProtocolConfig

StreamBlock Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AdvancedInterleavingGroup

Group ID of stream blocks. Applicable to rate based scheduler, advanced interleaving mode only.

Type: u8

Default: 0
AllowInvalidHeaders

Used to allow FrameConfig to contain an invalid header.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

FrameConfig can contains invalid headers.
FALSE

FrameConfig cannot contains invalid headers.
BurstSize

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the BurstSize attribute on the StreamBlockLoadProfile object.

Burst size applied to all streams in the stream block when in priority-based scheduling mode.

Type: u16

Default: 1
ByPassSimpleIpSubnetChecking

Whether subnet checking will be bypassed for bound stream block if source and destination endpoints are both Ethernet/IP.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Bypass subnet check.
FALSE

Do not bypass subnet check.
CompressedMultiPathLearning

When Per Device Learning is enabled and the source device blocks of multiple paths connect to DUT via the same learning device block, this property controls if each learning device requests MAC address only once for these paths

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

A device requests MAC address only once when it is in multiple paths.
FALSE

A device requests MAC address multiple times when it is in multiple paths, once for each path.
ConstantFillPattern

Value for a constant fill pattern when fill pattern type is not PRBS.

Type: u16

Default: 0
CustomPfcPriority

Specifies the priority for the custom PFC of this StreamBlock.

Type: u8

Default: 0

Range: 0 - 7
Enable8023brMFrame

Flag to control if customer will insert their own FCS.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Allow user to insert their own FCS.

FALSE

User is not allowed to insert their own FCS.

EnableBackBoneTrafficSendToSelf

Whether the endpoint will send traffic to itself in a backbone traffic pattern.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Allow backbone traffic send to self endpoint.
FALSE

Disallow backbone traffic send to self endpoint.
EnableBidirectionalTraffic

Direction of traffic flow between two end points (for project-level stream block only).

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Traffic flow in both directions.
FALSE

Traffic flow from source to destination only.
EnableControlPlane

Enable/disable control plane traffic, such as Ping and ARP.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable control plane traffic.
FALSE

Disable control plane traffic.
EnableCustomPfc

Flag to enable the Custom PFC of this StreamBlock.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Custom PFC of this streamblock is enabled.

FALSE

Custom PFC of this streamblock is disabled.

EnableFcsErrorInsertion

Whether to insert FCS error in the frames.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Insert FCS error in the frames.
FALSE

Do not insert FCS error in the frames.
EnableHighSpeedResultAnalysis

Whether this stream block is involved in high speed result analysis.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Used as high speed result analysis.
FALSE

Use normal result analysis.
EnableResolveDestMacAddress

Flag to indicate if the gateway MAC address needs to be resolved for this streamblock.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable resolve destination MAC address.
FALSE

Disable resolve destination MAC address.
EnableStreamOnlyGeneration

Whether to use streams or VFDs (Variable Field Definitions) to generate traffic between end points.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Use streams to generate traffic.
FALSE

Use VFDs to generate traffic.
EnableTxPortSendingTrafficToSelf

Enable/disable transmit port sending traffic to itself.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable transmit port sending traffic to itself.
FALSE

Disable transmit port sending traffic to itself.
EndpointMapping

Mapping between network end points within interface blocks.

Type: enum

Default: ONE_TO_ONE

Possible Values:

Value Description
ONE_TO_ONE

One source end point to one destination end point.
ONE_TO_MANY

One source end point to many destination end points.
FillType

Fill pattern type to be used for the payload.

Type: enum

Default: CONSTANT

Possible Values:

Value Description
CONSTANT

Use fixed fill pattern.
INCR

Use incrementing value to fill the rest of the frame. The step value is 1. The starting value is specified by ConstantFillPattern.
DECR

Use decrementing value to fill the rest of the frame. The step value is 1. The starting value is specified by ConstantFillPattern.
PRBS

Use a pseudo-random bit sequence to fill the rest of the frame. The PRBS pattern is shared across streams that use the PRBS as the fill pattern.

Note: This option requires that you set the InsertSig attribute to true.
INCRWORD

Used to increment a WORD value to fill the rest of the frame. The step value is 1. The starting value is specified by ConstantFillPattern.
DECRWORD

Used to decrement a WORD value to fill the rest of the frame. The step value is 1. The starting value is specified by ConstantFillPattern.
CUSTOM

Used to generate custom patterns. Fills entire payload with the custom pattern to a maximum of 256-bytes.

Filter

Used by the GUI to store the currently selected filter.

Type: string

Default: "" (empty string)

FixedFrameLength

Fixed value for frame length.

Note: 10 gigabit Ethernet range is 56-16383; POS range is 48-16383; range for all others is 12-16383.

Type: u16

Default: 128

Range: 12 - 16383
FrameConfig

PDU XML configuration for the frame header of the stream block.

Type: string

Default: <frame><config><pdus><pdu name=\"eth1\" pdu=\"ethernet:EthernetII\" /><pdu name=\"ip_1\" pdu=\"ipv4:IPv4\" /></pdus></config></frame>
FrameLengthMode

Frame length mode used by this stream block.

Type: enum

Default: FIXED

Possible Values:

Value Description
FIXED

Frame length is fixed for all frames.
INCR

Frame length is incrementing.
DECR

Frame length is decrementing.
IMIX

Use multiple frame lengths as defined by a FrameLengthDistribution object. The StreamBlock object must be associated with the FrameLengthDistribution object using an AffiliationFrameLengthDistribution relation.
RANDOM

Frame length is random.
AUTO

Frame length is automatically set based on the PDU configuration.
InsertFcs

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

FALSE

InsertSig

Whether to insert the Spirent signature in traffic.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Insert Spirent signature.
FALSE

Do not insert Spirent signature.
InterFrameGap

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the InterFrameGap attribute on the StreamBlockLoadProfile object.

Gap (bytes) between frames in the same burst, when the burst size is greater than 1 (only when in priority-based scheduling mode).

Type: u32

Default: 12
Load

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the Load attribute on the StreamBlockLoadProfile object.

Load value set on the stream block. Load has different meanings, based on load unit.

Type: double

Default: 10
LoadUnit

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the LoadUnit attribute on the StreamBlockLoadProfile object.

Load unit applied to the stream block.

Type: enum

Default: PERCENT_LINE_RATE

Possible Values:

Value Description
PERCENT_LINE_RATE

Load as percentage of line rate.
FRAMES_PER_SECOND

Load as the number of frames per second.
INTER_BURST_GAP

Load as the gap in bytes between adjacent bursts.
BITS_PER_SECOND

Load as the number of bits per second.
KILOBITS_PER_SECOND

Load as the number of kilobits per second.
MEGABITS_PER_SECOND

Load as the number of megabits per second.
INTER_BURST_GAP_IN_MILLISECONDS

Load as the gap in milliseconds between adjacent bursts.
INTER_BURST_GAP_IN_NANOSECONDS

Load as the gap in nanoseconds between adjacent bursts.
L2_RATE

Load as the number of layer 2 bits per second.
MaxFrameLength

Maximum frame length for random mode.

Note: 10 Gigabit Ethernet range is 56-16383; POS range is 48-16383; range for all others is 12-16383.

Type: u16

Default: 256

Range: 12 - 16383
MinFrameLength

Minimum frame length for random mode.

Note: 10 Gigabit Ethernet range is 56-16383; POS range is 48-16383; range for all others is 12-16383.

Type: u16

Default: 128

Range: 12 - 16383
PerDeviceLearning

This property controls if ARP/ND is enabled on each device of the learning device block connected with DUT when stream only generation is not enabled for a stream block

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

ARP/ND is enabled on each device of the learning device block connected with DUT when stream only generation is not enabled.
FALSE

ARP/ND is enabled on the first device of the learning device block connected with DUT when stream only generation is not enabled.
Priority

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the Priority attribute on the StreamBlockLoadProfile object.

Scheduling priority of the stream block in priority-based mode.

Type: u8

Default: 0
ShowAllHeaders

Used to indicate if the FrameConfig contains all the headers including header for bound endpoint.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Frameconfig contains all the headers including header for bound endpoint.
FALSE

Frameconfig does not contain all the headers including header for bound endpoint.
StartDelay

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the StartDelay attribute on the StreamBlockLoadProfile object.

Delay (in bytes) for starting the first frame of stream block when in priority-based scheduling mode.

Type: u32

Default: 0
StepFrameLength

Step frame length for increment and decrement modes (must be in powers of 2).

Type: u16

Default: 1

Range: 1 - 8192
TimeStampOffset

Specifies the offset for the user inserted TimeStamp of this StreamBlock.

Type: u16

Default: 0
TimeStampType

Specifies the type for the user inserted TimeStamp of this StreamBlock.

Type: enum

Default: MIN

Possible Values:

Value Description
MIN

TimeStamp Type is MIN.

IEEE_1588

TimeStamp Type is IEEE_1588.

GM

TimeStamp Type is GM.

AVTP

TimeStamp Type is AVTP.

MAX

TimeStamp Type is MAX.

TrafficPattern

Traffic pattern between end points.

Type: enum

Default: PAIR

Possible Values:

Value Description
PAIR

Traffic is transmitted between one or more port pairs, either uni- or bi-directionally.
MESH

Traffic is transmitted from every port to every other port (for project-level stream block only).
BACKBONE

Traffic is transmitted in a partially meshed pattern, either uni- or bi-directionally.
UseGwMacAsDestMac

Used to indicate if Use Gateway MAC as Dest MAC for bound stream if src and dst are both ethernet/ip stack, this has to enable Use gateway as the ARP target.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use Gateway MAC as Dest MAC for bound stream if src and dst are both ethernet/ip stack.
FALSE

Not Use Gateway MAC as Dest MAC for bound stream if src and dst are both ethernet/ip stack.

StreamBlock Read-Only Attributes

Read-Only Attribute Description
BpsLoad

Load value as the number of bits per second.

Type: double

Default: 100000000
ControlledBy

Read-only property to indicate by which daemon the stream block is generated and controlled.

Type: string

Default: generator
FlowCount

Number of flows in this stream block.

Type: u32

Default: 0
FpsLoad

Load value as the number of frames per second.

Type: double

Default: 84459
IbgInMillisecondsLoad

Load value as the gap (in milliseconds) between adjacent bursts.

Type: double

Default: 1344
IbgInNanosecondsLoad

Load value as the gap (in nanoseconds) between adjacent bursts.

Type: double

Default: 1344
IbgLoad

Load value as the gap (in bytes) between adjacent bursts.

Type: double

Default: 1344
IsArpResolved

Whether ARP is resolved for this stream block.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

ARP is resolved.
FALSE

ARP is unresolved.
KbpsLoad

Load value as the number of kilobits per second.

Type: double

Default: 100000
L2Rate

Layer 2 bit rate.

Type: double

Default: 100000000
MbpsLoad

Load value as the number of megabits per second.

Type: double

Default: 100
PathCount

The path number of this StreamBlock

Type: u32

Default: 0
PduInfo

Strings containing PDU information. The format is "PDU Name, String Handle, Object Handle, Indexed Name".

Type: string

Default: "" (empty string)

PercentageLoad

Load value as percentage of line rate.

Type: double

Default: 10
RedundancyTagType

TSN redundancy tag type

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

No tag
RTAG

R-TAG (802.1CB)
HSRTAG

HSR sequence tag (IEC 62439)
PRPTAG

PRP trailer tag (IEC 62439-3)
RunningState

Whether frames are being transmitted using the stream block.

Type: enum

Default: STOPPED

Possible Values:

Value Description
STOPPED

Frames defined by the stream block are not being transmitted.
RUNNING

Frames defined by the stream block are being transmitted.
PENDING_START

Frames defined by the stream block are getting ready to be transmitted.
PENDING_STOP

Frames defined by the stream block are getting ready to stop being transmitted.
State

Whether traffic can be generated using the stream block.

Type: enum

Default: READY

Possible Values:

Value Description
READY

Ready to transmit.
NEED_RESOLVE

Need to resolve before transmit.
RESOLVING

In resolving.

Status

Description of the stream block's condition.

Type: string

Default: None
StreamBlockIndex

Stream block index corresponding to this stream block (only applicable to port-level stream block).

Type: u32

Default: 0
StreamCount

Number of streams in this stream block.

Type: u32

Default: 0
StreamIndex

Stream indexes corresponding to this stream block (only applicable to port-level stream block). This set of values is read only, because the stream indexes are assigned by firmware.

Type: u32

Default: 0
TrackableFlowCount

Trackable flow count

Type: u32

Default: 0