Deprecated

Removed in 2.13

i

Reason:Newer and updated modules released with more functionality in Ansible 2.9 | Alternative:ios_l3_interfaces

ansible.builtin._ios_l3_interface (v2.9.24) — module

Manage Layer-3 interfaces on Cisco IOS network devices.

| "added in version" 2.5 of ansible.builtin"

Authors: Ganesh Nalawade (@ganeshrn)

deprecated | supported by network

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

This module provides declarative management of Layer-3 interfaces on IOS network devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove GigabitEthernet0/3 IPv4 and IPv6 address
  ios_l3_interface:
    name: GigabitEthernet0/3
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set GigabitEthernet0/3 IPv4 address
  ios_l3_interface:
    name: GigabitEthernet0/3
    ipv4: 192.168.0.1/24
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set GigabitEthernet0/3 IPv6 address
  ios_l3_interface:
    name: GigabitEthernet0/3
    ipv6: "fd5d:12c9:2201:1::1/64"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set GigabitEthernet0/3 in dhcp
  ios_l3_interface:
    name: GigabitEthernet0/3
    ipv4: dhcp
    ipv6: dhcp
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set interface Vlan1 (SVI) IPv4 address
  ios_l3_interface:
    name: Vlan1
    ipv4: 192.168.0.5/24
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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" }
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
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.

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.

Outputs

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