You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation .
net_l3_interface - Manage L3 interfaces on network devices
This module provides declarative management of L3 interfaces on network devices.
parameter
required
default
choices
comments
aggregate
no
List of L3 interfaces definitions
ipv4
no
IPv4 of the L3 interface.
ipv6
no
IPv6 of the L3 interface.
name
no
Name of the L3 interface.
purge
no
Purge L3 interfaces not defined in the aggregate parameter.
state
no
present
State of the L3 interface configuration.
- name : Set eth0 IPv4 address
net_l3_interface :
name : eth0
ipv4 : 192.168.0.1/24
- name : Remove eth0 IPv4 address
net_l3_interface :
name : eth0
state : absent
- name : Set IP addresses on aggregate
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
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
Common return values are documented here Return Values , the following are the fields unique to this module:
name
description
returned
type
sample
commands
The list of configuration mode commands to send to the device
always, except for the platforms that use Netconf transport to manage the device.
list
["set interfaces ethernet eth0 address '192.168.0.1/24'"]
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For more information about Red Hat’s this support of this module, please
refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing , Testing Ansible and Developing Modules .
Copyright © 2017 Red Hat, Inc.
Last updated on Nov 15, 2022.
Ansible docs are generated from GitHub sources using Sphinx using a theme provided by Read the Docs . . Module documentation is not edited directly, but is generated from the source code for the modules. To submit an update to module docs, edit the 'DOCUMENTATION' metadata in the modules directory of the core source code repository .