L2tpConnectCommand Object


Description:

Start connection of the L2TP tunnels.

Can be used with Command Sequencer: Yes

GUI Command Name: L2TP: Connect L2TP Devices

Parents: Sequencer, StcSystem

L2tpConnectCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
BlockList

List of L2TP block config objects on which to start tunnels connecting.

Type: handle

Default: 0

ConnectSession

The target of the command is session or tunnel.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

The target of the command is session.

FALSE

The target of the command is tunnel.

ControlType

Control type for internal use only.

Type: enum

Default: UNDEFINED

Possible Values:

Value Description
UNDEFINED

Undefined.

CONNECT

Connect.

DISCONNECT

Disconnect.

RETRY

Retry failed sessions.

TERMINATE

Terminate.

SEND_CSURQ

Send Connect-Speed-Update-Request.

NodeStartStepCountList

Currently unavailable.

Type: u16

Default: 0

SeqType

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead of this attribute, use the SeqType attribute on the L2tpPortConfig object.

The way in which to bring up the tunnels.

Type: enum

Default: SEQUENTIAL

Possible Values:

Value Description
SEQUENTIAL

Connect the tunnels in a sequential manner.

ROUND_ROBIN

Connect the tunnels in a round-robin manner.

TunnelStartStepCountList

Currently unavailable.

Type: u16

Default: 0

L2tpConnectCommand Read-Only Attributes

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