Bug ID 1016629: System allows creation of VLAN names that are too long

Last Modified: May 29, 2024

Affected Product(s):
F5OS Install/Upgrade, Velos(all modules)

Known Affected Versions:
F5OS-C 1.1.2, F5OS-C 1.1.3, F5OS-C 1.1.4

Fixed In:
F5OS-A 1.0.0

Opened: May 06, 2021

Severity: 3-Major

Symptoms

The /vlans/vlan/config/name value is a free format string. Creating long VLAN names can violate common naming rules.

Impact

The F5OS software does not prevent you from creating VLAN names that are too long, however, the BIG-IP system cannot use them. Note: When this issue is fixed, VLAN names in configurations and scripts will no longer behave as expected. Before upgrading, make sure to follow the instructions in Behavior Change to ensure your upgrade succeeds.

Conditions

Creating VLANs whose names are longer than 56 characters (encountered at the /vlans/vlan/config/name endpoint).

Workaround

Create shorter VLAN names.

Fix Information

VLAN names now have the following constraints: - May start with an alphabetic character (Aa-Zz). - Cannot exceed 56 characters in length. - May contain alpha-numeric characters, periods (.), hyphens (-), and underscores (_). - Must be unique among VLANs. !Important! Before upgrading: -- Ensure that all VLAN names meet these constraints. -- Update any scripts that create VLANs whose names violate these constraints.

Behavior Change

VLAN names now have the following constraints: - May start with an alphabetic character (Aa-Zz). - Cannot exceed 56 characters in length. - May contain alpha-numeric characters, periods (.), hyphens (-), and underscores (_). - Must be unique among VLANs. Important upgrade information: Before upgrading: -- Ensure that all VLAN names meet these constraints. -- Update any scripts that create VLANs whose names violate these constraints. -- Configurations from previous versions containing /vlans/vlan/config/name strings that do not meet the new validation rules will fail to load after upgrade. -- Configuration scripts with /vlans/vlan/config/name strings that do not meet the new validation rules will fail after upgrade.

Guides & references

K10134038: F5 Bug Tracker Filter Names and Tips