flowbroker

flowbroker add analyzer sets

flowbroker add analyzer analyzer-sets - Add a new FlowBROKER Analyzer Set

Description:
Add a new Analyzer Set.
An Analyzer Set can contain up to 4 Analyzers for subsequent association with Packet Engine flows. An analyzer can be associated with an Analyzer Set through the 'flowbroker edit analyzer analyzer-sets' command.

Syntax:

  flowbroker add analyzer analyzer-sets name <name>

  <name>       = <string>

Parameters:

flowbroker add analyzer configuration

flowbroker add analyzer configuration - Add a new FlowBROKER Analyzer

Description:
Add a new Analyzer. An Analyzer defines what to do with the captured data. There are currently 3 types of Analyzers. Each one has its own set of parameters.

Syntax:

       { type [erspan-t3 | pcap | streaming ] } |
       { destination <dest> } |
       { erspan-dscp <0-63> } |
       { erspan-session-id <0-1023> } |
       { erspan-ttl <1-255> } |
       { filename <filename> } |
       { interface <intf> } |
       { max-file-period <1-60> } |
       { max-file-size <256-10240> } |
       { password <password> } |
       { scope [device | flow | port | global] } }+

  <name>       = <string>
  <dest>       = <string>
  <filename>   = <string>
  <intf>       = <string>
  <password>   = <string>

Parameters:

flowbroker add data extraction

flowbroker add data-extraction - Add a new FlowBROKER Data Extraction

Description:
Add a new Data Extraction. A Data Extraction defines which data must be captured from a packet that has been filtered by the Packet Engine. Data Extraction can only be used for modules, it is not supported by FSX devices.

Syntax:

  flowbroker add data-extraction name <name> type [up-to-length | whole-packet]
       { { length <4-10240> } }+

  <name>       = <string>

Parameters:

flowbroker add pkt-engine

flowbroker add pkt-engine - Add a new FlowBROKER Packet Engine

Description:
Add a new Packet Engine.
The Packet Engine can connect to a remote module or to a FSX device.

Syntax:

  flowbroker add pkt-engine <name> type module device <dev-name> {
         { tcp-port <1-65534> } |
         { dscp <0-63> } |
         { capture-timer    <1-1440>    [enable | disable] } |
         { max-capture-size <1-5120000> [enable | disable] } |
         { state [enable | disable] }}+

  flowbroker add pkt-engine <name> type fsx {
         { analyzer-set <set-name> } |
         { ipaddr <ip-address> } |
         { tcp-port <1-65534> } |
         { dscp <0-63> } |
         { state [enable | disable] }}+

  <name>       = <string>
  <dev-name>   = <string>
  <set-name>   = <string>
  <ip-address> = <string>

Parameters:

flowbroker clear analyzer statistics

flowbroker clear analyzer statistics - Clear FlowBROKER Analyzer statistics

Description:
Clear FlowBROKER Analyzer statistics. By default, statistics will be cleared for all Analyzers. If an Analyzer name is provided, only the statistics related to this Analyzer will be cleared.

Syntax:

  flowbroker clear analyzer statistics {<name>}

  <name>       = <string>

Parameters:

flowbroker clear pkt-engine statistics

flowbroker clear pkt-engine statistics - Clear FlowBROKER Packet Engine statistics

Description:
Clear FlowBROKER Packet Engine statistics. By default, statistics will be cleared for all Packet Engines. If a Packet Engine name is provided, only the statistics related to this Packet Engine will be cleared.

Syntax:

  flowbroker clear pkt-engine statistics {<name>}

  <name>       = <string>

Parameters:

flowbroker clear pkt-engine unsolicited

flowbroker clear pkt-engine unsolicited - Clear FlowBROKER Packet Engine unsolicited flows

Description:
Clear FlowBROKER FSX Packet Engine unsolicited flows. By default, unsolicited flows for all FSX Packet Engines will be cleared. If a Packet Engine name is provided, only the unsolicited flows related to this packet engine will be cleared.

Note: This command only applies to FSX Packet Engines.

Syntax:

  flowbroker clear pkt-engine unsolicited {<name>}

  <name>       = <string>

Parameters:

flowbroker delete analyzer analyzer-sets

flowbroker delete analyzer analyzer-sets - Delete an existing FlowBROKER Analyzer Set

Description:
Delete an existing FlowBROKER Analyzer Set. An Analyzer Set cannot be deleted when it is actually used by a packet engine.

Syntax:

  flowbroker delete analyzer analyzer-sets <name>

  <name>       = <string>

Parameters:

flowbroker delete analyzer configuration

flowbroker delete analyzer configuration - Delete an existing FlowBROKER Analyzer

Description:
Delete an existing FlowBROKER Analyzer. An Analyzer cannot be deleted when it is actually used by a packet engine.

Syntax:

  flowbroker delete analyzer configuration <name>

  <name>       = <string>

Parameters:

flowbroker delete data extraction

flowbroker delete data-extraction - Delete an existing FlowBROKER Data Extraction

Description:
Delete an existing Data Extraction.

Syntax:

  flowbroker delete data-extraction <name>

  <name>       = <string>

Parameters:

flowbroker delete pkt-engine

flowbroker delete pkt-engine - Delete an existing FlowBROKER Packet Engine

Description:
Delete an existing Packet Engine.

Syntax:

  flowbroker delete pkt-engine <name>

  <name>       = <string>

Parameters:

flowbroker edit analyzer analyzer-sets

flowbroker edit analyzer analyzer-sets - Edit an existing FlowBROKER Analyzer Set

Description:
Edit an existing Analyzer Set. An Analyzer Set can contain up to 4 analyzers for subsequent association with Packet Engine flows. Use this command to add or delete the association with an Analyzer.

Syntax:

  flowbroker edit analyzer analyzer-sets <name> {
       { name <new_name> } |
       { analyzer-list-add <analyzer> } |
       { analyzer-list-del <analyzer> } }+

  <name>       = <string>
  <analyzer>   = <string>

Parameters:

flowbroker edit analyzer configuration

flowbroker edit analyzer configuration - Edit an existing FlowBROKER Analyzer

Description:
Edit an existing FlowBROKER Analyzer. An Analyzer defines what to do with the captured data. For more information, refer to the help for the 'flowbroker add analyzer configuration' command.The type of the Analyzer cannot be changed when it is actually used by a packet engine.

Syntax:

  flowbroker edit analyzer configuration <name> {
       { name <new_name> } |
       { type [erspan-t3 | pcap | streaming ] } |
       { destination <dest> } |
       { erspan-dscp <0-63> } |
       { erspan-session-id <0-1023> } |
       { erspan-ttl <1-255> } |
       { filename <filename> } |
       { interface <intf> } |
       { max-file-period <1-60> } |
       { max-file-size <256-10240> } |
       { password <password> } |
       { scope [device | flow | port | global] } }+

  <name>       = <string>
  <new_name>   = <string>
  <dest>       = <string>
  <filename>   = <string>
  <intf>       = <string>
  <password>   = <string>

Parameters:

flowbroker edit data extraction

flowbroker edit data-extraction - Edit an existing FlowBROKER Data Extraction

Description:
Edit an existing Data Extraction. A Data Extraction defines which data must be captured from a packet that has been filtered by the Packet Engine. Data Extraction can only be used for modules, it is not supported by FSX devices.

Syntax:

  flowbroker edit data-extraction <name> {
       { name <new_name> } |
       { type [up-to-length | whole-packet] } |
       { length <4-10240> } }+

  <name>       = <string>

Parameters:

flowbroker edit pkt-engine

flowbroker edit pkt-engine - Edit an existing FlowBROKER Packet Engine

Description:
Edit an existing Packet Engine. The Packet Engine can connect to a remote module or to a FSX device. The Packet Engine type cannot be changed once the Packet Engine is created.

Syntax:

  For type Module:

  flowbroker edit pkt-engine <name> {
         { name <new-name> } |
         { device [dev-name] } |
         { tcp-port <1-65534> } |
         { dscp <0-63> } |
         { capture-timer    <1-1440>   [enable | disable] } |
         { max-capture-size <1-5120000> [enable | disable] } |
         { state [enable | disable] }}+

  For type fsx:

  flowbroker edit pkt-engine <name> {
         { name <new-name> } |
         { analyzer-set <set-name> } |
         { ipaddr <ip-address> } |
         { tcp-port <1-65534> } |
         { dscp <0-63> } |
         { state [enable | disable] }}+

  <name>       = <string>
  <dev-name>   = <string>
  <set-name>   = <string>
  <ip-address> = <string>

Parameters:

flowbroker edit pktengine-rules

flowbroker edit pktengine-rules - Edit a Packet Engine Rule

Description:
Edit a Packet Engine Rule. A Packet Engine Rule defines the filters to apply on the device, the action to do when the filter matches (include, exclude or none), which data to extract from the packet and to which Analyzer Set to send the data. Only Module Packet Engines can specify rules; FSX rules must be specified on the FSX itself. The following actions can be applied:

• none: This action is used to disable the rule.
• include: When the filter matches, the packet is sent to the Sensor Control.
• exclude: When the filter matches, the packet is not sent to the Sensor Control, and no further comparision is done. Note that this action does not affect the actual traffic.

Syntax:

  flowbroker edit pktengine-rules <name> <ruleid> {
       { port [NNI | UNI | <port_name>] } |
       { action [ exclude | include | none ] } |
       { analyzer-set <set-name> } |
       { data-extraction <data-extr> } |
       { filter [ ipv4 | ipv6 | l2 | none ] <filter-name> } }+

  <name>       = <string>
  <ruleid>     = <decimal>
  <port-name>  = <string>
  <set-name>   = <string>
  <data-extr>  = <string>
  <filter-name>= <string>

Parameters:

flowbroker show analyzer analyzer-sets

flowbroker show analyzer analyzer-sets - Show FlowBROKER Analyzer Sets

Description:
Show FlowBROKER Analyzer Set. By default, a summary will be shown for all Analyzer Sets. If an Analyzer Set name is provided, only the associations related to this Analyzer Set will be shown.

Syntax:

  flowbroker show analyzer analyzer-sets {<name>}

  <name>       = <string>

Parameters:

flowbroker show analyzer configuration

flowbroker show analyzer configuration - Show FlowBROKER Analyzer configuration

Description:
Show FlowBROKER Analyzer configurations. By default, a configuration summary will be shown for all Analyzers. If an Analyzer name is provided only the configuration related to this Analyzer will be shown.

Syntax:

  flowbroker show analyzer configuration {<name>}

  <name>       = <string>

Parameters:

flowbroker show analyzer statistics

flowbroker show analyzer statistics - Show FlowBROKER Analyzer statistics

Description:
Show FlowBROKER Analyzer statistics. By default, a statistics summary will be shown for all Analyzers. If an Analyzer name is provided, only the statistics related to this Analyzer will be shown.

Syntax:

  flowbroker show analyzer statistics {<name>}

  <name>       = <string>

Parameters:

flowbroker show data extraction

flowbroker show data-extraction - Delete an existing FlowBROKER Data Extraction

Description:
Show FlowBROKER Data Extraction configuration. By default, a summary for all the Data Extraction configuration will be shown. If a Data Extraction name is provided, the detailed configuration for this Data Extraction will be shown.

Syntax:

  flowbroker show data-extraction { <name> }

  <name>       = <string>

Parameters:

flowbroker show pkt-engine configuration

flowbroker show pkt-engine configuration - Show FlowBROKER Packet Engine configuration

Description:
Show FlowBROKER Packet Engine configuration. By default, a summary for all the Packet Engine configurations will be shown. If a Packet Engine name is provided, the detailed configuration for this Packet Engine will be shown.

Syntax:

  flowbroker show pkt-engine configuration {<name>}

  <name>       = <string>

Parameters:
name The name of the Packet Engine for which to show the configuration.

flowbroker show pkt-engine statistics

flowbroker show pkt-engine statistics - Show FlowBROKER Packet Engine statistics

Description:
Show FlowBROKER Packet Engine statistics. By default, all statistics will be shown. If a Packet Engine name is provided, only the statistics related to this Packet Engine will be shown. The 'Missed Packets' value will be shown with an asterisk (*) when a disconnection from the device has been detected, meaning that the actual missed packets value may be greater.

Syntax:

  flowbroker show pkt-engine statistics {<name>}

  <name>       = <string>

Parameters:

flowmeter clear statistics

Description:
Clear FlowMETER statistics for the specified port.

Syntax:

  flowmeter clear statistics <port-name>

  <port-name> = <string>

Parameters:

flowmeter edit

flowmeter edit - Modify the configuration of a FlowMETER rule.

Description:
Define the state of a FlowMETER rule and its associated filter.

Syntax:

  flowmeter edit <port-name> <rule-id> {{state {enable | disable}} |
                                        {filter {l2 | ipv4 | ipv6 | none}
                                        {<filter-name>}}}+

  <port-name>   = <string>
  <rule-id>     = <decimal>
  <filter-name> = <string>

Parameters:

flowmeter show configuration

flowmeter show configuration - Show the FlowMETER configuration.

Description:
Show the current FlowMETER configuration. If no argument is provided, display all currently active ports along with the number of enabled flows associated with the port. If a port name is provided, a configuration summary for the port is displayed in a table format. If <rule-id> is provided together with the port name, the detailed FlowMETER configuration is displayed for the rule.

Syntax:

  flowmeter show configuration [<port-name> [<rule-id>]]

  <port-name> = <string>
  <rule-id>   = <decimal>

Parameters:

flowmeter show statistics

flowmeter show statistics - Show FlowMETER statistics.

Description:
Display a number of FlowMETER statistics including packet and byte counters.

Note: Statistics annotated with * might contain partial information due to missed sampling periods from the remote device.

Syntax:

  flowmeter show statistics <port-name> type {sample | report}

  <port-name> = <string>

Parameters:

flowmeter-reporting edit

flowmeter-reporting edit [<device-name>] - Modify the FlowMETER reporting configuration.

Description:
Modify the FlowMETER reporting configuration to control how it is performed.

Syntax:

  flowmeter-reporting edit {destination-port <0-65535>}}
  flowmeter-reporting edit [<device-name>] {{sampling-period 100-10000}}+

Parameters:

flowmeter-reporting show

flowmeter-reporting show [<device-name>] - Show the FlowMETER reporting configuration.

Description:
Show the current FlowMETER reporting configuration

Syntax:

  flowmeter-reporting show [<device-name>]

  <device-name> = <string>

Parameters: