mirror of
https://github.com/zeek/zeek.git
synced 2025-10-06 00:28:21 +00:00
Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz
parent
83f1e74643
commit
ded98cd373
1074 changed files with 169319 additions and 0 deletions
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/__load__.zeek
|
||||
==============================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/frameworks/openflow/plugins/broker.zeek </scripts/base/frameworks/openflow/plugins/broker.zeek>`, :doc:`base/frameworks/openflow/plugins/log.zeek </scripts/base/frameworks/openflow/plugins/log.zeek>`, :doc:`base/frameworks/openflow/plugins/ryu.zeek </scripts/base/frameworks/openflow/plugins/ryu.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
91
doc/scripts/base/frameworks/openflow/plugins/broker.zeek.rst
Normal file
91
doc/scripts/base/frameworks/openflow/plugins/broker.zeek.rst
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/broker.zeek
|
||||
============================================
|
||||
.. zeek:namespace:: OpenFlow
|
||||
|
||||
OpenFlow plugin for interfacing to controllers via Broker.
|
||||
|
||||
:Namespace: OpenFlow
|
||||
:Imports: :doc:`base/frameworks/broker </scripts/base/frameworks/broker/index>`, :doc:`base/frameworks/openflow </scripts/base/frameworks/openflow/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinitions
|
||||
#############
|
||||
=============================================================================== ==========================================================
|
||||
:zeek:type:`OpenFlow::ControllerState`: :zeek:type:`record` :zeek:attr:`&redef`
|
||||
|
||||
:New Fields: :zeek:type:`OpenFlow::ControllerState`
|
||||
|
||||
broker_host: :zeek:type:`addr` :zeek:attr:`&optional`
|
||||
Controller ip.
|
||||
|
||||
broker_port: :zeek:type:`port` :zeek:attr:`&optional`
|
||||
Controller listen port.
|
||||
|
||||
broker_dpid: :zeek:type:`count` :zeek:attr:`&optional`
|
||||
OpenFlow switch datapath id.
|
||||
|
||||
broker_topic: :zeek:type:`string` :zeek:attr:`&optional`
|
||||
Topic to send events for this controller to.
|
||||
:zeek:type:`OpenFlow::Plugin`: :zeek:type:`enum`
|
||||
|
||||
* :zeek:enum:`OpenFlow::BROKER`
|
||||
=============================================================================== ==========================================================
|
||||
|
||||
Events
|
||||
######
|
||||
========================================================== =
|
||||
:zeek:id:`OpenFlow::broker_flow_clear`: :zeek:type:`event`
|
||||
:zeek:id:`OpenFlow::broker_flow_mod`: :zeek:type:`event`
|
||||
========================================================== =
|
||||
|
||||
Functions
|
||||
#########
|
||||
====================================================== ==============================
|
||||
:zeek:id:`OpenFlow::broker_new`: :zeek:type:`function` Broker controller constructor.
|
||||
====================================================== ==============================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Events
|
||||
######
|
||||
.. zeek:id:: OpenFlow::broker_flow_clear
|
||||
:source-code: base/frameworks/openflow/plugins/broker.zeek 38 38
|
||||
|
||||
:Type: :zeek:type:`event` (name: :zeek:type:`string`, dpid: :zeek:type:`count`)
|
||||
|
||||
|
||||
.. zeek:id:: OpenFlow::broker_flow_mod
|
||||
:source-code: base/frameworks/openflow/plugins/broker.zeek 37 37
|
||||
|
||||
:Type: :zeek:type:`event` (name: :zeek:type:`string`, dpid: :zeek:type:`count`, match: :zeek:type:`OpenFlow::ofp_match`, flow_mod: :zeek:type:`OpenFlow::ofp_flow_mod`)
|
||||
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. zeek:id:: OpenFlow::broker_new
|
||||
:source-code: base/frameworks/openflow/plugins/broker.zeek 82 95
|
||||
|
||||
:Type: :zeek:type:`function` (name: :zeek:type:`string`, host: :zeek:type:`addr`, host_port: :zeek:type:`port`, topic: :zeek:type:`string`, dpid: :zeek:type:`count`) : :zeek:type:`OpenFlow::Controller`
|
||||
|
||||
Broker controller constructor.
|
||||
|
||||
|
||||
:param host: Controller ip.
|
||||
|
||||
|
||||
:param host_port: Controller listen port.
|
||||
|
||||
|
||||
:param topic: Broker topic to send messages to.
|
||||
|
||||
|
||||
:param dpid: OpenFlow switch datapath id.
|
||||
|
||||
|
||||
:returns: OpenFlow::Controller record.
|
||||
|
||||
|
||||
23
doc/scripts/base/frameworks/openflow/plugins/index.rst
Normal file
23
doc/scripts/base/frameworks/openflow/plugins/index.rst
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/frameworks/openflow/plugins
|
||||
=========================================
|
||||
|
||||
Plugins for the OpenFlow framework.
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/__load__.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/ryu.zeek`
|
||||
|
||||
OpenFlow plugin for the Ryu controller.
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/log.zeek`
|
||||
|
||||
OpenFlow plugin that outputs flow-modification commands
|
||||
to a Zeek log file.
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/broker.zeek`
|
||||
|
||||
OpenFlow plugin for interfacing to controllers via Broker.
|
||||
|
||||
129
doc/scripts/base/frameworks/openflow/plugins/log.zeek.rst
Normal file
129
doc/scripts/base/frameworks/openflow/plugins/log.zeek.rst
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/log.zeek
|
||||
=========================================
|
||||
.. zeek:namespace:: OpenFlow
|
||||
|
||||
OpenFlow plugin that outputs flow-modification commands
|
||||
to a Zeek log file.
|
||||
|
||||
:Namespace: OpenFlow
|
||||
:Imports: :doc:`base/frameworks/logging </scripts/base/frameworks/logging/index>`, :doc:`base/frameworks/openflow </scripts/base/frameworks/openflow/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
================================================ =================================================================
|
||||
:zeek:type:`OpenFlow::Info`: :zeek:type:`record` The record type which contains column fields of the OpenFlow log.
|
||||
================================================ =================================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
=============================================================================== =============================================================
|
||||
:zeek:type:`Log::ID`: :zeek:type:`enum`
|
||||
|
||||
* :zeek:enum:`OpenFlow::LOG`
|
||||
:zeek:type:`OpenFlow::ControllerState`: :zeek:type:`record` :zeek:attr:`&redef`
|
||||
|
||||
:New Fields: :zeek:type:`OpenFlow::ControllerState`
|
||||
|
||||
log_dpid: :zeek:type:`count` :zeek:attr:`&optional`
|
||||
OpenFlow switch datapath id.
|
||||
|
||||
log_success_event: :zeek:type:`bool` :zeek:attr:`&optional`
|
||||
Raise or do not raise success event.
|
||||
:zeek:type:`OpenFlow::Plugin`: :zeek:type:`enum`
|
||||
|
||||
* :zeek:enum:`OpenFlow::OFLOG`
|
||||
=============================================================================== =============================================================
|
||||
|
||||
Events
|
||||
######
|
||||
===================================================== ===================================================================
|
||||
:zeek:id:`OpenFlow::log_openflow`: :zeek:type:`event` Event that can be handled to access the :zeek:type:`OpenFlow::Info`
|
||||
record as it is sent on to the logging framework.
|
||||
===================================================== ===================================================================
|
||||
|
||||
Hooks
|
||||
#####
|
||||
============================================================= =
|
||||
:zeek:id:`OpenFlow::log_policy`: :zeek:type:`Log::PolicyHook`
|
||||
============================================================= =
|
||||
|
||||
Functions
|
||||
#########
|
||||
=================================================== ===========================
|
||||
:zeek:id:`OpenFlow::log_new`: :zeek:type:`function` Log controller constructor.
|
||||
=================================================== ===========================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. zeek:type:: OpenFlow::Info
|
||||
:source-code: base/frameworks/openflow/plugins/log.zeek 35 44
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: ts :zeek:type:`time` :zeek:attr:`&log`
|
||||
|
||||
Network time.
|
||||
|
||||
|
||||
.. zeek:field:: dpid :zeek:type:`count` :zeek:attr:`&log`
|
||||
|
||||
OpenFlow switch datapath id.
|
||||
|
||||
|
||||
.. zeek:field:: match :zeek:type:`OpenFlow::ofp_match` :zeek:attr:`&log`
|
||||
|
||||
OpenFlow match fields.
|
||||
|
||||
|
||||
.. zeek:field:: flow_mod :zeek:type:`OpenFlow::ofp_flow_mod` :zeek:attr:`&log`
|
||||
|
||||
OpenFlow modify flow entry message.
|
||||
|
||||
|
||||
The record type which contains column fields of the OpenFlow log.
|
||||
|
||||
Events
|
||||
######
|
||||
.. zeek:id:: OpenFlow::log_openflow
|
||||
:source-code: base/frameworks/openflow/plugins/log.zeek 48 48
|
||||
|
||||
:Type: :zeek:type:`event` (rec: :zeek:type:`OpenFlow::Info`)
|
||||
|
||||
Event that can be handled to access the :zeek:type:`OpenFlow::Info`
|
||||
record as it is sent on to the logging framework.
|
||||
|
||||
Hooks
|
||||
#####
|
||||
.. zeek:id:: OpenFlow::log_policy
|
||||
:source-code: base/frameworks/openflow/plugins/log.zeek 16 16
|
||||
|
||||
:Type: :zeek:type:`Log::PolicyHook`
|
||||
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. zeek:id:: OpenFlow::log_new
|
||||
:source-code: base/frameworks/openflow/plugins/log.zeek 70 78
|
||||
|
||||
:Type: :zeek:type:`function` (dpid: :zeek:type:`count`, success_event: :zeek:type:`bool` :zeek:attr:`&default` = ``T`` :zeek:attr:`&optional`) : :zeek:type:`OpenFlow::Controller`
|
||||
|
||||
Log controller constructor.
|
||||
|
||||
|
||||
:param dpid: OpenFlow switch datapath id.
|
||||
|
||||
|
||||
:param success_event: If true, flow_mod_success is raised for each logged line.
|
||||
|
||||
|
||||
:returns: OpenFlow::Controller record.
|
||||
|
||||
|
||||
67
doc/scripts/base/frameworks/openflow/plugins/ryu.zeek.rst
Normal file
67
doc/scripts/base/frameworks/openflow/plugins/ryu.zeek.rst
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/ryu.zeek
|
||||
=========================================
|
||||
.. zeek:namespace:: OpenFlow
|
||||
|
||||
OpenFlow plugin for the Ryu controller.
|
||||
|
||||
:Namespace: OpenFlow
|
||||
:Imports: :doc:`base/frameworks/openflow </scripts/base/frameworks/openflow/index>`, :doc:`base/utils/active-http.zeek </scripts/base/utils/active-http.zeek>`, :doc:`base/utils/exec.zeek </scripts/base/utils/exec.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinitions
|
||||
#############
|
||||
=============================================================================== ===================================================================================
|
||||
:zeek:type:`OpenFlow::ControllerState`: :zeek:type:`record` :zeek:attr:`&redef`
|
||||
|
||||
:New Fields: :zeek:type:`OpenFlow::ControllerState`
|
||||
|
||||
ryu_host: :zeek:type:`addr` :zeek:attr:`&optional`
|
||||
Controller ip.
|
||||
|
||||
ryu_port: :zeek:type:`count` :zeek:attr:`&optional`
|
||||
Controller listen port.
|
||||
|
||||
ryu_dpid: :zeek:type:`count` :zeek:attr:`&optional`
|
||||
OpenFlow switch datapath id.
|
||||
|
||||
ryu_debug: :zeek:type:`bool` :zeek:attr:`&default` = ``F`` :zeek:attr:`&optional`
|
||||
Enable debug mode - output JSON to stdout; do not perform actions.
|
||||
:zeek:type:`OpenFlow::Plugin`: :zeek:type:`enum`
|
||||
|
||||
* :zeek:enum:`OpenFlow::RYU`
|
||||
=============================================================================== ===================================================================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
=================================================== ===========================
|
||||
:zeek:id:`OpenFlow::ryu_new`: :zeek:type:`function` Ryu controller constructor.
|
||||
=================================================== ===========================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Functions
|
||||
#########
|
||||
.. zeek:id:: OpenFlow::ryu_new
|
||||
:source-code: base/frameworks/openflow/plugins/ryu.zeek 181 189
|
||||
|
||||
:Type: :zeek:type:`function` (host: :zeek:type:`addr`, host_port: :zeek:type:`count`, dpid: :zeek:type:`count`) : :zeek:type:`OpenFlow::Controller`
|
||||
|
||||
Ryu controller constructor.
|
||||
|
||||
|
||||
:param host: Controller ip.
|
||||
|
||||
|
||||
:param host_port: Controller listen port.
|
||||
|
||||
|
||||
:param dpid: OpenFlow switch datapath id.
|
||||
|
||||
|
||||
:returns: OpenFlow::Controller record.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue