RunCustomCommand Object


Description:

Executes a Spirent Global Services script.

Can be used with Command Sequencer: Yes

GUI Command Name: Global Services: Run Custom Command

Parents: Sequencer

RunCustomCommand Writable Attributes

Attribute Description
Common Writable Attributes ErrorOnFailure
Parameters

Script parameters. Parameters must be passed as name value pairs (ex. -time 10 -length 35 -mode burst). Parameters can be referenced by the specified script using the stc::scriptParameters array (ex: $stc::scriptParameters(-mode)).

Type: string

Default: "" (empty string)

ResetScriptingEngine

Whether we should reset the Tcl interpreter before running the script. Resetting the interpreter will clear defined variables.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Resets interpreter before running script.

FALSE

Does not reset interpreter before running script.

ScriptFileName

Script file to be executed.

Type: inputFilePath

Default: "" (empty string)

RunCustomCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes PassFailState
ScriptResult

Result string returned by executed script.

Type: string

Default: "" (empty string)