No description, website, or topics provided.
Python JavaScript Shell Other
Latest commit d266845 Feb 22, 2017 @anarkiwi anarkiwi committed on GitHub Merge pull request #401 from onfsdn/master
CouchApp for flow information visualization


Version: 1.3.2
Copyright: 2015 REANNZ. All Rights Reserved.


Faucet is an OpenFlow controller for a layer 2 switch based on Waikato University's Valve. It handles MAC learning and supports VLANs and ACLs. It is developed as an application for the Ryu OpenFlow Controller .

It supports:

  • OpenFlow v1.3
  • Multiple datapaths (using a single process)
  • Mixed tagged/untagged ports
  • Port statistics
  • ACL support: Rules are added in the order specified. The rule language supports anything the Ryu OpenFlow protocol parser supports (q.v. ofctl to_match()).
  • Control unicast flooding by port and by VLAN
  • BGP advertisement of controller IPs and static routes and Quagga support
  • Policy based forwarding to offload processing to external systems (Eg 802.1x via hostapd)
  • Support for IPv4 and IPv6 static routes on both tagged and untagged VLANs
  • Integrated support for InfluxDB/Grafana
  • Comprehensive Test suite - tests for all features that can be run against mininet (development) and on hardware; Most tests run in parallel to reduce time.
  • Code: Python based, easy readability (PEP8 style), documented, Unit tests for all features
  • Installation: Python pip, pre-built VM available, Docker containers

Feature Details

ACL Support

Rules are added in the order specified. The rule language supports anything the Ryu OpenFlow protocol parser supports (q.v. ofctl to_match()). In this example,configure an ACL on port 1, default deny, that passes an IPv4 subnet and ARP. Following config applies an input ACL to port 1.

Supports any ACL rule that to_match() supports.

version: 2

        dp_id: 0x000000000001
                native_vlan: 2040
                acl_in: 1

        name: "dev VLAN"

        - rule:
            nw_dst: ""
            dl_type: 0x800
            allow: 1

        - rule:
            dl_type: 0x0806
            allow: 1

        - rule:
            nw_dst: ""
            dl_type: 0x800
            allow: 0

        - rule:

Unicast Flood

The default is to flood unknown unicast packets (of course). You might not want unicast flooding on a port for security reasons.

If you add unicast_flood: False to a port, then that port will never get unknown destinations flooded to it. So hosts on that port will have to say something to get learned (or someone will need to ND/ARP for it). Broadcasts and Ethernet multicasts are still flooded to that port (so of course ND and ARP work just fine).

You can also add unicast_flood: False to a VLAN, which will override all the ports. On my untrusted VLAN, the default gateway has permanent_learn enabled, and unicast flooding disabled.


Faucet is configured with a YAML-based configuration file. A sample configuration file is supplied in faucet.yaml.

The datapath ID may be specified as an integer or hex string (beginning with 0x).

A port not explicitly defined in the YAML configuration file will be set down and will drop all packets.


The Faucet configuration file format occasionally changes to add functionality or accommodate changes inside Faucet. If the version field must be specified faucet.yaml, with value 2.

Version 2 of the Faucet configuration file format allows multiple datapaths (switches) to be defined in one configuration file using the dps object, with each datapath sharing the vlans and acls objects defined in that file.

version: 2

        dp_id: 0x000000000001
                native_vlan: 2040
                acl_in: 1
        dp_id: 0x000000000002
                native_vlan: 2040
                acl_in: 1

        name: "dev VLAN"

        - rule:
            nw_dst: ""
            dl_type: 0x800
            allow: 1

        - rule:
            dl_type: 0x0806
            allow: 1

        - rule:
            nw_dst: ""
            dl_type: 0x800
            allow: 0

Extra DP, VLAN or ACL data can also be separated into different files and included into the main configuration file, as shown below. The include field is used for configuration files which are required to be loaded, and Faucet will log an error if there was a problem while loading a file. Files listed on include-optional will simply be skipped and a warning will be logged instead.

Files are parsed in order, and both absolute and relative (to the configuration file) paths are allowed. DPs, VLANs or ACLs defined in subsequent files overwrite previously defined ones with the same name.


version: 2

    - /etc/ryu/faucet/dps.yaml
    - /etc/ryu/faucet/vlans.yaml

    - acls.yaml


# Recursive include is allowed, if needed.
# Again, relative paths are relative to this configuration file.
    - override.yaml


Installation with pip

Installation automatically installs dependent Python packages [ryu, pyaml, influxdb client] recursively. You may have to install some Python support packages as well.

You have run this as root or use sudo

apt-get install python-dev # Required for Ubuntu
pip install ryu-faucet
pip show -f ryu-faucet

Optional Install for Network Monitoring Dashboard


To Uninstall the package

pip uninstall ryu-faucet

Installation with docker

We provide official automated builds on Docker Hub so that you can easily run Faucet and it's components in a self-contained environment without installing on the main host system.

Provided are two Docker containers, one for running Faucet and one for running Gauge. The Gauge container needs to be linked to a database container as well as a Grafana container. We also supply a docker-compose.yaml that can be used to start all the components together.

Docker tags are used to differentiate versions of Faucet, latest will always point to master branch on github and stable versions are also tagged e.g v1_3.

Running Faucet and Gauge with docker-compose

  1. Follow the Docker Installation Guide and install Docker Compose.
  2. Tweak environment variables, exposed ports, volumes and tags in docker-compose.yaml to match your environment.
  3. Run docker-compose up which will pull all the correct images and start them.

For more advanced documentation on running Faucet with docker please read





Deployment at Open Networking Foundation


Faucet Deployment around the World

OpenFlow Pipeline

As of Faucet v1.3 release, ACL table is now Table 0 so that actions like port mirroring happen without packet modifications and processing. VLAN table is now Table 1.

PACKETS IN                  +-------------------------+ +-------------------------+
  +                         |                         | |                         |
  |                         |                         | |        CONTROLLER       |
  |                         |                         | |            ^            |
  |                         |                         v |       +----+-----+      v
  |     +----------+  +-----+----+  +----------+  +---+-+----+  |4:IPv4_FIB|  +---+------+  +----------+
  |     |0:PORT_ACL|  |1:VLAN    |  |2:VLAN_ACL|  |3:ETH_SRC +->+          +->+6:ETH_DST |  |7:FLOOD   |
  +---->+          |  |          |  |          |  |          |  |          |  |          |  |          |
        |          |  |          |  |          |  |          |  +----------+  |          |  |          |
        |          |  |          |  |          |  |          |                |          |  |          |
        |          +->+          +->+          +->+          +--------------->+          +->+          |
        |          |  |          |  |          |  |          |                |          |  |          |
        |          |  |          |  |          |  |          |  +----------+  |          |  |          |
        |          |  |          |  |          |  |          |  |5:IPv6_FIB|  |          |  |          |
        |          |  |          |  |          |  |          +->+          +->+          |  |          |
        +----------+  +----------+  +----------+  +----+-----+  |          |  +------+---+  +--+-------+
                                                       |        +----+-----+         |         |
                                                       v             v               v         v
                                                    CONTROLLER    CONTROLLER          PACKETS OUT


Note: On your system, depending on how Python is installed, you may have to install some additional packages to run faucet.

Run with ryu-manager (uses /etc/ryu/faucet/faucet.yaml as configuration by default):

# export FAUCET_CONFIG=/etc/ryu/faucet/faucet.yaml
# export GAUGE_CONFIG=/etc/ryu/faucet/gauge.yaml
# export FAUCET_LOG=/var/log/faucet/faucet.log
# export FAUCET_EXCEPTION_LOG=/var/log/faucet/faucet_exception.log
# export GAUGE_LOG=/var/log/faucet/gauge_exception.log
# export GAUGE_EXCEPTION_LOG=/var/log/faucet/gauge_exception.log
# export GAUGE_DB_CONFIG=/etc/ryu/faucet/gauge_db.yaml
# $EDITOR /etc/ryu/faucet/faucet.yaml
# ryu-manager --verbose

To find the location of, run pip show ryu-faucet to get the Location Path. Then run:

# ryu-manager --verbose <Location_Path>/ryu_faucet/org/onfsdn/faucet/

Alternatively, if OF Controller is using a non-default port of 6633, for example 6653, then:

# ryu-manager --verbose  --ofp-tcp-listen-port 6653 <Location_Path>/ryu_faucet/org/onfsdn/faucet/

On Mac OS X, for example, one would run this as:

# ryu-manager --verbose /opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/ryu_faucet/org/onfsdn/faucet/

To specify a different configuration file set the FAUCET_CONFIG environment variable.

Faucet will log to /var/log/faucet/faucet.log and /var/log/faucet/faucet_exception.log by default, this can be changed with the FAUCET_LOG and FAUCET_EXCEPTION_LOG environment variables.

Gauge will log to /var/log/faucet/gauge.log and /var/log/faucet/gauge_exception.log by default, this can be changed with the GAUGE_LOG and GAUGE_EXCEPTION_LOG environment variables.

If running Faucet in virtualenv and without specifying the environment variables above, the default log and configuration locations will change to reflect the virtual environment's prefix path. For example, the default Faucet log location will be <venv prefix>/var/log/faucet/faucet.log. The Gauge configuration must still be updated in this case by modifying <venv prefix>/etc/ryu/faucet/gauge.yaml to reflect the location of the configuration file used by Faucet (<venv prefix>/etc/ryu/faucet/faucet.conf). When using virtualenv, also create the log directory at its new location, <venv prefix>/var/log/ryu/faucet, rather than the global /var/log/ryu/faucet.

To tell Faucet to reload its configuration file after you've changed it, simply send it a SIGHUP:

pkill -SIGHUP -f "ryu-manager"


Before issuing a Pull Request

Run the tests to make sure everything works! Mininet test actually spins up virtual hosts and a switch, and a test FAUCET controller, and checks connectivity between all the hosts given a test config. If you send a patch, this mininet test must pass.

git clone
cd faucet/tests
# (As namespace, etc needs to be setup, run the next command as root)
sudo ./

Working with Real Hardware

If you are a hardware vendor wanting to support FAUCET, you need to support all the matches in src/ryu_faucet/org/onfsdn/faucet/

Faucet has been tested against the following switches: (Hint: look at src/ryu_faucet/org/onfsdn/faucet/ to add your switch)

  1. Open vSwitch v2.1+
  2. Lagopus Openflow Switch
  3. Allied Telesis x510 and x930 series
  4. NoviFlow 1248
  5. Northbound Networks - Zodiac FX
  6. Hewlett Packard Enterprise - Aruba 5400R, 3810 and 2930F
  7. Netronome produces PCIe adaptors, with an OVS interface - Agilio CX 2x10GbE card

Faucet's design principle is to be as hardware agnostic as possible and not require Table Type Patterns. This means that Faucet expects the hardware Open Flow Agent (OFA) to hide implementation details, including which tables are best for certain matches or whether there is special support for multicast - Faucet expects the OFA to leverage the right hardware transparently.

Buying and running commercial switches supporting ryu-faucet

Guides for getting up and running with Faucet on vendor hardware are provided in the docs/vendors directory.

Allied Telesis

Allied Telesis sells their products via distributors and resellers. To order in USA call ProVantage. To find a sales office near you, visit Allied Telesis

  • On Allied Telesis, all vlans must be included in the vlan database config on the switch before they can be used by OpenFlow. When ordering, request Openflow license SKU.

NorthBound Networks

NorthBound Networks

FAUCET supports the Zodiac FX as of v0.60 firmware.

Hewlett Packard Enterprise

Hewlett Packard Enterprise and its many distributors and resellers.

All the HPE Aruba’s v3 based product line (5400R, 3810 and 2930F) work with FAUCET.

OpenFlow is available by default on all the firmware releases of each of these products. There is no need for a purchase of separate license to enable OpenFlow on the firmware.


Gauge is the monitoring application. It polls each port for statistics and periodically dumps the flow table for statistics.

Gauge reads the faucet yaml configuration files of the datapaths it monitors. Which datapaths to monitor is provided in a configuration file containing a list of faucet yaml files, one per line.

The list of faucet yaml config is by default read from /etc/ryu/faucet/gauge.yaml. This can be set with the GAUGE_CONFIG environment variable. Exceptions are logged to the same file as faucet's exceptions.

Gauge is run with ryu-manager:

$EDITOR /etc/ryu/faucet/gauge.yaml






We run a number of mailing lists for communication between users and developers of Faucet, as well as a low traffic mailing list for announcements of new versions:

Additional documentation is available under the docs directory.

Faucet blog by Josh Bailey available at

To create a issue, use GitHub Issues.