OpenflowViewAggregateFlowStatisticsCommand Object

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

Description:

View OpenFlow aggregate flow statistics.

Can be used with Command Sequencer: Yes

GUI Command Name: Openflow: View Openflow Aggregate Flow Statistics

Parents: Sequencer, StcSystem

OpenflowViewAggregateFlowStatisticsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AllOutGroups

Retrieve statistics for all output groups.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Retrieve statistics for all output groups.
FALSE

Retrieve statistics for the specified output group.
AllOutPorts

Retrieve statistics for all output ports.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Retrieve statistics for all output ports.
FALSE

Retrieve statistics for the specified output port.
AllTables

Retrieve statistics for all tables.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Retrieve statistics for all tables.
FALSE

Retrieve statistics for the specified table.
Controller

Controller for which to retrieve statistics.

Type: handle

Default: 0
Cookie

Value of cookie for which to retrieve statistics.

Type: u64

Default: 0
CookieMask

Value of cookie mask for which to retrieve statistics.

Type: u64

Default: 0
ExportFilePrefix

Value to prepend to the export file name.

Type: string

Default: OF_
ExportPath

Path to the export file.

Type: outputFilePath

Default: "" (empty string)

ExportStatistics

Export statistics to a csv file.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Export to file.
FALSE

Do not export to file.
MaxEntries

Maximum number of entries to export.

Type: u32

Default: 5000
OutGroup

Output group for which to retreive statistics.

Type: u32

Default: 0
OutPort

Output port for which to retreive statistics.

Type: u32

Default: 0
SaveAsArchive

Save the exported .csv files as a zipped archive file.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Save as zip file.
FALSE

Save as csv file.
SaveStatisticsToSingleFile

Select to save all results in one file.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Save all results to one file.
FALSE

Save results in individual files.
StatisticsType

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

Specify the statistics to view.

Type: enum

Default: PORT_STATISTICS

Possible Values:

Value Description
SWITCH_DESCRIPTION

View switch description.

INDIVIDUAL_FLOW

View statistics for individual flows.
AGGREGATE_FLOW

View aggregate flow statistics.
TABLE_STATISTICS

View information for the tables.
PORT_STATISTICS

View port statistics.
GROUP_STATISTICS

View group statistics.

METER_STATISTICS

View meter statistics.

METER_FEATURES

View meter features.

TABLE_FEATURES

View table features.

PORT_DESCRIPTION

View port description.
EXPERIMENTER

View experimenter statistics.
SwitchList

Switches from which to retrieve statistics.

Type: handle

Default: 0
TableId

Table ID for which to retrieve aggregate flow statistics.

Type: u8

Default: 0

OpenflowViewAggregateFlowStatisticsCommand Read-Only Attributes

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

List of file names where the results have been exported to.

Type: outputFilePath

Default: "" (empty string)

ReceivedEntryCount

Number of entries received.

Type: u32

Default: 0