CSTestSessionConnectCommand Object

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

Description:

Creates a new test session on the Spirent TestCenter LS and connects to it, or connects to an existing test session on the LS. The automation client will connect as a controller, not as a viewer.

NOTE: An automation client must always be the controller on a test session. It cannot be a viewer. If another client is already the controller on a test session, this command will fail.

Tcl examples:

Create a new test session and connect to the test session (uses default TestSessionName and OwnerId):

stc::perform CSTestSessionConnectCommand -Host 1.1.1.1 -CreateNewTestSession TRUE

Connect to an existing test session when you have its handle:

stc::perform CSTestSessionConnectCommand -Host 1.1.1.1 -TestSession $csTestSessionHandle

Connect to an existing test session when you know its name and its owner's ID:

stc::perform CSTestSessionConnectCommand -Host 1.1.1.1 -TestSessionName MySession -OwnerId MyId

Can be used with Command Sequencer: No

CSTestSessionConnectCommand Writable Attributes

Attribute Description
CreateNewTestSession

Whether to create a new test session on the Spirent TestCenter LS.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Create a new test session that uses the name specified by the TestSessionName attribute. If nothing is specified for TestSessionName, the session will be named AutoCreatedSession_XX, where XX is the lowest decimal number that results in a unique test session name on the LS.

When you create a new test session, it creates a new CSTestSession object on the LS, and then starts the test session.
FALSE

Do not create a new test session.
Host

The IPv4 address or DNS name of the Spirent TestCenter LS.

Type: string

Default: localhost
OwnerId

If the CreateNewTestSession attribute is FALSE, this must match the user ID of the user that created the test session. This is the OwnerId attribute of the CSTestSession object.

If CreateNewTestSession is TRUE, this attribute will become the OwnerId attribute of the new CSTestSession object.

Type: string

Default: Current user's user ID
TestSession

The handle of an existing CSTestSession object on the Spirent TestCenter LS. To get this handle you must query the Spirent TestCenter LS.

This attribute is ignored if CreateNewTestSession is TRUE.

Type: handle

Default: 0
TestSessionName

If the CreateNewTestSession attribute is FALSE, the command will attempt to connect to a test session of this name on the LS.

If CreateNewTestSession is TRUE, the command will create a new test session of this name. If another test session with the same name already exists, the command will fail.

Type: string

Default: "" (empty string)

CSTestSessionConnectCommand Read-Only Attributes

There are no read-only attributes.