faucet.faucet module

RyuApp shim between Ryu and Valve.

class faucet.faucet.EventFaucetAdvertise

Bases: ryu.controller.event.EventBase

Event used to trigger periodic network advertisements (eg IPv6 RAs).

class faucet.faucet.EventFaucetEventSockHeartbeat

Bases: ryu.controller.event.EventBase

Event used to trigger periodic events on event sock, causing it to raise an exception if conn is broken.

class faucet.faucet.EventFaucetExperimentalAPIRegistered

Bases: ryu.controller.event.EventBase

Event used to notify that the API is registered with Faucet.

class faucet.faucet.EventFaucetFastAdvertise

Bases: ryu.controller.event.EventBase

Event used to trigger periodic fast network advertisements (eg LACP).

class faucet.faucet.EventFaucetFastStateExpire

Bases: ryu.controller.event.EventBase

Event used to trigger fast expiration of state in controller.

class faucet.faucet.EventFaucetMaintainStackRoot

Bases: ryu.controller.event.EventBase

Event used to maintain stack root.

class faucet.faucet.EventFaucetMetricUpdate

Bases: ryu.controller.event.EventBase

Event used to trigger update of metrics.

class faucet.faucet.EventFaucetResolveGateways

Bases: ryu.controller.event.EventBase

Event used to trigger gateway re/resolution.

class faucet.faucet.EventFaucetStateExpire

Bases: ryu.controller.event.EventBase

Event used to trigger expiration of state in controller.

class faucet.faucet.Faucet(*args, **kwargs)

Bases: faucet.valve_ryuapp.RyuAppBase

A RyuApp that implements an L2/L3 learning VLAN switch.

Valve provides the switch implementation; this is a shim for the Ryu event handling framework to interface with Valve.

bgp = None

desc_stats_reply_handler(ryu_event)

Handle OFPDescStatsReply from datapath.

Parameters

ryu_event (ryu.controller.ofp_event.EventOFPDescStatsReply) – trigger.

error_handler(ryu_event)

Handle an OFPError from a datapath.

Parameters

ryu_event (ryu.controller.ofp_event.EventOFPErrorMsg) – trigger

event_socket_heartbeat_time = 0

exc_logname = 'faucet.exception'

features_handler(ryu_event)

Handle receiving a switch features message from a datapath.

Parameters

ryu_event (ryu.controller.ofp_event.EventOFPStateChange) – trigger.

flowremoved_handler(ryu_event)

Handle a flow removed event.

Parameters

ryu_event (ryu.controller.ofp_event.EventOFPFlowRemoved) – trigger.

get_config()

FAUCET experimental API: return config for all Valves.

get_tables(dp_id)

FAUCET experimental API: return config tables for one Valve.

logname = 'faucet'

metric_update(_)

Handle a request to update metrics in the controller.

metrics = None

notifier = None

packet_in_handler(ryu_event)

Handle a packet in event from the dataplane.

Parameters

ryu_event (ryu.controller.event.EventReplyBase) – packet in message.

port_status_handler(ryu_event)

Handle a port status change event.

Parameters

ryu_event (ryu.controller.ofp_event.EventOFPPortStatus) – trigger.

reload_config(ryu_event)

Handle a request to reload configuration.

start()

Start controller.

valves_manager = None