ansible / ansible.builtin / v2.7.9 / module / ios_l3_interface Manage Layer-3 interfaces on Cisco IOS network devices. | "added in version" 2.5 of ansible.builtin" Authors: Ganesh Nalawade (@ganeshrn) preview | supported by networkansible.builtin.ios_l3_interface (v2.7.9) — module
pip
Install with pip install ansible==2.7.9
This module provides declarative management of Layer-3 interfaces on IOS network devices.
- name: Remove GigabitEthernet0/3 IPv4 and IPv6 address ios_l3_interface: name: GigabitEthernet0/3 state: absent
- name: Set GigabitEthernet0/3 IPv4 address ios_l3_interface: name: GigabitEthernet0/3 ipv4: 192.168.0.1/24
- name: Set GigabitEthernet0/3 IPv6 address ios_l3_interface: name: GigabitEthernet0/3 ipv6: "fd5d:12c9:2201:1::1/64"
- name: Set GigabitEthernet0/3 in dhcp ios_l3_interface: name: GigabitEthernet0/3 ipv4: dhcp ipv6: dhcp
- name: Set interface Vlan1 (SVI) IPv4 address ios_l3_interface: name: Vlan1 ipv4: 192.168.0.5/24
- name: Set IP addresses on aggregate 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 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
ipv4: description: - IPv4 address to be set for the Layer-3 interface mentioned in I(name) option. The address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 192.168.0.1/24 ipv6: description: - IPv6 address to be set for the Layer-3 interface mentioned in I(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: description: - Name of the Layer-3 interface to be configured eg. GigabitEthernet0/2 state: choices: - present - absent default: present description: - State of the Layer-3 interface configuration. It indicates if the configuration should be present or absent on remote device. provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - For more information please see the U(https://docs.ansible.com/ansible/latest/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 Layer-3 interfaces definitions. Each of the entry in aggregate list should define name of interface C(name) and a optional C(ipv4) or C(ipv6) address.
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 - ip address 192.168.0.1 255.255.255.0 - ipv6 address fd5d:12c9:2201:1::1/64 type: list