faucet.port module

Port configuration.

class faucet.port.Port(_id, dp_id, conf=None)

Bases: faucet.conf.Conf

Stores state for ports, including the configuration.

acl_in = None

acls_in = None

check_config()

As far as possible, check config at instantiation time for errors, typically via assert.

defaults = {'acl_in': None, 'acls_in': None, 'description': None, 'enabled': True, 'hairpin': False, 'lacp': 0, 'lldp_beacon': {}, 'loop_protect': False, 'max_hosts': 255, 'mirror': None, 'name': None, 'native_vlan': None, 'number': None, 'opstatus_reconf': True, 'output_only': False, 'override_output_port': None, 'permanent_learn': False, 'receive_lldp': False, 'stack': None, 'tagged_vlans': None, 'unicast_flood': True}

defaults_types = {'acl_in': (<class 'str'>, <class 'int'>), 'acls_in': <class 'list'>, 'description': <class 'str'>, 'enabled': <class 'bool'>, 'hairpin': <class 'bool'>, 'lacp': <class 'int'>, 'lldp_beacon': <class 'dict'>, 'loop_protect': <class 'bool'>, 'max_hosts': <class 'int'>, 'mirror': (<class 'list'>, <class 'str'>, <class 'int'>), 'name': <class 'str'>, 'native_vlan': (<class 'str'>, <class 'int'>), 'number': <class 'int'>, 'opstatus_reconf': <class 'bool'>, 'output_only': <class 'bool'>, 'override_output_port': (<class 'str'>, <class 'int'>), 'permanent_learn': <class 'bool'>, 'receive_lldp': <class 'bool'>, 'stack': <class 'dict'>, 'tagged_vlans': <class 'list'>, 'unicast_flood': <class 'bool'>}

description = None

dp_id = None

dyn_lacp_up = None

dyn_lacp_updated_time = None

dyn_last_ban_time = None

dyn_last_lacp_pkt = None

dyn_last_lldp_beacon_time = None

dyn_learn_ban_count = 0

dyn_phys_up = False

enabled = None

finalize()

Configuration parsing marked complete.

hairpin = None

hosts(vlans=None)

Return all host cache entries this port has learned (on all or specified VLANs).

hosts_count(vlans=None)

Return count of all hosts this port has learned (on all or specified VLANs).

lldp_beacon = {}

lldp_beacon_defaults_types = {'enable': <class 'bool'>, 'org_tlvs': <class 'list'>, 'port_descr': <class 'str'>, 'system_name': <class 'str'>}

lldp_beacon_enabled()

Return True if LLDP beacon enabled on this port.

lldp_org_tlv_defaults_types = {'info': (<class 'str'>, <class 'bytearray'>), 'oui': (<class 'int'>, <class 'bytearray'>), 'subtype': (<class 'int'>, <class 'bytearray'>)}

loop_protect = None

max_hosts = None

mirror = None

mirror_actions()

Return OF actions to mirror this port.

name = None

native_vlan = None

number = None

op_status_reconf = None

output_only = None

override_output_port = None

permanent_learn = None

receive_lldp = None

running()

Return True if port enabled and up.

set_defaults()

Set default values and run any basic sanity checks.

stack = {}

stack_defaults_types = {'dp': <class 'str'>, 'port': (<class 'str'>, <class 'int'>)}

tagged_vlans = []

to_conf()

Return configuration as a dict.

unicast_flood = None

vlans()

Return list of all VLANs this port is in.