vyos_interface – Manage Interface on VyOS network devices¶
New in version 2.4.
DEPRECATED¶
| Removed in Ansible: | |
|---|---|
| version: 2.13 | |
| Why: | Updated modules released with more functionality. | 
| Alternative: | vyos_interfaces | 
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| aggregate 
                    -
                                                                 | List of Interfaces definitions. | ||
| delay 
                    -
                                                                 | 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/downand neighbors. | |
| description 
                    -
                                                                 | Description of Interface. | ||
| duplex 
                    -
                                                                 | 
 | Interface link status. | |
| enabled 
                    boolean
                                                                 | 
 | Interface link status. | |
| mtu 
                    -
                                                                 | Maximum size of transmit packet. | ||
| name 
                    -
                                             / required                     | Name of the Interface. | ||
| neighbors 
                    -
                                                                 added in 2.5 | Check the operational state of given interface  namefor LLDP neighbor.The following suboptions are available. | ||
| host 
                    -
                                                                 | LLDP neighbor host for given interface  name. | ||
| port 
                    -
                                                                 | LLDP neighbor port to which given interface  nameis 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
                                             / 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. | ||
| 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_PASSWORDwill be used instead. | ||
| port 
                    integer
                                                                 | Default: 22 | 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_KEYFILEwill be used instead. | ||
| timeout 
                    integer
                                                                 | 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. | |
| 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_USERNAMEwill be used instead. | ||
| speed 
                    -
                                                                 | Interface link speed. | ||
| state 
                    -
                                                                 | 
 | State of the Interface configuration,  upmeans present and operationally up anddownmeans present and operationallydown | |
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: configure interface
  vyos_interface:
    name: eth0
    description: test-interface
- name: remove interface
  vyos_interface:
    name: eth0
    state: absent
- name: make interface down
  vyos_interface:
    name: eth0
    enabled: False
- name: make interface up
  vyos_interface:
    name: eth0
    enabled: True
- name: Configure interface speed, mtu, duplex
  vyos_interface:
    name: eth5
    state: present
    speed: 100
    mtu: 256
    duplex: full
- name: Set interface using aggregate
  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_interface:
    name: eth0
    neighbors:
    - port: eth0
      host: netdev
- name: Config + intent
  vyos_interface:
    name: eth1
    enabled: False
    state: down
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module will be removed in version 2.13. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Ganesh Nalawade (@ganeshrn)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
