IptvStartTestCommand Object


Description:

Start the configured IPTV test on the specified blocks of STBs.

Can be used with Command Sequencer: Yes

GUI Command Name: IPTV: Start Test

Parents: Project, Sequencer, StcSystem

IptvStartTestCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AddToIterationResults

Adds IPTV results database into the iteration results database.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

If true, the IPTV database is moved and added into the iteration results database, if the Save Iteration Results command is present. (Sequencer only.)

FALSE

If false, the IPTV database is not added into the iteration results database and instead resides at its normal location.

DatabaseFileName

File name for the end-of-test (EOT) database in which results are stored. The file name is only applicable for interactive tests. For tests run via the command sequencer, an automatically generated file name will be used.

Type: outputFilePath

Default: iptvTest.db

ExtHdrCheckEnable

Enable extension header validation.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Check extension header.

FALSE

Do not check extension header.

ExtHdrCheckPatternPeriod

This period will define the frequency that the header field pattern, which is to be checked against the contents of the first unicast packet, is present in the Spirent TestCenter-generated channel stream. The period shall be represented by a number N, such that the frequency of the pattern in the stream is 1 in N packets.

Type: u32

Default: 10

InterStbStartDelayStep

Start delay (in msec) for the blocks of STB.

Type: u32

Default: 0

JoinFailPercentageThreshold

A percentage. If the number of failed Joins divided by the total number of channel changes is greater than this percentage, then the IPTV test event in the Event Scheduler fails. A failed Join occurs when a Join message is sent and the corresponding channel data is not received within a certain time period. (Set this percentage to 100 for the event to pass regardless of the number of failed Joins.)

Type: u32

Default: 100

Range: 0 - 100

MaxSbitDelay

Defines the latest time to check for the presence of the Sbit in the unicast stream.

Type: u32

Default: 2000

MinSbitDelay

Defines the earliest time to check for the presence of the Sbit in the unicast stream.

Type: u32

Default: 0

MulticastJoinTrigger

The event that begins the countdown until the multicast Join will be performed.

Type: enum

Default: UNICAST_JOIN_AND_DELAY

Possible Values:

Value Description
UNICAST_JOIN_AND_DELAY

If the "Unicast Join + Delay" multicast Join trigger is selected for a FCC test, the multicast Join message for a channel shall be transmitted after a multicast Join trigger delay following the transmission of the corresponding unicast Join message.

SBIT_AND_DELAY

If the "S-Bit + Delay" multicast Join trigger is selected for a FCC test, the multicast Join message for a channel shall be transmitted after a multicast Join trigger delay following the receipt of the first unicast packet with the S-bit set for the corresponding channel.

RtpRetransmitThreshold

Time by which a RTP retransmission must be received for the retransmission to be considered successful.

Type: u32

Default: 50

StbBlockList

List of handles corresponding to the blocks of STBs that will be used in the test.

Type: handle

Default: 0

TestEnv

Specifies the set up of source side traffic.

Type: enum

Default: TESTING_ENV

Possible Values:

Value Description
TESTING_ENV

Testing environment (The traffic sources are set up in the test using Spirent TestCenter.)

REAL_WORLD_ENV

Real world environment (The traffic is generated from a non-Spirent TestCenter source.)

TestName

User-defined test name.

Type: string

Default: IptvTest

TestTime

Duration (in seconds) that the test runs.

Type: double

Default: 300

Range: 0 - 429496729

TypeOfTest

Type of test under IPTV testing scenario.

Type: enum

Default: CHANNEL_VERIFICATION_TEST

Possible Values:

Value Description
CHANNEL_ZAPPING_TEST

The channel zapping test is used to monitor zapping characteristics for a large number of subscribers. Select the channel zapping test for stress testing a DUT or SUT.

CHANNEL_VERIFICATION_TEST

The channel verification test is used to verify that each multicast channel is properly received by a small number of subscribers. Select the channel verification test for initial functional testing.

FAST_CHANNEL_CHANGE_TEST

Deprecated

RELIABLE_RETRANSMISSION_TEST

Deprecated

FCC_WITH_RRR_TEST

Deprecated

UdpPortNum

Port number on which packets are filtered.

Type: u32

Default: 3357

UdpPortTypeFilter

Select to filter on the source or destination UDP port. (Applicable only for real world test environment.)

Type: enum

Default: SOURCE

Possible Values:

Value Description
SOURCE

UDP port to be filtered on this source.

DESTINATION

Received packets to be filtered on the destination UDP ports.

UnicastLeaveTrigger

The event that begins the countdown until the unicast Leave will be performed.

Type: enum

Default: UNICAST_JOIN_AND_DELAY

Possible Values:

Value Description
UNICAST_JOIN_AND_DELAY

If the "Unicast Join + Delay" unicast Leave trigger is selected for a FCC test, the unicast Leave message for a channel shall be transmitted after a unicast Leave trigger delay following the transmission of the corresponding unicast Join message.

MULTICAST_PKT_AND_DELAY

If the "Multicast Packet + Delay" unicast Leave trigger is selected for a FCC test, the unicast Leave message for a channel shall be transmitted after a unicast Leave trigger delay following the receipt of the first multicast packet for the corresponding channel.

VlanSubFilter

For ports with PPP and VLAN stacking enabled, one subfilter is dedicated to the PPP session ID while the other available subfilter can be used for either the outer VLAN ID or inner VLAN ID.

Type: enum

Default: OUTER

Possible Values:

Value Description
OUTER

Filters the hosts on the outer VLAN ID.

INNER

Filters the IGMP/MLD hosts based on the inner VLAN ID.

IptvStartTestCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status