Last updated on: 2024-04-01 03:24:20.

f5os_lag – Manage LAG interfaces on F5OS based systems

New in version 1.0.0.

Synopsis

  • Manage LAG interfaces on F5OS systems like VELOS partitions or rSeries platforms.

Parameters

Parameter Choices/Defaults Configuration Comments
config_members
list / elements=string
Configures the list of interfaces to be grouped for the Link Aggregation Group (LAG).
For VELOS partitions blade/port interface format is required e.g. 1/1.0
interval
string
added in 1.6.0
    Choices:
  • slow
  • fast
The LACP interval of the interface to be created.
This parameter is useful only when lag_type is set to lacp.
lag_type
string
    Choices:
  • lacp
  • static
The LAG type of the interface to be created.
Parameter is required when creating new LAG interface.
mode
string
added in 1.6.0
    Choices:
  • active
  • passive
The LACP mode of the interface to be created.
This parameter is useful only when lag_type is set to lacp.
name
string / required
Name of the interface to configure.
native_vlan
integer
Configures the VLAN ID to associate with the Link Aggregation Group.
The native_vlans parameter is used for untagged traffic.
state
string
    Choices:
  • present ←
  • absent
If present, creates the specified object if it does not exist, or updates the existing object.
If absent, deletes the object if it exists.
trunk_vlans
list / elements=integer
Configures multiple VLAN IDs to associate with the Link Aggregation Group.
The trunk_vlans parameter is used for tagged traffic.
The order of these VLANs is ignored, the module orders the VLANs automatically.

Notes

Note

  • This module will not execute on VELOS controller.

Examples

- name: Creating VLAN444
  f5os_vlan:
    name: vlan-444
    vlan_id: 444

- name: Creating VLAN555
  f5os_vlan:
    name: vlan-555
    vlan_id: 555

- name: Attach Trunk-vlans to LAG to interface
  f5os_lag:
    name: "Arista"
    lag_type: "lacp"
    trunk_vlans: [444]
    state: present

- name: Modify Vlans to LAG interface
  f5os_lag:
    name: "Arista"
    trunk_vlans: [444, 555]
    state: present

- name: Add interfaces to LAG on Velos Partition
  f5os_lag:
    name: "Arista"
    config_members:
      - "1/1.0"
    state: present

- name: Add interfaces to LAG on rSeries Platform
  f5os_lag:
    name: "Arista"
    config_members:
      - "1.0"
    state: present

- name: Delete LAG interface
  f5os_lag:
    name: "Arista"
    trunk_vlans: [444, 555]
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
config_members
list
changed
The list of interfaces to be grouped for the Link Aggregation Group

Sample:
['1.0', '2.0']
lag_type
string
changed
The LAG type of the interface to be created.

Sample:
static
name
string
changed
Name of the partition LAG interface to configure

Sample:
new_name
native_vlan
integer
changed
Native VLAN to attach to LAG interface

Sample:
222
trunk_vlans
list
changed
Trunk VLANs to attach to LAG interface

Sample:
[444, 555]


Status

Authors

  • Ravinder Reddy (@chinthalapalli)
  • Wojciech Wypior (@wojtek0806)