f5os_fdb – Manage Layer 2 forwarding database (FDB) entry in the system

New in version 1.15.0.

Synopsis

  • Manage Layer 2 forwarding database (FDB) entry in the F5OS based systems like VELOS partitions or rSeries platforms.

Parameters

Parameter Choices/Defaults Configuration Comments
interface
string / required
The interface on which the MAC address is learned/Static Mapped for the FDB object
mac_address
string / required
Hex list representation of the Layer 2 MAC address.
The format must be exactly 6 octets in the format xx:xx:xx:xx:xx:xx
state
string
    Choices:
  • present ←
  • absent
The Layer 2 forwarding database (FDB) state.
If present, creates Layer 2 forwarding database (FDB) if it does not exist, or updates the existing Layer 2 forwarding database (FDB).
If absent, deletes the Layer 2 forwarding database (FDB) if it exists.
tag_type
string
    Choices:
  • tag_type_vid
  • tag_type_vlan_tag
  • tag_type_vni
  • tag_type_s_tag_c_tag
The manner in which the FDB will interpret the VLAN value during lookup processing
vlan_id
integer / required
The ID of the VLAN that is associated with the mac-address for the FDB object
Valid value range is from 0 to 4095.

Notes

Note

  • This module will not execute on VELOS controller.

Examples

- name: Create Layer 2 forwarding database (FDB) entry in the system
  f5os_fdb:
    mac_address: 11:22:33:44:55:66
    vlan_id: 1234
    interface: 1.0
    state: present

- name: Update Layer 2 forwarding database (FDB) entry in the system
  f5os_fdb:
    mac_address: 11:22:33:44:55:66
    vlan_id: 1234
    interface: 1.0
    state: present

- name: Layer 2 forwarding database (FDB) entry in the system
  f5os_fdb:
    mac_address: 11:22:33:44:55:66
    vlan_id: 1234
    interface: 1.0
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
interface
string
changed
The interface for the FDB object

Sample:
1.0
mac_address
string
changed
The name of the VLAN.

Sample:
xx:xx:xx:xx:xx:xx
vlan_id
integer
changed
The ID of the VLAN.

Sample:
1234


Status

Authors

  • Ravinder Reddy Chinthalapalli (@chinthalapalli)