OpenflowViewMeterFeaturesCommand Object


Description:

View OpenFlow Meter Features.

Can be used with Command Sequencer: Yes

GUI Command Name: Openflow: View Openflow Meter Features

Parents: Sequencer, StcSystem

OpenflowViewMeterFeaturesCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
Controller

Select a controller for which to view meter features.

Type: handle

Default: 0

ExportFilePrefix

Prefix for the file name for the exported statistics file.

Type: string

Default: OF_

ExportPath

Location of the exported statistics file.

Type: outputFilePath

Default: "" (empty string)

ExportStatistics

Choose to export the statistics to a file or not.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Export.

FALSE

Do not export.

MaxEntries

Maximum entries for the exported statistics.

Type: u32

Default: 5000

SaveAsArchive

Archive the exported statistics file.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Archive.

FALSE

Do not archive.

SaveStatisticsToSingleFile

Option to save all the statistics to a single file.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Save to single file.

FALSE

Do not Save to single file.

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 Openflow Switch Description

INDIVIDUAL_FLOW

View Individual Flow Statistics

AGGREGATE_FLOW

View Aggregate flow statistics

TABLE_STATISTICS

View Table statistics for the selected table

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 meter features.

Type: handle

Default: 0

OpenflowViewMeterFeaturesCommand Read-Only Attributes

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

File names for the exported statistics file.

Type: outputFilePath

Default: "" (empty string)

ReceivedEntryCount

Count of the number of statistics exported.

Type: u32

Default: 0