Last updated on: 2024-01-16 03:25:50.

f5os_interface – Manage network interfaces on F5OS based systems

New in version 1.0.0.

Synopsis

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

Parameters

Parameter Choices/Defaults Configuration Comments
name
string / required
Name of the interface to configure.
For VELOS partitions blade/port format is required e.g. 1/1.0
native_vlan
integer
Configures the VLAN ID to associate with the interface.
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 interface.
The trunk_vlans parameter is used for tagged traffic.
VLANs should not be assigned to interfaces if Link Aggregation Groups. In that case, VLANs should be added to the the LAG configuration with f5os_lag module instead.
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 Vlans to interface on Velos Partition
  f5os_interface:
    name: "2/1.0"
    trunk_vlans: [444]
    state: present

- name: Modify Vlans to interface on Velos Partition
  f5os_interface:
    name: "2/1.0"
    trunk_vlans: [444, 555]
    state: present

- name: Delete vlans on interface on Velos Partition
  f5os_interface:
    name: "1.0"
    trunk_vlans: [444, 555]
    state: absent

- name: Attach Vlans to interface on rSeries Platform
  f5os_interface:
    name: "1.0"
    trunk_vlans: [444]
    state: present

- name: Modify Vlans to interface on rSeries Platform
  f5os_interface:
    name: "1.0"
    trunk_vlans: [444, 555]
    state: present

- name: Delete vlans on interface on rSeries Platform
  f5os_interface:
    name: "1.0"
    trunk_vlans: [444, 555]
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
name
string
changed
Name of the partition interface to configure.

Sample:
1.0
native_vlan
integer
changed
Native VLAN to attach to the interface

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

Sample:
[444, 555]


Status

Authors

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