OpenflowViewMeterStatisticsCommand Object

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

Description:

View OpenFlow meter statistics.

Can be used with Command Sequencer: Yes

GUI Command Name: Openflow: View Openflow Meter Statistics

Parents: Sequencer, StcSystem

OpenflowViewMeterStatisticsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AllMeters

View statistics for all meters.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

View statistics for all meters.
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

MaxEntries

Maximum number of entries to export.

Type: u32

Default: 5000
MeterId

Meter ID for which to view 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 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.

Statistics type

Type: enum

Default: PORT_STATISTICS

Possible Values:

Value Description
SWITCH_DESCRIPTION

Switch description

INDIVIDUAL_FLOW

Individual flow statistics

AGGREGATE_FLOW

Aggregate flow statistics

TABLE_STATISTICS

Table statistics

PORT_STATISTICS

Port statistics
GROUP_STATISTICS

View group statistics.

METER_STATISTICS

Meter statistics

METER_FEATURES

Meter features

TABLE_FEATURES

Table features

PORT_DESCRIPTION

Port description

EXPERIMENTER

Experimenter

SwitchList

Select one or more switches for which to view statistics.

Type: handle

Default: 0

OpenflowViewMeterStatisticsCommand Read-Only Attributes

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

Exported file names

Type: outputFilePath

Default: "" (empty string)

ReceivedEntryCount

Number of received statistics entries

Type: u32

Default: 0