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.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate | List of L3 interfaces definitions | ||
ipv4 | IPv4 of the L3 interface. | ||
ipv6 | IPv6 of the L3 interface. | ||
name | Name of the L3 interface. | ||
provider | Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli .For more information please see the Network Guide. A dict object containing connection details. | ||
host required | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
port | Default: 22 | Specifies the port to use when building the connection to the remote device. | |
username | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. | ||
password | Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. | ||
timeout | Default: 10 | Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | |
ssh_keyfile | Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
state |
| State of the L3 interface configuration. |
Notes
Note
- Tested against VYOS 1.1.7
- For more information on using Ansible to manage network devices see the Ansible Network Guide
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, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands list | 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 is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as network which means that it is maintained by the Ansible Network Team. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Network Team, see here.
Support
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Author
- Ricardo Carrillo Cruz (@rcarrillocruz)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vyos_l3_interface_module.html