Last updated on: 2024-04-01 03:24:20.
f5os_vlan – Manage VLANs on F5OS based systems¶
New in version 1.0.0.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
name
string
|
Specifies the name of the VLAN to configure on the F5OS platform.
This parameter is required when creating a resource.
The first character must be a letter, alphanumeric characters are allowed.
Periods, commas, hyphens, and underscores are allowed.
The name cannot exceed 58 characters.
|
||
state
string
|
|
The partition VLAN state.
If
present , creates the specified VLAN if it does not exist, or updates the existing VLAN.If
absent , deletes the VLAN if it exists. |
|
vlan_id
integer
/ required
|
The ID for the VLAN.
Valid value range is from
0 to 4095 . |
Examples¶
- name: Create a vlan on partition
f5os_vlan:
name: foo
vlan_id: 3212
- name: Update name of a vlan on partition
f5os_vlan:
name: changed_this
vlan_id: 3212
- name: Delete vlan on partition
f5os_vlan:
vlan_id: 3212
state: absent
Return Values¶
The following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
name
string
|
changed |
The name of the VLAN.
Sample:
new_name
|
vlan_id
integer
|
changed |
The ID of the VLAN.
Sample:
1234
|