base/frameworks/openflow/plugins/log.zeek

OpenFlow

OpenFlow plugin that outputs flow-modification commands to a Zeek log file.

Namespace:: OpenFlow
Imports:: base/frameworks/logging, base/frameworks/openflow

Summary

Types

OpenFlow::Info: record

The record type which contains column fields of the OpenFlow log.

Redefinitions

`Log::ID`: `enum`	`OpenFlow::LOG`
`OpenFlow::ControllerState`: `record` `&redef`	New Fields: `OpenFlow::ControllerState` log_dpid: `count` `&optional` OpenFlow switch datapath id. log_success_event: `bool` `&optional` Raise or do not raise success event.
`OpenFlow::Plugin`: `enum`	`OpenFlow::OFLOG`

Events

OpenFlow::log_openflow: event

Event that can be handled to access the OpenFlow::Info record as it is sent on to the logging framework.

Hooks

OpenFlow::log_policy: Log::PolicyHook

Functions

OpenFlow::log_new: function

Log controller constructor.

Detailed Interface

Types

OpenFlow::Info 

Type:

Fields:

ts: time &log: Network time.

dpid: count &log: OpenFlow switch datapath id.

match: OpenFlow::ofp_match &log: OpenFlow match fields.

flow_mod: OpenFlow::ofp_flow_mod &log: OpenFlow modify flow entry message.

The record type which contains column fields of the OpenFlow log.

Events

OpenFlow::log_openflow 

Type:: event (rec: OpenFlow::Info)

Event that can be handled to access the OpenFlow::Info record as it is sent on to the logging framework.

Hooks

OpenFlow::log_policy 

Type:: Log::PolicyHook

Functions

OpenFlow::log_new 

Type:: function (dpid: count, success_event: bool &default = T &optional) : OpenFlow::Controller

Log controller constructor.

Parameters:

dpid – OpenFlow switch datapath id.
success_event – If true, flow_mod_success is raised for each logged line.

Returns:

OpenFlow::Controller record.