vyos_l3_interface - Manage L3 interfaces on VyOS network devices
New in version 2.4.
Synopsis
- This module provides declarative management of L3 interfaces on VyOS network devices.
Options
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. | ||
state | no | present |
| State of the L3 interface configuration. |
Examples
- name: Set eth0 IPv4 address vyos_l3_interface: name: eth0 ipv4: 192.168.0.1/24 - name: Remove eth0 IPv4 address vyos_l3_interface: name: eth0 state: absent - name: Set IP addresses on aggregate vyos_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 vyos_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 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'"] |
Notes
Note
- Tested against VYOS 1.1.7
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vyos_l3_interface_module.html