OpenflowViewGroupStatisticsCommand Object

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

Description:

View OpenFlow Group statistics.

Can be used with Command Sequencer: Yes

GUI Command Name: Openflow: View Openflow Group Statistics

Parents: Sequencer, StcSystem

OpenflowViewGroupStatisticsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AllGroups

View statistics for all groups.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

View statistics for all groups.
FALSE

Specify a port for which to view statistics.
Controller

Select a controller for which to view statistics.

Type: handle

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

Choose to export statistics to a file or not.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Export to file

FALSE

Do not export to file

GroupId

Group ID for which to view statistics.

Type: u32

Default: 0
MaxEntries

Maximum number of entries to export.

Type: u32

Default: 5000
SaveAsArchive

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

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Save as a zip file.
FALSE

Save as a 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.

Select the type of 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 about 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

Select one or more switches for which to view statistics.

Type: handle

Default: 0

OpenflowViewGroupStatisticsCommand 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