ansible.netcommon.net_l3_interface – (deprecated, removed after 2022-06-01) Manage L3 interfaces on network devices
Note
This plugin is part of the ansible.netcommon collection (version 2.5.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 ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.net_l3_interface
.
New in version 1.0.0: of ansible.netcommon
DEPRECATED
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use platform-specific “[netos]_l3_interfaces” module
Synopsis
This module provides declarative management of L3 interfaces on network devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
List of L3 interfaces definitions |
|
IPv4 of the L3 interface. |
|
IPv6 of the L3 interface. |
|
Name of the L3 interface. |
|
Purge L3 interfaces not defined in the aggregate parameter. Default: “no” |
|
State of the L3 interface configuration. Choices:
|
Notes
Note
This module is supported on
ansible_network_os
network platforms. See the Network Platform Options for details.
Examples
- name: Set eth0 IPv4 address
ansible.netcommon.net_l3_interface:
name: eth0
ipv4: 192.168.0.1/24
- name: Remove eth0 IPv4 address
ansible.netcommon.net_l3_interface:
name: eth0
state: absent
- name: Set IP addresses on aggregate
ansible.netcommon.net_l3_interface:
aggregate:
- name: eth1
ipv4: 192.168.2.10/24
- name: eth2
ipv4: 192.168.3.10/24
ipv6: fd5d:12c9:2201:1::1/64
- name: Remove IP addresses on aggregate
ansible.netcommon.net_l3_interface:
aggregate:
- name: eth1
ipv4: 192.168.2.10/24
- name: eth2
ipv4: 192.168.3.10/24
ipv6: fd5d:12c9:2201:1::1/64
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always, except for the platforms that use Netconf transport to manage the device. Sample: [“set interfaces ethernet eth0 address \u0027192.168.0.1/24\u0027”] |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors
Ricardo Carrillo Cruz (@rcarrillocruz)