ansible.netcommon.net_l3_interface – (deprecated, removed after 2022-06-01) Manage L3 interfaces on network devices
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 1.4.1).
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.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
aggregate string |
List of L3 interfaces definitions | |
ipv4 string |
IPv4 of the L3 interface. | |
ipv6 string |
IPv6 of the L3 interface. | |
name string |
Name of the L3 interface. | |
purge string |
Default: "no" |
Purge L3 interfaces not defined in the aggregate parameter. |
state string |
|
State of the L3 interface configuration. |
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 | Returned | Description |
---|---|---|
commands list / elements=string |
always, except for the platforms that use Netconf transport to manage the device. |
The list of configuration mode commands to send to the device
Sample: ["set interfaces ethernet eth0 address '192.168.0.1/24'"] |
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/netcommon/net_l3_interface_module.html