ConvergenceCollectorCommand Object

Description:

Collect results for a control-plane convergence test.

Can be used with Command Sequencer: Yes

GUI Command Name: Control-Plane Convergence: Convergence Collector

Parents: Project, Sequencer

Attribute

Description

ConfigList

List of ConvergenceConfig objects to collect results

Type: handle

Default: 0

ErrorOnFailure

Set to return an error if the command fails.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Return an error if the command fails.
FALSE	Do not return an error.

MismatchWarning

Compare the running state to the configured state.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Warning is issued if states do not match.
FALSE	No comparision is made between states.

TestType

Type of test.

Type: enum

Default: CONVERGENCE

Possible Values:

Value	Description
CONVERGENCE	A two port test (primary and secondary) ports that measures the time to switch from the primary port to the secondary port.
LOAD	A single port (primary) test that calculates convergence time of traffic to reach 100% starting from 0%.
REVERSION	A two port test (primary and secondary) ports that measures the time to switch from the secondary port to the primary port.

Timeout

Maximum number of seconds to wait for streams on a backup port.

Type: u32

Default: 120

Range: 10 - 600

Read-Only Attribute	Description
Common Read-Only Attributes	PassFailState