ios_interface – Manage Interface on Cisco IOS network devices — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ios_interface – Manage Interface on Cisco IOS network devices

New in version 2.4.

- DEPRECATED
- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## DEPRECATED

Removed in Ansible:
| version: 2.13
Why: | Newer and updated modules released with more functionality in Ansible 2.9
Alternative: | ios_interfaces

## Synopsis

- This module provides declarative management of Interfaces on Cisco IOS network devices.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aggregate - |  | List of Interfaces definitions.
auth_pass string |  | Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` and `become: yes` with `become_pass`. For more information please see the IOS Platform Options guide. Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTH_PASS` will be used instead.
authorize boolean | Choices: no ← yes | Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` and `become: yes`. For more information please see the IOS Platform Options guide. Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTHORIZE` will be used instead.
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`/`down`, tx_rate and rx_rate.
description - |  | Description of Interface.
duplex - | Choices: full half auto ← | Interface link status
enabled boolean | Choices: no yes | Interface link status.
mtu - |  | Maximum size of transmit packet.
name - / required |  | Name of the Interface.
neighbors - |  | Check the operational state of given interface `name` for CDP/LLDP neighbor. The following suboptions are available.
| host - |  | CDP/LLDP neighbor host for given interface `name`.
| port - |  | CDP/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 IOS Platform Options guide. A dict object containing connection details.
| auth_pass string |  | Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTH_PASS` will be used instead.
| authorize boolean | Choices: no ← yes | Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTHORIZE` will be used instead.
| 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_PASSWORD` will 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_KEYFILE` will 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_USERNAME` will be used instead.
rx_rate - |  | Receiver rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules
speed - |  | Interface link speed.
state - | Choices: present ← absent up down | State of the Interface configuration, `up` means present and operationally up and `down` means present and operationally `down`
tx_rate - |  | Transmit rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules

## Notes

Note

- Tested against IOS 15.6
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Cisco devices see the Cisco integration page.

## Examples

    - name: configure interface
      ios_interface:
          name: GigabitEthernet0/2
          description: test-interface
          speed: 100
          duplex: half
          mtu: 512

    - name: remove interface
      ios_interface:
        name: Loopback9
        state: absent

    - name: make interface up
      ios_interface:
        name: GigabitEthernet0/2
        enabled: True

    - name: make interface down
      ios_interface:
        name: GigabitEthernet0/2
        enabled: False

    - name: Check intent arguments
      ios_interface:
        name: GigabitEthernet0/2
        state: up
        tx_rate: ge(0)
        rx_rate: le(0)

    - name: Check neighbors intent arguments
      ios_interface:
        name: Gi0/0
        neighbors:
        - port: eth0
          host: netdev

    - name: Config + intent
      ios_interface:
        name: GigabitEthernet0/2
        enabled: False
        state: down

    - name: Add interface using aggregate
      ios_interface:
        aggregate:
        - { name: GigabitEthernet0/1, mtu: 256, description: test-interface-1 }
        - { name: GigabitEthernet0/2, mtu: 516, description: test-interface-2 }
        duplex: full
        speed: 100
        state: present

    - name: Delete interface using aggregate
      ios_interface:
        aggregate:
        - name: Loopback9
        - name: Loopback10
        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: ['interface GigabitEthernet0/2', 'description test-interface', 'duplex half', 'mtu 512']

## 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.