Note
This plugin is part of the vyos.vyos collection.
To install it use: ansible-galaxy collection install vyos.vyos
.
To use it in a playbook, specify: vyos.vyos.vyos_interface
.
New in version 1.0.0: of vyos.vyos
major release after 2022-06-01
Updated modules released with more functionality.
vyos_interfaces
Note
This module has a corresponding action plugin.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
aggregate list / elements=dictionary | List of Interfaces definitions. | |||
delay integer | Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up /down and neighbors. | |||
description string | Description of Interface. | |||
duplex string |
| Interface link status. | ||
enabled boolean |
| Interface link status. | ||
mtu integer | Maximum size of transmit packet. | |||
name string / required | Name of the Interface. | |||
neighbors list / elements=dictionary | Check the operational state of given interface name for LLDP neighbor.The following suboptions are available. | |||
host string | LLDP neighbor host for given interface name . | |||
port string | LLDP neighbor port to which given interface name is connected. | |||
speed string | Interface link speed. | |||
state string |
| State of the Interface configuration, up means present and operationally up and down means present and operationally down
| ||
delay integer | Default: 10 | Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up /down and neighbors. | ||
description string | Description of Interface. | |||
duplex string |
| Interface link status. | ||
enabled boolean |
| Interface link status. | ||
mtu integer | Maximum size of transmit packet. | |||
name string | Name of the Interface. | |||
neighbors list / elements=dictionary | Check the operational state of given interface name for LLDP neighbor.The following suboptions are available. | |||
host string | LLDP neighbor host for given interface name . | |||
port string | LLDP neighbor port to which given interface name is connected. | |||
provider dictionary | 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 string | 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. | |||
password string | 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. | |||
port integer | Specifies the port to use when building the connection to the remote device. | |||
ssh_keyfile path | 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. | |||
timeout integer | 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. | |||
username string | 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. | |||
speed string | Interface link speed. | |||
state string |
| State of the Interface configuration, up means present and operationally up and down means present and operationally down
|
Note
- name: configure interface vyos.vyos.vyos_interface: name: eth0 description: test-interface - name: remove interface vyos.vyos.vyos_interface: name: eth0 state: absent - name: make interface down vyos.vyos.vyos_interface: name: eth0 enabled: false - name: make interface up vyos.vyos.vyos_interface: name: eth0 enabled: true - name: Configure interface speed, mtu, duplex vyos.vyos.vyos_interface: name: eth5 state: present speed: 100 mtu: 256 duplex: full - name: Set interface using aggregate vyos.vyos.vyos_interface: aggregate: - {name: eth1, description: test-interface-1, speed: 100, duplex: half, mtu: 512} - {name: eth2, description: test-interface-2, speed: 1000, duplex: full, mtu: 256} - name: Disable interface on aggregate net_interface: aggregate: - name: eth1 - name: eth2 enabled: false - name: Delete interface using aggregate net_interface: aggregate: - name: eth1 - name: eth2 state: absent - name: Check lldp neighbors intent arguments vyos.vyos.vyos_interface: name: eth0 neighbors: - port: eth0 host: netdev - name: Config + intent vyos.vyos.vyos_interface: name: eth1 enabled: false state: down
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 description "test-interface"', 'set interfaces ethernet eth0 speed 100', 'set interfaces ethernet eth0 mtu 256', 'set interfaces ethernet eth0 duplex full'] |
© 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/vyos/vyos/vyos_interface_module.html