dellemc.enterprise_sonic.sonic_vlans – Manage VLAN and its parameters
Note
This plugin is part of the dellemc.enterprise_sonic collection (version 1.1.0).
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 dellemc.enterprise_sonic.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_vlans.
New in version 1.0.0: of dellemc.enterprise_sonic
Synopsis
- This module provides configuration management of VLANs parameters on devices running Enterprise SONiC Distribution by Dell Technologies.
Note
This module has a corresponding action plugin.
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| config
list / elements=dictionary
|
A dictionary of VLAN options.
|
||
| vlan_id
integer / required
|
ID of the VLAN
Range is 1 to 4094
|
||
| state
string
|
|
The state that the configuration should be left in.
|
|
Notes
Note
- Tested against Enterprise SONiC Distribution by Dell Technologies.
- Supports
check_mode.
Examples
# Using merged
# Before state:
# -------------
#
#sonic# show Vlan
#Q: A - Access (Untagged), T - Tagged
#NUM Status Q Ports
#10 Inactive
#30 Inactive
#
#sonic#
#
- name: Merges given VLAN attributes with the device configuration
dellemc.enterprise_sonic.sonic_vlans:
config:
- vlan_id: 10
state: merged
# After state:
# ------------
#
#sonic# show Vlan
#Q: A - Access (Untagged), T - Tagged
#NUM Status Q Ports
#10 Inactive
#30 Inactive
#
#sonic#
#
#sonic# show interface Vlan 10
#Vlan10 is up
#Mode of IPV4 address assignment: not-set
#Mode of IPV6 address assignment: not-set
#IP MTU 6000 bytes
#sonic#
#
# Using deleted
# Before state:
# -------------
#
#sonic# show Vlan
#Q: A - Access (Untagged), T - Tagged
#NUM Status Q Ports
#10 Inactive
#20 Inactive
#
#sonic#
- name: Deletes attributes of the given VLANs
dellemc.enterprise_sonic.sonic_vlans:
config:
- vlan_id: 20
state: deleted
# After state:
# ------------
#
#sonic# show Vlan
#Q: A - Access (Untagged), T - Tagged
#NUM Status Q Ports
#10 Inactive
#
#sonic#
# Using deleted
# Before state:
# -------------
#
#sonic# show Vlan
#Q: A - Access (Untagged), T - Tagged
#NUM Status Q Ports
#10 Inactive
#20 Inactive
#30 Inactive
#
#sonic#
- name: Deletes all the VLANs on the switch
dellemc.enterprise_sonic.sonic_vlans:
config:
state: deleted
# After state:
# ------------
#
#sonic# show Vlan
#Q: A - Access (Untagged), T - Tagged
#NUM Status Q Ports
#
#sonic#
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| after
list / elements=string
|
when changed |
The resulting configuration model invocation.
Sample:
The configuration returned is always in the same format of the parameters above.
|
| before
list / elements=string
|
always |
The configuration prior to the model invocation.
Sample:
The configuration that is returned is always in the same format of the parameters above.
|
| commands
list / elements=string
|
always |
The set of commands pushed to the remote device.
Sample:
['command 1', 'command 2', 'command 3']
|
Authors
- Mohamed Javeed (@javeedf)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/enterprise_sonic/sonic_vlans_module.html