faucet.vlan module

VLAN configuration.

class faucet.vlan.AnyVLAN

Bases: object

Placeholder any tagged VLAN. NOTE: Not used, not well supported by hardware

name = 'Any VLAN'

vid = 4096

class faucet.vlan.HostCacheEntry(eth_src, port, cache_time)

Bases: object

Association of a host with a port.

cache_time

eth_src

eth_src_int

port

class faucet.vlan.NullVLAN

Bases: object

Placeholder null VLAN.

name = 'Null VLAN'

vid = 0

class faucet.vlan.OFVLAN(name, vid)

Bases: object

OpenFlow VLAN.

class faucet.vlan.VLAN(_id, dp_id, conf=None)

Bases: Conf

Contains state for one VLAN, including its configuration.

add_cache_host(eth_src, port, cache_time)

Add/update a host to the cache on a port at at time.

add_route(ip_dst, ip_gw)

Add an IP route.

all_ip_gws(ipv)

Return all IP gateways for specified IP version.

cached_host(eth_src)

Return host from cache or None.

cached_host_on_port(eth_src, port)

Return host cache entry if host in cache and on specified port.

cached_hosts_count_on_port(port)

Return count of all hosts learned on a port.

cached_hosts_on_port(port)

Return all hosts learned on a port.

check_config()

Check config at instantiation time for errors, typically via assert.

clear_cache_hosts_on_port(port)

Clear all hosts learned on a port.

defaults: dict = {'acl_in': None, 'acl_out': None, 'acls_in': None, 'acls_out': None, 'description': None, 'dot1x_assigned': False, 'edge_learn_stack_root': True, 'faucet_mac': '0e:00:00:00:00:01', 'faucet_vips': None, 'max_hosts': 256, 'minimum_ip_size_check': True, 'name': None, 'proactive_arp_limit': 0, 'proactive_nd_limit': 0, 'reserved_internal_vlan': False, 'routes': None, 'targeted_gw_resolution': True, 'unicast_flood': True, 'vid': None}

defaults_types: dict = {'acl_in': (<class 'int'>, <class 'str'>), 'acl_out': (<class 'int'>, <class 'str'>), 'acls_in': <class 'list'>, 'acls_out': <class 'list'>, 'description': <class 'str'>, 'dot1x_assigned': <class 'bool'>, 'edge_learn_stack_root': <class 'bool'>, 'faucet_mac': <class 'str'>, 'faucet_vips': <class 'list'>, 'max_hosts': <class 'int'>, 'minimum_ip_size_check': <class 'bool'>, 'name': <class 'str'>, 'proactive_arp_limit': <class 'int'>, 'proactive_nd_limit': <class 'int'>, 'reserved_internal_vlan': <class 'bool'>, 'routes': <class 'list'>, 'targeted_gw_resolution': <class 'bool'>, 'unicast_flood': <class 'bool'>, 'vid': <class 'int'>}

del_route(ip_dst)

Delete an IP route.

exclude_native_if_dot1x()

Don’t output on native vlan, if dynamic (1x) vlan is in use

excluded_lag_ports(in_port=None)

Ensure output to SELECTED LAG ports & only one LAG member

expire_cache_host(eth_src)

Expire a host from caches.

expire_cache_hosts(now, learn_timeout)

Expire stale host entries.

faucet_vips_by_ipv(ipv)

Return VIPs with specified IP version on this VLAN.

flood_pkt(packet_builder, multi_out, *args)

Return Packet-out actions via flooding

static flood_ports(configured_ports, exclude_unicast)

Return configured ports that allow flooding

from_connected_to_vip(src_ip, dst_ip)

Return True if src_ip in connected network and dst_ip is a VIP.

Parameters:

• src_ip (ipaddress.ip_address) – source IP.

• dst_ip (ipaddress.ip_address) – destination IP

Returns:

True if local traffic for a VIP.

get_ports()

Return all ports on this VLAN.

hairpin_ports()

Return all ports with hairpin enabled.

hosts_count()

Return number of hosts learned on this VLAN.

ip_dsts_for_ip_gw(ip_gw)

Return list of IP destinations, for specified gateway.

ip_in_vip_subnet(ipa, faucet_vip=None)

Return faucet_vip if IP in same IP network as a VIP on this VLAN.

ipvs()

Return IP versions configured on this VLAN.

is_faucet_vip(ipa, faucet_vip=None)

Return True if IP is a VIP on this VLAN.

is_host_fib_route(host_ip)

Return True if IP destination is a host FIB route.

Parameters:

host_ip – (ipaddress.ip_address): potential host FIB route.

Returns:

True if a host FIB route (and not used as a gateway).

lacp_ports()

Return ports that have LACP on this VLAN.

lacp_up_selected_ports()

Return LACP ports that have been SELECTED and are UP

lags()

Return dict of LAGs mapped to member ports.

link_and_other_vips(ipv)

Return link local and non-link local VIPs.

loop_protect_external_ports()

Return ports wth external loop protection set.

loop_protect_external_ports_up()

Return up ports with external loop protection set.

mirrored_ports()

Return ports that are mirrored on this VLAN.

mutable_attrs: frozenset = frozenset({'dot1x_untagged', 'tagged', 'untagged'})

neigh_cache_by_ipv(ipv)

Return neighbor cache for specified IP version on this VLAN.

neigh_cache_count_by_ipv(ipv)

Return number of hosts in neighbor cache for specified IP version on this VLAN.

output_port(port, hairpin=False, output_table=None, external_forwarding_requested=None)

pkt_out_port(packet_builder, port, *args)

Return packet-out actions with VLAN tag if port is tagged

port_is_tagged(port)

Return True if port number is an tagged port on this VLAN.

port_is_untagged(port)

Return True if port number is an untagged port on this VLAN.

reset_caches()

Reset dynamic caches.

reset_ports(ports)

Reset tagged and untagged port lists.

restricted_bcast_arpnd_ports()

Return all ports with restricted broadcast enabled.

route_count_by_ipv(ipv)

Return route table count for specified IP version on this VLAN.

routes_by_ipv(ipv)

Return route table for specified IP version on this VLAN.

selected_up_lags()

Return dict of LAGs mapped to member ports that have been selected

set_defaults()

Set default values and run any basic sanity checks.

tagged_flood_ports(exclude_unicast)

untagged_flood_ports(exclude_unicast)

static vid_valid(vid)

Return True if VID valid.

vip_map(ipa)

Return the vip containing ipa