PppoxDisconnectCommand Object


Description:

Disconnect PPPoX sessions.

Can be used with Command Sequencer: Yes

GUI Command Name: PPPoX: Disconnect Sessions

Parents: Sequencer, StcSystem

PppoxDisconnectCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
BlockList

List of PPPoX client/server block config object handles (that is, PppoeClientBlockConfig, PppoaClientBlockConfig, PppoL2tpv2ClientBlockConfig, PppoeServerBlockConfig, PppoaServerBlockConfig, or PppoL2tpv2ServerBlockConfig) on which to disconnect PPPoX sessions.

Type: handle

Default: 0

ControlType

Control type for internal use only.

Type: enum

Default: UNDEFINED

Possible Values:

Value Description
UNDEFINED

Undefined.

CONNECT

Connect.

DISCONNECT

Disconnect.

RETRY

Retry.

PAUSE

Pause.

RESUME

Resume.

TERMINATE

Terminate.

IpCpMode

IP version of sessions to disconnect.

Type: enum

Default: IPV4V6

Possible Values:

Value Description
IPV4V6

Dual-stack mode.

IPV4

IPv4 mode.

IPV6

IPv6 mode.

L2tpSessionDisconnect

Whether to enable L2TP tunnel disconnect when the last PPPoX session comes down.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Disconnect L2TP tunnels after PPPoX sessions come down.

FALSE

Do not disconnect L2TP tunnels after PPPoX sessions come down.

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 PppoxPortConfig object.

Port-level sequence type that determines in what order sessions are brought down.

Type: enum

Default: SEQUENTIAL

Possible Values:

Value Description
SEQUENTIAL

Bring down the sessions sequentially (all of one host block before proceeding to the next).

ROUND_ROBIN

Bring down the sessions in a round-robin fashion (loop over the host blocks bringing down one session at a time).

PppoxDisconnectCommand Read-Only Attributes

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