f5networks.f5_modules.bigip_vlan module – Manage VLANs on a BIG-IP system
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_vlan
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage VLANs on a BIG-IP system
Parameters
Parameter |
Comments |
---|---|
Specifies how the traffic on the VLAN is disaggregated. The value you select determines the traffic disaggregation method. You can choose to disaggregate traffic based on When creating a new VLAN, if this parameter is not specified, the default is Choices:
|
|
Specifies whether some of the stateless traffic on the VLAN should be disaggregated in a round-robin order instead of using a static hash. The stateless traffic includes non-IP L2 traffic, ICMP, some UDP protocols, and so on. When creating a new VLAN, if this parameter is not specified, the default is (false). Choices:
|
|
Specifies how the disaggregator (DAG) distributes received tunnel-encapsulated packets to TMM instances. Select When creating a new VLAN, if this parameter is not specified, the default is This parameter is not supported on Virtual Editions (VEs) of BIG-IP. Choices:
|
|
The description of the VLAN. |
|
When Choices:
|
|
Specifies the action the system takes when it does not detect any traffic on this VLAN, and the Choices:
|
|
Specifies the number of seconds a system can run without detecting network traffic on this VLAN before it takes the |
|
Enables hardware syncookie mode on a VLAN. When Choices:
|
|
Interfaces you want to add to the VLAN. This can include both tagged and untagged interfaces, as the This parameter is mutually exclusive with the |
|
The name of the interface |
|
Whether the interface is Choices:
|
|
Specifies the maximum transmission unit (MTU) for traffic on this VLAN. When creating a new VLAN, if this parameter is not specified, the default value used is This number must be between 576 to 9198. |
|
The VLAN to manage. If the special VLAN |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the maximum interval in seconds between two pollings. |
|
Specifies the ratio of packets observed to the samples generated. |
|
When The system performs this verification only if the Choices:
|
|
The state of the VLAN on the system. When Choices:
|
|
Tag number for the VLAN. The tag number can be any integer between 1 and 4094. The system automatically assigns a tag number if you do not specify a value. |
|
Specifies a list of tagged interfaces and trunks you want to configure for the VLAN. Use tagged interfaces or trunks when you want to assign a single interface or trunk to multiple VLANs. This parameter is mutually exclusive with the |
|
Specifies a list of untagged interfaces and trunks you want to configure for the VLAN. This parameter is mutually exclusive with the |
Notes
Note
Requires BIG-IP versions >= 12.0.0
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create VLAN
bigip_vlan:
name: net1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Set VLAN tag
bigip_vlan:
name: net1
tag: 2345
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add VLAN 2345 as tagged to interface 1.1
bigip_vlan:
tagged_interface: 1.1
name: net1
tag: 2345
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Add VLAN 1234 as tagged to interfaces 1.1 and 1.2
bigip_vlan:
tagged_interfaces:
- 1.1
- 1.2
name: net1
tag: 1234
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
New traffic disaggregation method. Returned: changed Sample: |
|
The new DAG tunnel setting. Returned: changed Sample: |
|
The description set on the VLAN. Returned: changed Sample: |
|
The new Fail Safe setting. Returned: changed Sample: |
|
The new Fail Safe Action setting. Returned: changed Sample: |
|
The new Fail Safe Timeout setting. Returned: changed Sample: |
|
Enables hardware syncookie mode on a VLAN. Returned: changed Sample: |
|
Interfaces the VLAN is assigned to. Returned: changed Sample: |
|
The partition the VLAN was created on. Returned: changed Sample: |
|
The new sFlow Polling Interval setting. Returned: changed Sample: |
|
The new sFlow Sampling Rate setting. Returned: changed Sample: |
|
The new Source Check setting. Returned: changed Sample: |
|
The ID of the VLAN. Returned: changed Sample: |