cisco.ios.ios_l3_interface module – (deprecated, removed after 2022-06-01) Manage Layer-3 interfaces on Cisco IOS network devices.
Note
This module is part of the cisco.ios collection (version 3.3.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.ios.
To use it in a playbook, specify: cisco.ios.ios_l3_interface.
New in cisco.ios 1.0.0
DEPRECATED
- Removed in:
major release after 2022-06-01
- Why:
Newer and updated modules released with more functionality in Ansible 2.9
- Alternative:
ios_l3_interfaces
Synopsis
This module provides declarative management of Layer-3 interfaces on IOS network devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
|---|---|
List of Layer-3 interfaces definitions. Each of the entry in aggregate list should define name of interface |
|
IPv4 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 192.168.0.1/24 |
|
IPv6 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv6 address>/<mask>, the mask is number in range 0-128 eg. fd5d:12c9:2201:1::1/64 |
|
Name of the Layer-3 interface to be configured eg. GigabitEthernet0/2 |
|
State of the Layer-3 interface configuration. It indicates if the configuration should be present or absent on remote device. Choices:
|
|
IPv4 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 192.168.0.1/24 |
|
IPv6 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv6 address>/<mask>, the mask is number in range 0-128 eg. fd5d:12c9:2201:1::1/64 |
|
Name of the Layer-3 interface to be configured eg. GigabitEthernet0/2 |
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
Specifies the port to use when building the connection to the remote device. |
|
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 |
|
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. |
|
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 |
|
State of the Layer-3 interface configuration. It indicates if the configuration should be present or absent on remote device. Choices:
|
Notes
Note
Tested against IOS 15.2
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: Remove GigabitEthernet0/3 IPv4 and IPv6 address
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
state: absent
- name: Set GigabitEthernet0/3 IPv4 address
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
ipv4: 192.168.0.1/24
- name: Set GigabitEthernet0/3 IPv6 address
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
ipv6: fd5d:12c9:2201:1::1/64
- name: Set GigabitEthernet0/3 in dhcp
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
ipv4: dhcp
ipv6: dhcp
- name: Set interface Vlan1 (SVI) IPv4 address
cisco.ios.ios_l3_interface:
name: Vlan1
ipv4: 192.168.0.5/24
- name: Set IP addresses on aggregate
cisco.ios.ios_l3_interface:
aggregate:
- name: GigabitEthernet0/3
ipv4: 192.168.2.10/24
- name: GigabitEthernet0/3
ipv4: 192.168.3.10/24
ipv6: fd5d:12c9:2201:1::1/64
- name: Remove IP addresses on aggregate
cisco.ios.ios_l3_interface:
aggregate:
- name: GigabitEthernet0/3
ipv4: 192.168.2.10/24
- name: GigabitEthernet0/3
ipv4: 192.168.3.10/24
ipv6: fd5d:12c9:2201:1::1/64
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
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: |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.