AutomationOptions Object


Description:

Options for system messages for Spirent TestCenter Automation. Various system messages can be generated while running automation. You can also create your own messages using the log function. See the Spirent TestCenter Automation Programmer's Guide for more information.

Automatically created from: StcSystem

AutomationOptions Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AutoSubscribe

Auto subscribe for results.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

True.

FALSE

False.

LogLevel

Level of system messages. The messages will be sent to the output specified by the LogTo attribute.

Type: enum

Default: WARN

Possible Values:

Value Description
DEBUG

Display DEBUG, INFO, WARN, and ERROR messages.

INFO

Display INFO, WARN, and ERROR messages.

WARN

Display WARN and ERROR messages.

ERROR

Display only ERROR messages.

LogTo

Where to send system messages. The default sends to standard output (stdout), usually the console. If you give a filename, system messages are written to that file. Use forward slashes / between directory names.

Tcl example: -logTo "output/logfiles/log.txt"

Type: string

Default: stdout

MaxBackup

Set maximun number of backup files to create for log files. Oldest file is removed when max back up file size limit is reached. All other back up files are renamed to create newest back up file name ending with 1. e.g. if MaxBackUp is set to 5 then bll.log.5 is deleted and bll.log.4 is renamed to bll.log.5.

Type: u16

Default: 0

MaxFileSizeInMB

Set maximum file size in MB for back up files. value must be greater than 1 to overwrite default value.

Type: u32

Default: 10

SuppressTclErrors

NOTE: It is recommended that you do not use this attribute. Specifies whether to hide Tcl exceptions when command errors occur, and use a -1 return code instead.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Suppress Tcl exceptions. Use -1 return code instead.

FALSE

Throw a Tcl exception when a command error occurs. Do not use -1 return code.

AutomationOptions Read-Only Attributes

There are no read-only attributes.