junos_vlan - Manage VLANs on Juniper JUNOS network devices
New in version 2.4.
Synopsis
- This module provides declarative management of VLANs on Juniper JUNOS network devices.
Requirements (on host that executes module)
- ncclient (>=v0.5.2)
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
active | no | True |
| Specifies whether or not the configuration is active or deactivated |
aggregate | no | List of VLANs definitions. | ||
description | no | Text description of VLANs. | ||
interfaces | no | List of interfaces to check the VLAN has been configured correctly. | ||
name | yes | Name of the VLAN. | ||
state | no | present |
| State of the VLAN configuration. |
vlan_id | yes | ID of the VLAN. |
Examples
- name: configure VLAN ID and name junos_vlan: vlan_name: test vlan_id: 20 name: test-vlan - name: remove VLAN configuration junos_vlan: vlan_name: test state: absent - name: deactive VLAN configuration junos_vlan: vlan_name: test state: present active: False - name: activate VLAN configuration junos_vlan: vlan_name: test state: present active: True - name: Create vlan configuration using aggregate junos_vlan: aggregate: - { vlan_id: 159, name: test_vlan_1, description: test vlan-1 } - { vlan_id: 160, name: test_vlan_2, description: test vlan-2 } - name: Delete vlan configuration using aggregate junos_vlan: aggregate: - { vlan_id: 159, name: test_vlan_1 } - { vlan_id: 160, name: test_vlan_2 } state: absent
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
diff.prepared | Configuration difference before and after applying change. | when configuration is changed and diff option is enabled. | string | [edit vlans] + test-vlan-1 { + vlan-id 60; + } |
Notes
Note
- This module requires the netconf system service be enabled on the remote device being managed.
- Tested against vSRX JUNOS version 15.1X49-D15.4, vqfx-10000 JUNOS Version 15.1X53-D60.4.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/junos_vlan_module.html