ansible / ansible.builtin / v2.9.13 / module / _ios_interface
Removed in 2.13
Reason:Newer and updated modules released with more functionality in Ansible 2.9 | Alternative:ios_interfaces
Manage Interface on Cisco IOS network devices
| "added in version" 2.4 of ansible.builtin"
Authors: Ganesh Nalawade (@ganeshrn)
deprecated | supported by network
pip
Install with pip install ansible==2.9.13
This module provides declarative management of Interfaces on Cisco IOS network devices.
- 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
mtu: description: - Maximum size of transmit packet. name: description: - Name of the Interface. required: true delay: default: 10 description: - Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down), I(tx_rate) and I(rx_rate). speed: description: - Interface link speed. state: choices: - present - absent - up - down default: present description: - State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down) duplex: choices: - full - half - auto default: auto description: - Interface link status enabled: description: - Interface link status. type: bool rx_rate: description: - Receiver rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) tx_rate: description: - Transmit rate in bits per second (bps). - This is state check parameter only. - Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html) provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - For more information please see the L(IOS Platform Options guide, ../network/user_guide/platform_ios.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool host: description: - 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. type: str password: description: - 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 C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: description: - Specifies the port to use when building the connection to the remote device. type: int ssh_keyfile: description: - 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 C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: path timeout: description: - 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. type: int username: description: - 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 C(ANSIBLE_NET_USERNAME) will be used instead. type: str type: dict aggregate: description: List of Interfaces definitions. neighbors: description: - Check the operational state of given interface C(name) for CDP/LLDP neighbor. - The following suboptions are available. suboptions: host: description: - CDP/LLDP neighbor host for given interface C(name). port: description: - CDP/LLDP neighbor port to which given interface C(name) is connected. description: description: - Description of Interface.
commands: description: The list of configuration mode commands to send to the device. returned: always, except for the platforms that use Netconf transport to manage the device. sample: - interface GigabitEthernet0/2 - description test-interface - duplex half - mtu 512 type: list