community.network.icx_vlan module – Manage VLANs on Ruckus ICX 7000 series switches
Note
This module is part of the community.network collection (version 5.0.3).
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 community.network
.
To use it in a playbook, specify: community.network.icx_vlan
.
Synopsis
This module provides declarative management of VLANs on ICX network devices.
Aliases: network.icx.icx_vlan
Parameters
Parameter |
Comments |
---|---|
List of VLANs definitions. |
|
This is a intent option and checks the operational state of the for given vlan |
|
This is a intent option and checks the operational state of given vlan |
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Delay the play should wait to check for declarative intent params values. |
|
List of ethernet ports or LAGS to be added as access(untagged) ports to the vlan. To add a range of ports use ‘to’ keyword. See the example. |
|
Name of the interface or lag |
|
Purge interfaces not defined in the name Choices:
|
|
Enables dynamic ARP inspection on a VLAN. Choices:
|
|
Enables DHCP snooping on a VLAN. Choices:
|
|
Name of the VLAN. |
|
State of the VLAN configuration. Choices:
|
|
Enable spanning-tree 802-1w/rstp for this vlan. |
|
Manage the state(Enable/Disable) of the spanning_tree_802_1w in the current vlan Choices:
|
|
Configures the priority of the bridge. The value ranges from 0 through 65535. A lower numerical value means the bridge has a higher priority. Thus, the highest priority is 0. The default is 32768. |
|
Specify the type of spanning-tree Choices:
|
|
List of ethernet ports or LAGS to be added as trunk(tagged) ports to the vlan. To add a range of ports use ‘to’ keyword. See the example. |
|
Name of the interface or lag |
|
Purge interfaces not defined in the name Choices:
|
|
ID of the VLAN. Range 1-4094. |
|
This is a intent option and checks the operational state of the for given vlan |
|
This is a intent option and checks the operational state of given vlan |
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Delay the play should wait to check for declarative intent params values. Default: |
|
List of ethernet ports or LAGS to be added as access(untagged) ports to the vlan. To add a range of ports use ‘to’ keyword. See the example. |
|
Name of the interface or lag |
|
Purge interfaces not defined in the name Choices:
|
|
Enables dynamic ARP inspection on a VLAN. Choices:
|
|
Enables DHCP snooping on a VLAN. Choices:
|
|
Name of the VLAN. |
|
Purge VLANs not defined in the aggregate parameter. Choices:
|
|
State of the VLAN configuration. Choices:
|
|
Enable spanning-tree 802-1w/rstp for this vlan. |
|
Manage the state(Enable/Disable) of the spanning_tree_802_1w in the current vlan Choices:
|
|
Configures the priority of the bridge. The value ranges from 0 through 65535. A lower numerical value means the bridge has a higher priority. Thus, the highest priority is 0. The default is 32768. |
|
Specify the type of spanning-tree Choices:
|
|
List of ethernet ports or LAGS to be added as trunk(tagged) ports to the vlan. To add a range of ports use ‘to’ keyword. See the example. |
|
Name of the interface or lag |
|
Purge interfaces not defined in the name Choices:
|
|
ID of the VLAN. Range 1-4094. |
Notes
Note
Tested against ICX 10.1.
For information on using ICX platform, see the ICX OS Platform Options guide.
Examples
- name: Add a single ethernet 1/1/48 as access(untagged) port to vlan 20
community.network.icx_vlan:
name: test-vlan
vlan_id: 20
interfaces:
name:
- ethernet 1/1/48
- name: Add a single LAG 10 as access(untagged) port to vlan 20
community.network.icx_vlan:
vlan_id: 20
interfaces:
name:
- lag 10
- name: Add a range of ethernet ports as trunk(tagged) ports to vlan 20 by port
community.network.icx_vlan:
vlan_id: 20
tagged:
name:
- ethernet 1/1/40 to 1/1/48
- name: Add discontinuous lags, ethernet ports as access(untagged) and trunk(tagged) port to vlan 20.
community.network.icx_vlan:
vlan_id: 20
interfaces:
name:
- ethernet 1/1/40 to 1/1/48
- ethernet 2/1/1
- lag 1
- lag 3 to 5
tagged:
name:
- ethernet 1/1/20 to 1/1/25
- lag 1 to 3
- name: Remove an access and range of trunk ports from vlan
community.network.icx_vlan:
vlan_id: 20
interfaces:
name:
- ethernet 1/1/40
tagged:
name:
- ethernet 1/1/39 to 1/1/70
- name: Enable dhcp snooping, disable arp inspection in vlan
community.network.icx_vlan:
vlan_id: 20
ip_dhcp_snooping: present
ip_arp_inspection: absent
- name: Create vlan 20. Enable arp inspection in vlan. Purge all other vlans.
community.network.icx_vlan:
vlan_id: 20
ip_arp_inspection: present
purge: present
- name: Remove vlan 20.
community.network.icx_vlan:
vlan_id: 20
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |