junipernetworks.junos.junos_vlan – (deprecated, removed after 2022-06-01) Manage VLANs on Juniper JUNOS network devices¶
Note
This plugin is part of the junipernetworks.junos collection (version 1.3.0).
To install it use: ansible-galaxy collection install junipernetworks.junos
.
To use it in a playbook, specify: junipernetworks.junos.junos_vlan
.
New in version 1.0.0: of junipernetworks.junos
DEPRECATED¶
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use junipernetworks.junos.junos_vlans instead.
Synopsis¶
This module provides declarative management of VLANs on Juniper JUNOS network devices.
Note
This module has a corresponding action plugin.
Requirements¶
The below requirements are needed on the host that executes this module.
ncclient (>=v0.5.2)
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
active
boolean
|
|
Specifies whether or not the configuration is active or deactivated
|
|
aggregate
list
/ elements=dictionary
|
List of VLANs definitions.
|
||
active
boolean
|
|
Specifies whether or not the configuration is active or deactivated
|
|
description
string
|
Text description of VLANs.
|
||
filter_input
string
|
The name of input filter.
|
||
filter_output
string
|
The name of output filter.
|
||
interfaces
list
/ elements=string
|
List of interfaces to check the VLAN has been configured correctly.
|
||
l3_interface
string
|
Name of logical layer 3 interface.
|
||
name
string
/ required
|
Name of the VLAN.
|
||
state
string
|
|
State of the VLAN configuration.
|
|
vlan_id
integer
/ required
|
ID of the VLAN. Range 1-4094.
|
||
description
string
|
Text description of VLANs.
|
||
filter_input
string
|
The name of input filter.
|
||
filter_output
string
|
The name of output filter.
|
||
interfaces
list
/ elements=string
|
List of interfaces to check the VLAN has been configured correctly.
|
||
l3_interface
string
|
Name of logical layer 3 interface.
|
||
name
string
|
Name of the VLAN.
|
||
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli or connection: netconf .For more information please see the Junos OS Platform Options guide.
A dict object containing connection details.
|
||
host
string
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
|
||
password
string
|
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_PASSWORD will be used instead. |
||
port
integer
|
Specifies the port to use when building the connection to the remote device. The port value will default to the well known SSH port of 22 (for
transport=cli ) or port 830 (for transport=netconf ) device. |
||
ssh_keyfile
path
|
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
timeout
integer
|
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.
|
||
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
username
string
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_USERNAME will be used instead. |
||
state
string
|
|
State of the VLAN configuration.
|
|
vlan_id
integer
|
ID of the VLAN. Range 1-4094.
|
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.
Recommended connection is
netconf
. See the Junos OS Platform Options.This module also works with
local
connections for legacy playbooks.For information on using CLI and netconf see the Junos OS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Juniper network devices see https://www.ansible.com/ansible-juniper.
Examples¶
- name: configure VLAN ID and name
junipernetworks.junos.junos_vlan:
name: test
vlan_id: 20
- name: Link to logical layer 3 interface
junipernetworks.junos.junos_vlan:
name: test
vlan_id: 20
l3-interface: vlan.20
- name: remove VLAN configuration
junipernetworks.junos.junos_vlan:
name: test
state: absent
- name: deactive VLAN configuration
junipernetworks.junos.junos_vlan:
name: test
state: present
active: false
- name: activate VLAN configuration
junipernetworks.junos.junos_vlan:
name: test
state: present
active: true
- name: Create vlan configuration using aggregate
junipernetworks.junos.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
junipernetworks.junos.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, the following are the fields unique to this module:
Status¶
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors¶
Ganesh Nalawade (@ganeshrn)