junipernetworks.junos.junos_l2_interfaces module – L2 interfaces resource module
Note
This module is part of the junipernetworks.junos collection (version 5.3.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 junipernetworks.junos.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: junipernetworks.junos.junos_l2_interfaces.
New in junipernetworks.junos 1.0.0
Synopsis
This module provides declarative management of a Layer-2 interface on Juniper JUNOS devices.
Note
This module has a corresponding action plugin.
Aliases: l2_interfaces
Requirements
The below requirements are needed on the host that executes this module.
ncclient (>=v0.6.4)
Parameters
Parameter |
Comments |
|---|---|
A dictionary of Layer-2 interface options |
|
Configure the interface as a Layer 2 access mode. |
|
Configure the access VLAN ID. |
|
True if your device has Enhanced Layer 2 Software (ELS). If the l2 configuration is under Choices:
|
|
Full name of interface, e.g. ge-0/0/1. |
|
Configure the interface as a Layer 2 trunk mode. |
|
List of VLANs to be configured in trunk port. It’s used as the VLAN range to ADD or REMOVE from the trunk. |
|
Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID. |
|
Logical interface number. Value of |
|
This option is used only with state parsed. The value of this option should be the output received from the Junos device by executing the command show interfaces. The state parsed reads the configuration from |
|
The state of the configuration after module completion Choices:
|
Notes
Note
This module requires the netconf system service be enabled on the remote device being managed.
Tested against vSRX JUNOS version 18.4R1.
This module works with connection
netconf. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_junos.htmlThe module examples uses callback plugin (stdout_callback = yaml) to generate task output in yaml format.
Examples
# Using merged
# Before state:
# -------------
#
# ansible@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# }
# }
# }
# ge-0/0/4 {
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
- name: Merge provided configuration with device configuration
junipernetworks.junos.junos_l2_interfaces:
config:
- name: ge-0/0/3
access:
vlan: v101
- name: ge-0/0/4
trunk:
allowed_vlans:
- vlan30
native_vlan: 50
state: merged
# Task Output
# -----------
#
# before:
# - enhanced_layer: true
# name: ge-0/0/3
# unit: 0
# - enhanced_layer: true
# name: ge-0/0/4
# unit: 0
# commands:
# - <nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:interface>
# <nc:name>ge-0/0/3</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode>access</nc:interface-mode>
# <nc:vlan>
# <nc:members>v101</nc:members>
# </nc:vlan>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# </nc:interface>
# <nc:interface>
# <nc:name>ge-0/0/4</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode>trunk</nc:interface-mode>
# <nc:vlan>
# <nc:members>vlan30</nc:members>
# </nc:vlan>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id>50</nc:native-vlan-id>
# </nc:interface>
# </nc:interfaces>
# after:
# - access:
# vlan: v101
# enhanced_layer: true
# name: ge-0/0/3
# unit: 0
# - enhanced_layer: true
# name: ge-0/0/4
# trunk:
# allowed_vlans:
# - vlan30
# native_vlan: '50'
# unit: 0
# After state:
# ------------
#
# user@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# vlan {
# members v101;
# }
# }
# }
# }
# ge-0/0/4 {
# native-vlan-id 50;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members vlan30;
# }
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
# Using overridden
# Before state:
# -------------
# ansible@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# vlan {
# members v101;
# }
# }
# }
# }
# ge-0/0/4 {
# native-vlan-id 50;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members vlan30;
# }
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
- name: Override provided configuration with device configuration
junipernetworks.junos.junos_l2_interfaces:
config:
- name: ge-0/0/4
trunk:
allowed_vlans:
- v101
native_vlan: 30
state: overridden
# Task Output
# -----------
#
# before:
# - access:
# vlan: v101
# enhanced_layer: true
# name: ge-0/0/3
# unit: 0
# - enhanced_layer: true
# name: ge-0/0/4
# trunk:
# allowed_vlans:
# - vlan30
# native_vlan: '50'
# unit: 0
# commands:
# - <nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:interface>
# <nc:name>ge-0/0/4</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode delete="delete"/>
# <nc:vlan delete="delete"/>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id delete="delete"/>
# </nc:interface>
# <nc:interface>
# <nc:name>ge-0/0/4</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode>trunk</nc:interface-mode>
# <nc:vlan>
# <nc:members>v101</nc:members>
# </nc:vlan>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id>30</nc:native-vlan-id>
# </nc:interface>
# <nc:interface>
# <nc:name>ge-0/0/3</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode delete="delete"/>
# <nc:vlan delete="delete"/>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id delete="delete"/>
# </nc:interface>
# </nc:interfaces>
# after:
# - enhanced_layer: true
# name: ge-0/0/4
# trunk:
# allowed_vlans:
# - v101
# native_vlan: '30'
# unit: 0
# After state:
# ------------
# user@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching;
# }
# }
# ge-0/0/4 {
# native-vlan-id 30;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members v101;
# }
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
# Using replaced
# Before state:
# -------------
#
# ansible@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching;
# }
# }
# ge-0/0/4 {
# native-vlan-id 30;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members v101;
# }
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
- name: Replace provided configuration with device configuration
junipernetworks.junos.junos_l2_interfaces:
config:
- name: ge-0/0/3
access:
vlan: v101
- name: ge-0/0/4
trunk:
allowed_vlans:
- vlan30
native_vlan: 50
state: replaced
# Task Output
# -----------
#
# before:
# - enhanced_layer: true
# name: ge-0/0/4
# trunk:
# allowed_vlans:
# - v101
# native_vlan: '30'
# unit: 0
# commands:
# - <nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:interface>
# <nc:name>ge-0/0/4</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode delete="delete"/>
# <nc:vlan delete="delete"/>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id delete="delete"/>
# </nc:interface>
# <nc:interface>
# <nc:name>ge-0/0/3</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode>access</nc:interface-mode>
# <nc:vlan>
# <nc:members>v101</nc:members>
# </nc:vlan>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# </nc:interface>
# <nc:interface>
# <nc:name>ge-0/0/4</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode>trunk</nc:interface-mode>
# <nc:vlan>
# <nc:members>vlan30</nc:members>
# </nc:vlan>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id>50</nc:native-vlan-id>
# </nc:interface>
# </nc:interfaces>
# after:
# - access:
# vlan: v101
# enhanced_layer: true
# name: ge-0/0/3
# unit: 0
# - enhanced_layer: true
# name: ge-0/0/4
# trunk:
# allowed_vlans:
# - vlan30
# native_vlan: '50'
# unit: 0
# After state:
# ------------
#
# user@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# vlan {
# members v101;
# }
# }
# }
# }
# ge-0/0/4 {
# native-vlan-id 50;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members vlan30;
# }
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
# Using deleted
# Before state:
# -------------
#
# ansible@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# vlan {
# members v101;
# }
# }
# }
# }
# ge-0/0/4 {
# native-vlan-id 50;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members vlan30;
# }
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
- name: "Delete L2 attributes of given interfaces (Note: This won't delete the
interface itself)."
junipernetworks.junos.junos_l2_interfaces:
config:
- name: ge-0/0/1
- name: ge-0/0/2
state: deleted
# Task Output
# -----------
#
# before:
# - access:
# vlan: v101
# enhanced_layer: true
# name: ge-0/0/3
# unit: 0
# - enhanced_layer: true
# name: ge-0/0/4
# trunk:
# allowed_vlans:
# - vlan30
# native_vlan: '50'
# unit: 0
# commands:
# - <nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:interface>
# <nc:name>ge-0/0/3</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode delete="delete"/>
# <nc:vlan delete="delete"/>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id delete="delete"/>
# </nc:interface>
# </nc:interfaces>
# after:
# - enhanced_layer: true
# name: ge-0/0/4
# trunk:
# allowed_vlans:
# - vlan30
# native_vlan: '50'
# unit: 0
# After state:
# ------------
#
# ansible@junos01# show interfaces
# ge-0/0/1 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/2 {
# unit 0 {
# family inet;
# family inet6;
# }
# }
# ge-0/0/3 {
# unit 0 {
# family ethernet-switching;
# }
# }
# ge-0/0/4 {
# native-vlan-id 50;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members vlan30;
# }
# }
# }
# }
# fxp0 {
# enable;
# unit 0 {
# family inet {
# dhcp;
# }
# family inet6;
# }
# }
# Using gathered
# Before state:
# -------------
#
# user@junos01# show interfaces
# ge-0/0/1 {
# description "Configured by Ansible";
# disable;
# speed 100m;
# mtu 1024;
# hold-time up 2000 down 2200;
# link-mode full-duplex;
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# vlan {
# members vlan100;
# }
# }
# }
# }
# ge-0/0/2 {
# description "Configured by Ansible";
# native-vlan-id 400;
# speed 10m;
# mtu 2048;
# hold-time up 3000 down 3200;
# unit 0 {
# family ethernet-switching {
# interface-mode trunk;
# vlan {
# members [ vlan200 vlan300 ];
# }
# }
# }
# }
# em1 {
# description TEST;
# }
# fxp0 {
# description ANSIBLE;
# speed 1g;
# link-mode automatic;
# unit 0 {
# family inet {
# address 10.8.38.38/24;
# }
# }
# }
- name: Gather junos layer 2 interfaces facts
junipernetworks.junos.junos_l2_interfaces:
state: gathered
# Task Output
# -----------
#
# gathered:
# - access:
# vlan: vlan100
# enhanced_layer: true
# name: ge-0/0/1
# unit: 0
# - enhanced_layer: true
# name: ge-0/0/2
# trunk:
# allowed_vlans:
# - vlan200
# - vlan300
# native_vlan: '400'
# unit: 0
# Using parsed
# parsed.cfg
# ------------
#
# <?xml version="1.0" encoding="UTF-8"?>
# <rpc-reply message-id="urn:uuid:0cadb4e8-5bba-47f4-986e-72906227007f">
# <configuration changed-seconds="1590139550" changed-localtime="2020-05-22 09:25:50 UTC">
# <interfaces>
# <interface>
# <name>ge-0/0/1</name>
# <description>Configured by Ansible</description>
# <disable/>
# <speed>100m</speed>
# <mtu>1024</mtu>
# <hold-time>
# <up>2000</up>
# <down>2200</down>
# </hold-time>
# <link-mode>full-duplex</link-mode>
# <unit>
# <name>0</name>
# <family>
# <ethernet-switching>
# <interface-mode>access</interface-mode>
# <vlan>
# <members>vlan100</members>
# </vlan>
# </ethernet-switching>
# </family>
# </unit>
# </interface>
# </interfaces>
# </configuration>
# </rpc-reply>
- name: Convert interfaces config to argspec without connecting to the appliance
junipernetworks.junos.junos_l2_interfaces:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
# Task Output
# -----------
#
# parsed:
# - access:
# vlan: vlan100
# enhanced_layer: true
# name: ge-0/0/1
# unit: 0
# - enhanced_layer: true
# name: ge-0/0/2
# trunk:
# allowed_vlans:
# - vlan200
# - vlan300
# native_vlan: '400'
# unit: 0
# Using rendered
- name: Render platform specific xml from task input using rendered state
junipernetworks.junos.junos_l2_interfaces:
config:
- name: ge-0/0/1
access:
vlan: vlan100
- name: ge-0/0/2
trunk:
allowed_vlans:
- vlan200
- vlan300
native_vlan: '400'
state: rendered
# Task Output
# -----------
#
# "rendered": "<nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:interface>
# <nc:name>ge-0/0/1</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode>access</nc:interface-mode>
# <nc:vlan>
# <nc:members>vlan100</nc:members>
# </nc:vlan>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# </nc:interface>
# <nc:interface>
# <nc:name>ge-0/0/2</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:ethernet-switching>
# <nc:interface-mode>trunk</nc:interface-mode>
# <nc:vlan>
# <nc:members>vlan200</nc:members>
# <nc:members>vlan300</nc:members>
# </nc:vlan>
# </nc:ethernet-switching>
# </nc:family>
# </nc:unit>
# <nc:native-vlan-id>400</nc:native-vlan-id>
# </nc:interface>
# </nc:interfaces>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The configuration as structured data after module completion. Returned: when changed Sample: |
|
The configuration as structured data prior to module invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is Sample: |