.. _cisco.ios.ios_interface_module: *********************** cisco.ios.ios_interface *********************** **(deprecated, removed after 2022-06-01) Manage Interface on Cisco IOS network devices** Version added: 1.0.0 .. contents:: :local: :depth: 1 DEPRECATED ---------- :Removed in collection release after 2022-06-01 :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 ---------- .. raw:: html
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, tx_rate and rx_rate.
description
string
Description of Interface.
duplex
string
    Choices:
  • full
  • half
  • auto
Interface link status
enabled
boolean
    Choices:
  • no
  • yes
Interface link status.
mtu
string
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 CDP/LLDP neighbor.
The following suboptions are available.
host
string
CDP/LLDP neighbor host for given interface name.
port
string
CDP/LLDP neighbor port to which given interface name is connected.
rx_rate
string
Receiver rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules
speed
string
Interface link speed.
state
string
    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
string
Transmit rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules
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, tx_rate and rx_rate.
description
string
Description of Interface.
duplex
string
    Choices:
  • full
  • half
  • auto
Interface link status
enabled
boolean
    Choices:
  • no
  • yes ←
Interface link status.
mtu
string
Maximum size of transmit packet.
name
string
Name of the Interface.
neighbors
list / elements=dictionary
Check the operational state of given interface name for CDP/LLDP neighbor.
The following suboptions are available.
host
string
CDP/LLDP neighbor host for given interface name.
port
string
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 https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html.
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
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.
rx_rate
string
Receiver rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules
speed
string
Interface link speed.
state
string
    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
string
Transmit rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see https://docs.ansible.com/ansible/latest/network/user_guide/network_working_with_command_output.html#conditionals-in-networking-modules

Notes ----- .. note:: - Tested against IOS 15.6 - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. Examples -------- .. code-block:: yaml - name: configure interface cisco.ios.ios_interface: name: GigabitEthernet0/2 description: test-interface speed: 100 duplex: half mtu: 512 - name: remove interface cisco.ios.ios_interface: name: Loopback9 state: absent - name: make interface up cisco.ios.ios_interface: name: GigabitEthernet0/2 enabled: true - name: make interface down cisco.ios.ios_interface: name: GigabitEthernet0/2 enabled: false - name: Check intent arguments cisco.ios.ios_interface: name: GigabitEthernet0/2 state: up tx_rate: ge(0) rx_rate: le(0) - name: Check neighbors intent arguments cisco.ios.ios_interface: name: Gi0/0 neighbors: - port: eth0 host: netdev - name: Config + intent cisco.ios.ios_interface: name: GigabitEthernet0/2 enabled: false state: down - name: Add interface using aggregate cisco.ios.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 cisco.ios.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: .. raw:: html
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 a release after 2022-06-01. *[deprecated]* - For more information see `DEPRECATED`_. Authors ~~~~~~~ - Ganesh Nalawade (@ganeshrn)