cisco.ios.ios_l3_interfaces module – Resource module to configure L3 interfaces.
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_interfaces
.
New in cisco.ios 1.0.0
Synopsis
This module provides declarative management of Layer-3 interface on Cisco IOS devices.
Parameters
Parameter |
Comments |
---|---|
A dictionary of Layer-3 interface options |
|
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. |
|
Configures the IPv4 address for Interface. |
|
IP Address negotiated via DHCP. |
|
Specify client-id to use. |
|
Enable dhcp. Choices:
|
|
Specify value for hostname option. |
|
Configures and specifies client-id to use over DHCP ip. Note, This option shall work only when dhcp is configured as IP. GigabitEthernet interface number This option is DEPRECATED and is replaced with dhcp which accepts dict as input this attribute will be removed after 2023-08-01. |
|
Configures and specifies value for hostname option over DHCP ip. Note, This option shall work only when dhcp is configured as IP. This option is DEPRECATED and is replaced with dhcp which accepts dict as input this attribute will be removed after 2023-08-01. |
|
IP Address auto-configured from a local DHCP pool. |
|
Configures the IP address as a secondary address. Choices:
|
|
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 |
|
Configures the IPv6 address for Interface. |
|
Configure as an anycast Choices:
|
|
Obtain address using auto-configuration. |
|
Insert default route. Choices:
|
|
enable auto-configuration. Choices:
|
|
Use CGA interface identifier Choices:
|
|
Obtain a ipv6 address using DHCP. |
|
Enable dhcp. Choices:
|
|
Enable Rapid-Commit. Choices:
|
|
Use eui-64 interface identifier Choices:
|
|
Use link-local address Choices:
|
|
Segment Routing submode |
|
Set a command to its defaults. Choices:
|
|
Enable segmented routing. Choices:
|
|
Set ipv6_sr. Choices:
|
|
Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1. |
|
This option is used only with state parsed. The value of this option should be the output received from the IOS device by executing the command show running-config | section ^interface. The state parsed reads the configuration from |
|
The state the configuration should be left in The states rendered, gathered and parsed does not perform any change on the device. The state rendered will transform the configuration in The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result. The state parsed reads the configuration from Choices:
|
Notes
Note
Tested against Cisco IOSv Version 15.6.
Using deleted state without config will delete all l3 attributes from all the interfaces.
This module works with connection
network_cli
. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
Examples
# Using state merged
# Before state:
# -------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# description Configured by Ansible
# ip address 10.1.1.1 255.255.255.0
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description This is test
# no ip address
# duplex auto
# speed 1000
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# no ip address
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
- name: Merge provided configuration with device configuration
cisco.ios.ios_l3_interfaces:
config:
- name: GigabitEthernet0/1
ipv4:
- address: 192.168.0.1/24
secondary: true
- name: GigabitEthernet0/2
ipv4:
- address: 192.168.0.2/24
- name: GigabitEthernet0/3
ipv6:
- address: fd5d:12c9:2201:1::1/64
- name: GigabitEthernet0/3.100
ipv4:
- address: 192.168.0.3/24
state: merged
# Commands Fired:
# ---------------
# "commands": [
# "interface GigabitEthernet0/1",
# "ip address 192.168.0.1 255.255.255.0 secondary",
# "interface GigabitEthernet0/2",
# "ip address 192.168.0.2 255.255.255.0",
# "interface GigabitEthernet0/3",
# "ipv6 address fd5d:12c9:2201:1::1/64",
# "GigabitEthernet0/3.100",
# "ip address 192.168.0.3 255.255.255.0",
# ],
# After state:
# ------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# description Configured by Ansible
# ip address 10.1.1.1 255.255.255.0
# ip address 192.168.0.1 255.255.255.0 secondary
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description This is test
# ip address 192.168.0.2 255.255.255.0
# duplex auto
# speed 1000
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# ipv6 address FD5D:12C9:2201:1::1/64
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# ip address 192.168.0.3 255.255.255.0
# Using state replaced
# Before state:
# -------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# description Configured by Ansible
# ip address 10.1.1.1 255.255.255.0
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description This is test
# no ip address
# duplex auto
# speed 1000
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# ip address 192.168.2.0 255.255.255.0
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# ip address 192.168.0.2 255.255.255.0
- name: Replaces device configuration of listed interfaces with provided configuration
cisco.ios.ios_l3_interfaces:
config:
- name: GigabitEthernet0/2
ipv4:
- address: 192.168.2.0/24
- name: GigabitEthernet0/3
ipv4:
- dhcp:
client_id: GigabitEthernet0/2
hostname: test.com
- name: GigabitEthernet0/3.100
ipv4:
- address: 192.168.0.3/24
secondary: true
state: replaced
# Commands Fired:
# ---------------
# "commands": [
# "interface GigabitEthernet0/1",
# "ip address 192.168.0.1 255.255.255.0 secondary",
# "interface GigabitEthernet0/2",
# "ip address 192.168.0.2 255.255.255.0",
# "interface GigabitEthernet0/3",
# "no ip address 192.168.2.0 255.255.255.0",
# "ip address dhcp client-id GigabitEthernet0/2 hostname test.com",
# "GigabitEthernet0/3.100",
# "no ip address 192.168.0.2 255.255.255.0",
# "ip address 192.168.0.3 255.255.255.0 secondary",
# ],
# After state:
# ------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# description Configured by Ansible
# ip address 10.1.1.1 255.255.255.0
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description This is test
# ip address 192.168.2.1 255.255.255.0
# duplex auto
# speed 1000
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# ip address dhcp client-id GigabitEthernet0/2 hostname test.com
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# ip address 192.168.0.3 255.255.255.0 secondary
# Using state overridden
# Before state:
# -------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# description Configured by Ansible
# ip address 10.1.1.1 255.255.255.0
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description This is test
# ip address 192.168.2.1 255.255.255.0
# duplex auto
# speed 1000
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# ipv6 address FD5D:12C9:2201:1::1/64
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# ip address 192.168.0.2 255.255.255.0
- name: Override device configuration of all interfaces with provided configuration
cisco.ios.ios_l3_interfaces:
config:
- name: GigabitEthernet0/2
ipv4:
- address: 192.168.0.1/24
- name: GigabitEthernet0/3.100
ipv6:
- autoconfig: true
state: overridden
# Commands Fired:
# ---------------
# "commands": [
# "interface GigabitEthernet0/1",
# "no ip address 10.1.1.1 255.255.255.0",
# "interface GigabitEthernet0/2",
# "no ip address 192.168.2.1 255.255.255.0",
# "ip address 192.168.0.1 255.255.255.0",
# "interface GigabitEthernet0/3",
# "no ipv6 address FD5D:12C9:2201:1::1/64",
# "GigabitEthernet0/3.100",
# "no ip address 192.168.0.2 255.255.255.0",
# "ipv6 address autoconfig",
# ],
# After state:
# ------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# description Configured by Ansible
# no ip address
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description This is test
# ip address 192.168.0.1 255.255.255.0
# duplex auto
# speed 1000
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# ipv6 address autoconfig
# Using state Deleted
# Before state:
# -------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# ip address 192.0.2.10 255.255.255.0
# shutdown
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description Configured by Ansible Network
# ip address 192.168.1.0 255.255.255.0
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# ip address 192.168.0.1 255.255.255.0
# shutdown
# duplex full
# speed 10
# ipv6 address FD5D:12C9:2201:1::1/64
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# ip address 192.168.0.2 255.255.255.0
- name: "Delete attributes of given interfaces (NOTE: This won't delete the interfaces itself)"
cisco.ios.ios_l3_interfaces:
config:
- name: GigabitEthernet0/2
- name: GigabitEthernet0/3.100
state: deleted
# "commands": [
# "interface GigabitEthernet0/2",
# "no ip address 192.168.1.0 255.255.255.0",
# "GigabitEthernet0/3.100",
# "no ip address 192.168.0.2 255.255.255.0",
# ],
# After state:
# -------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# ip address 192.0.2.10 255.255.255.0
# shutdown
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description Configured by Ansible Network
# no ip address
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# ip address 192.168.0.1 255.255.255.0
# shutdown
# duplex full
# speed 10
# ipv6 address FD5D:12C9:2201:1::1/64
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# Using state Deleted without any config passed
#"(NOTE: This will delete all of configured L3 resource module attributes from each configured interface)"
# Before state:
# -------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# ip address 192.0.2.10 255.255.255.0
# shutdown
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description Configured by Ansible Network
# ip address 192.168.1.0 255.255.255.0
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# ip address 192.168.0.1 255.255.255.0
# shutdown
# duplex full
# speed 10
# ipv6 address FD5D:12C9:2201:1::1/64
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# ip address 192.168.0.2 255.255.255.0
- name: "Delete L3 attributes of ALL interfaces together (NOTE: This won't delete the interface itself)"
cisco.ios.ios_l3_interfaces:
state: deleted
# "commands": [
# "interface GigabitEthernet0/1",
# "no ip address 192.0.2.10 255.255.255.0",
# "interface GigabitEthernet0/2",
# "no ip address 192.168.1.0 255.255.255.0",
# "interface GigabitEthernet0/3",
# "no ip address 192.168.0.1 255.255.255.0",
# "no ipv6 address FD5D:12C9:2201:1::1/64",
# "GigabitEthernet0/3.100",
# "no ip address 192.168.0.2 255.255.255.0",
# ],
# After state:
# -------------
# router-ios#show running-config | section ^interface
# interface GigabitEthernet0/1
# no ip address
# shutdown
# duplex auto
# speed auto
# interface GigabitEthernet0/2
# description Configured by Ansible Network
# no ip address
# interface GigabitEthernet0/3
# description Configured by Ansible Network
# shutdown
# duplex full
# speed 10
# interface GigabitEthernet0/3.100
# encapsulation dot1Q 20
# Using state Gathered
# Before state:
# -------------
# router-ios#sh running-config | section ^interface
# interface GigabitEthernet0/1
# ip address 203.0.113.27 255.255.255.0
# interface GigabitEthernet0/2
# ip address 192.0.2.1 255.255.255.0 secondary
# ip address 192.0.2.2 255.255.255.0
# ipv6 address 2001:DB8:0:3::/64
- name: Gather listed l3 interfaces with provided configurations
cisco.ios.ios_l3_interfaces:
state: gathered
# Module Execution Result:
# ------------------------
# "gathered": [
# {
# "ipv4": [
# {
# "address": "203.0.113.27 255.255.255.0"
# }
# ],
# "name": "GigabitEthernet0/1"
# },
# {
# "ipv4": [
# {
# "address": "192.0.2.1 255.255.255.0",
# "secondary": true
# },
# {
# "address": "192.0.2.2 255.255.255.0"
# }
# ],
# "ipv6": [
# {
# "address": "2001:db8:0:3::/64"
# }
# ],
# "name": "GigabitEthernet0/2"
# }
# ]
# After state:
# ------------
# router-ios#sh running-config | section ^interface
# interface GigabitEthernet0/1
# ip address 203.0.113.27 255.255.255.0
# interface GigabitEthernet0/2
# ip address 192.0.2.1 255.255.255.0 secondary
# ip address 192.0.2.2 255.255.255.0
# ipv6 address 2001:DB8:0:3::/64
# Using state Rendered
- name: Render the commands for provided configuration
cisco.ios.ios_l3_interfaces:
config:
- name: GigabitEthernet0/1
ipv4:
- dhcp:
client_id: GigabitEthernet0/0
hostname: test.com
- name: GigabitEthernet0/2
ipv4:
- address: 198.51.100.1/24
secondary: true
- address: 198.51.100.2/24
ipv6:
- address: 2001:db8:0:3::/64
state: rendered
# Module Execution Result:
# ------------------------
# "rendered": [
# "interface GigabitEthernet0/1",
# "ip address dhcp client-id GigabitEthernet 0/0 hostname test.com",
# "interface GigabitEthernet0/2",
# "ip address 198.51.100.1 255.255.255.0 secondary",
# "ip address 198.51.100.2 255.255.255.0",
# "ipv6 address 2001:db8:0:3::/64"
# ]
# Using state Parsed
# File: parsed.cfg
# ----------------
#
# interface GigabitEthernet0/1
# ip address dhcp client-id GigabitEthernet 0/0 hostname test.com
# interface GigabitEthernet0/2
# ip address 198.51.100.1 255.255.255.0
# ip address 198.51.100.2 255.255.255.0 secondary
# ipv6 address 2001:db8:0:3::/64
- name: Parse the commands for provided configuration
cisco.ios.ios_l3_interfaces:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# Module Execution Result:
# ------------------------
# "parsed": [
# {
# "ipv4": [
# {
# "dhcp": {
# "client_id": GigabitEthernet0/0,
# "hostname": "test.com"
# }
# }
# ],
# "name": "GigabitEthernet0/1"
# },
# {
# "ipv4": [
# {
# "address": "198.51.100.1/24",
# "secondary": true
# },
# {
# "address": "198.51.100.2/24"
# }
# ],
# "ipv6": [
# {
# "address": "2001:db8:0:3::/64"
# }
# ],
# "name": "GigabitEthernet0/2"
# }
# ]
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The resulting configuration after module execution. Returned: when changed Sample: |
|
The configuration prior to the module execution. Returned: when state is merged, replaced, overridden, deleted or purged Sample: |
|
The set of commands pushed to the remote device. Returned: when state is merged, replaced, overridden, deleted or purged Sample: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is gathered Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is parsed Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is rendered Sample: |