PppoxSessionInfoCommand Object

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

Description:

Get PPPoX session information.

Can be used with Command Sequencer: Yes

GUI Command Name: PPPoX: Save Session Info

Parents: Sequencer, StcSystem

PppoxSessionInfoCommand 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 get PPPoX session information.

Type: handle

Default: 0
FileName

Filename to which the session information results will be saved.

Type: outputFilePath

Default: pppoesessions.csv
SaveToFile

Whether to save PPPoX session information results to a file.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Save PPPoX session information results to file.
FALSE

Do not save PPPoX session information results to file.
TimestampFilename

Whether to include a timestamp as part of the filename.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include timestamp as part of the filename.
FALSE

Do not include timestamp as part of the filename.

PppoxSessionInfoCommand Read-Only Attributes

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