Note
This plugin is part of the junipernetworks.junos collection (version 2.6.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 junipernetworks.junos.
To use it in a playbook, specify: junipernetworks.junos.junos_l3_interfaces.
New in version 1.0.0: of junipernetworks.junos
Note
This module has a corresponding action plugin.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| config list / elements=dictionary | A dictionary of Layer 3 interface options | |||
| ipv4 list / elements=dictionary | IPv4 addresses to be set for the Layer 3 logical interface mentioned in name option. The address format is <ipv4 address>/<mask>. The mask is number in range 0-32 for example, 192.0.2.1/24, or dhcp to query DHCP for an IP address | |||
| address string | IPv4 address to be set for the specific interface | |||
| ipv6 list / elements=dictionary | IPv6 addresses to be set for the Layer 3 logical interface mentioned in name option. The address format is <ipv6 address>/<mask>, the mask is number in range 0-128 for example, 2001:db8:2201:1::1/64 or auto-config to use SLAAC | |||
| address string | IPv6 address to be set for the specific interface | |||
| name string / required | Full name of interface, e.g. ge-0/0/1 | |||
| unit integer | Default: 0 | Logical interface number. Value of unit should be of type integer | ||
| running_config string | 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 running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result | |||
| state string |
| The state of the configuration after module completion | ||
Note
netconf. See the Junos OS Platform Options.# Using deleted
# Before state:
# -------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "L3 interface";
# unit 0 {
# family inet {
# address 10.200.16.10/24;
# }
# }
# }
# ge-0/0/2 {
# description "non L3 interface";
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# vlan {
# members 2;
# }
# }
# }
# }
- name: Delete JUNOS L3 logical interface
junipernetworks.junos.junos_l3_interfaces:
config:
- name: ge-0/0/1
- name: ge-0/0/2
state: deleted
# After state:
# ------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "deleted L3 interface";
# }
# ge-0/0/2 {
# description "non L3 interface";
# unit 0 {
# family ethernet-switching {
# interface-mode access;
# vlan {
# members 2;
# }
# }
# }
# }
# Using merged
# Before state
# ------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "L3 interface";
# unit 0 {
# family inet {
# address 10.200.16.10/24;
# }
# }
# }
# ge-0/0/2 {
# description "non configured interface";
# unit 0;
# }
- name: Merge provided configuration with device configuration (default operation is merge)
junipernetworks.junos.junos_l3_interfaces:
config:
- name: ge-0/0/1
ipv4:
- address: 192.168.1.10/24
ipv6:
- address: 8d8d:8d01::1/64
- name: ge-0/0/2
ipv4:
- address: dhcp
state: merged
# After state:
# ------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "L3 interface";
# unit 0 {
# family inet {
# address 10.200.16.10/24;
# address 192.168.1.10/24;
# }
# family inet6 {
# address 8d8d:8d01::1/64;
# }
# }
# }
# ge-0/0/2 {
# description "L3 interface with dhcp";
# unit 0 {
# family inet {
# dhcp;
# }
# }
# }
# Using overridden
# Before state
# ------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "L3 interface";
# unit 0 {
# family inet {
# address 10.200.16.10/24;
# }
# }
# }
# ge-0/0/2 {
# description "L3 interface with dhcp";
# unit 0 {
# family inet {
# dhcp;
# }
# }
# }
# ge-0/0/3 {
# description "another L3 interface";
# unit 0 {
# family inet {
# address 192.168.1.10/24;
# }
# }
# }
- name: Override provided configuration with device configuration
junipernetworks.junos.junos_l3_interfaces:
config:
- name: ge-0/0/1
ipv4:
- address: 192.168.1.10/24
ipv6:
- address: 8d8d:8d01::1/64
- name: ge-0/0/2
ipv6:
- address: 2001:db8:3000::/64
state: overridden
# After state:
# ------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "L3 interface";
# unit 0 {
# family inet {
# address 192.168.1.10/24;
# }
# family inet6 {
# address 8d8d:8d01::1/64;
# }
# }
# }
# ge-0/0/2 {
# description "L3 interface with ipv6";
# unit 0 {
# family inet6 {
# address 2001:db8:3000::/64;
# }
# }
# }
# ge-0/0/3 {
# description "overridden L3 interface";
# unit 0;
# }
# Using replaced
# Before state
# ------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "L3 interface";
# unit 0 {
# family inet {
# address 10.200.16.10/24;
# }
# }
# }
# ge-0/0/2 {
# description "non configured interface";
# unit 0;
# }
# ge-0/0/3 {
# description "another L3 interface";
# unit 0 {
# family inet {
# address 192.168.1.10/24;
# }
# }
# }
- name: Replace provided configuration with device configuration
junipernetworks.junos.junos_l3_interfaces:
config:
- name: ge-0/0/1
ipv4:
- address: 192.168.1.10/24
ipv6:
- address: 8d8d:8d01::1/64
- name: ge-0/0/2
ipv4:
- address: dhcp
state: replaced
# After state:
# ------------
#
# admin# show interfaces
# ge-0/0/1 {
# description "L3 interface";
# unit 0 {
# family inet {
# address 192.168.1.10/24;
# }
# family inet6 {
# address 8d8d:8d01::1/64;
# }
# }
# }
# ge-0/0/2 {
# description "L3 interface with dhcp";
# unit 0 {
# family inet {
# dhcp;
# }
# }
# }
# ge-0/0/3 {
# description "another L3 interface";
# unit 0 {
# family inet {
# address 192.168.1.10/24;
# }
# }
# }
# 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 ];
# }
# }
# }
# }
# ge-1/0/0 {
# unit 0 {
# family inet {
# address 192.168.100.1/24;
# address 10.200.16.20/24;
# }
# family inet6;
# }
# }
# ge-2/0/0 {
# unit 0 {
# family inet {
# address 192.168.100.2/24;
# address 10.200.16.21/24;
# }
# family inet6;
# }
# }
# ge-3/0/0 {
# unit 0 {
# family inet {
# address 192.168.100.3/24;
# address 10.200.16.22/24;
# }
# family inet6;
# }
# }
# em1 {
# description TEST;
# }
# fxp0 {
# description ANSIBLE;
# speed 1g;
# link-mode automatic;
# unit 0 {
# family inet {
# address 10.8.38.38/24;
# }
# }
# }
- name: Gather junos layer3 interfaces as in given arguments
junipernetworks.junos.junos_l3_interfaces:
state: gathered
# Task Output (redacted)
# -----------------------
#
# "gathered": [
# {
# "ipv4": [
# {
# "address": "192.168.100.1/24"
# },
# {
# "address": "10.200.16.20/24"
# }
# ],
# "name": "ge-1/0/0",
# "unit": "0"
# },
# {
# "ipv4": [
# {
# "address": "192.168.100.2/24"
# },
# {
# "address": "10.200.16.21/24"
# }
# ],
# "name": "ge-2/0/0",
# "unit": "0"
# },
# {
# "ipv4": [
# {
# "address": "192.168.100.3/24"
# },
# {
# "address": "10.200.16.22/24"
# }
# ],
# "name": "ge-3/0/0",
# "unit": "0"
# },
# {
# "ipv4": [
# {
# "address": "10.8.38.38/24"
# }
# ],
# "name": "fxp0",
# "unit": "0"
# }
# ]
# After 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 ];
# }
# }
# }
# }
# ge-1/0/0 {
# unit 0 {
# family inet {
# address 192.168.100.1/24;
# address 10.200.16.20/24;
# }
# family inet6;
# }
# }
# ge-2/0/0 {
# unit 0 {
# family inet {
# address 192.168.100.2/24;
# address 10.200.16.21/24;
# }
# family inet6;
# }
# }
# ge-3/0/0 {
# unit 0 {
# family inet {
# address 192.168.100.3/24;
# address 10.200.16.22/24;
# }
# family inet6;
# }
# }
# em1 {
# description TEST;
# }
# fxp0 {
# description ANSIBLE;
# speed 1g;
# link-mode automatic;
# unit 0 {
# family inet {
# address 10.8.38.38/24;
# }
# }
# }
# 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-1/0/0</name>
# <unit>
# <name>0</name>
# <family>
# <inet>
# <address>
# <name>192.168.100.1/24</name>
# </address>
# <address>
# <name>10.200.16.20/24</name>
# </address>
# </inet>
# <inet6></inet6>
# </family>
# </unit>
# </interface>
# <interface>
# <name>ge-2/0/0</name>
# <unit>
# <name>0</name>
# <family>
# <inet>
# <address>
# <name>192.168.100.2/24</name>
# </address>
# <address>
# <name>10.200.16.21/24</name>
# </address>
# </inet>
# <inet6></inet6>
# </family>
# </unit>
# </interface>
# </interfaces>
# </configuration>
# </rpc-reply>
# - name: Convert interfaces config to argspec without connecting to the appliance
# junipernetworks.junos.junos_l3_interfaces:
# running_config: "{{ lookup('file', './parsed.cfg') }}"
# state: parsed
# Task Output (redacted)
# -----------------------
# "parsed": [
# {
# "ipv4": [
# {
# "address": "192.168.100.1/24"
# },
# {
# "address": "10.200.16.20/24"
# }
# ],
# "name": "ge-1/0/0",
# "unit": "0"
# },
# {
# "ipv4": [
# {
# "address": "192.168.100.2/24"
# },
# {
# "address": "10.200.16.21/24"
# }
# ],
# "name": "ge-2/0/0",
# "unit": "0"
# }
# ]
#
# Using rendered
- name: Render platform specific xml from task input using rendered state
junipernetworks.junos.junos_l3_interfaces:
config:
- name: ge-1/0/0
ipv4:
- address: 192.168.100.1/24
- address: 10.200.16.20/24
unit: 0
- name: ge-2/0/0
ipv4:
- address: 192.168.100.2/24
- address: 10.200.16.21/24
unit: 0
state: rendered
# Task Output (redacted)
# -----------------------
# "rendered": "<nc:interfaces
# xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
# <nc:interface>
# <nc:name>ge-1/0/0</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:inet>
# <nc:address>
# <nc:name>192.168.100.1/24</nc:name>
# </nc:address>
# <nc:address>
# <nc:name>10.200.16.20/24</nc:name>
# </nc:address>
# </nc:inet>
# </nc:family>
# </nc:unit>
# </nc:interface>
# <nc:interface>
# <nc:name>ge-2/0/0</nc:name>
# <nc:unit>
# <nc:name>0</nc:name>
# <nc:family>
# <nc:inet>
# <nc:address>
# <nc:name>192.168.100.2/24</nc:name>
# </nc:address>
# <nc:address>
# <nc:name>10.200.16.21/24</nc:name>
# </nc:address>
# </nc:inet>
# </nc:family>
# </nc:unit>
# </nc:interface>
# </nc:interfaces>"
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 configuration as structured data after module completion. Sample: The configuration returned will always be in the same format of the parameters above. |
| before list / elements=string | always | The configuration as structured data prior to module invocation. Sample: The configuration returned will always be in the same format of the parameters above. |
| commands list / elements=string | always | The set of commands pushed to the remote device. Sample: ['<nc:interfaces xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> <nc:interface> <nc:name>ge-1/0/0</nc:name> <nc:unit> <nc:name>0</nc:name> <nc:family> <nc:inet> <nc:address> <nc:name>192.168.100.1/24</nc:name> </nc:address> <nc:address> <nc:name>10.200.16.20/24</nc:name> </nc:address> </nc:inet> </nc:family> </nc:unit> </nc:interfaces>', 'xml 2', 'xml 3'] |
© 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/junipernetworks/junos/junos_l3_interfaces_module.html