cisco / cisco.ios / 8.0.0 / module / ios_l3_interfaces Resource module to configure L3 interfaces. | "added in version" 1.0.0 of cisco.ios" Authors: Sagar Paul (@KB-perByte), Sumit Jaiswal (@justjais)cisco.ios.ios_l3_interfaces (8.0.0) — module
Install with ansible-galaxy collection install cisco.ios:==8.0.0
collections: - name: cisco.ios version: 8.0.0
This module provides declarative management of Layer-3 interface on Cisco IOS devices.
# Using merged # Before state: # ------------- # # Router#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address dhcp # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto - 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: GigabitEthernet2 ipv4: - address: 192.168.0.2/24 - name: GigabitEthernet3 ipv6: - address: fd5d:12c9:2201:1::1/64 - name: GigabitEthernet3.100 ipv4: - address: 192.168.0.3/24 - name: Vlan901 autostate: false ipv4: - source_interface: name: Loopback1 ipv6: - enable: true state: merged
# Task Output # ----------- # # before: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet2 # - name: GigabitEthernet3 # - name: GigabitEthernet4 # - name: Loopback999 # commands: # - interface GigabitEthernet2 # - ip address 192.168.0.2 255.255.255.0 # - interface GigabitEthernet3 # - ipv6 address fd5d:12c9:2201:1::1/64 # - interface GigabitEthernet3.100 # - ip address 192.168.0.3 255.255.255.0 # - interface Vlan901 # - ip unnumbered Loopback1 # - ipv6 enable # - no autostate # after: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.2/24 # name: GigabitEthernet2 # - ipv6: # - address: FD5D:12C9:2201:1::1/64 # name: GigabitEthernet3 # - name: GigabitEthernet3.100 # ipv4: # - address: 192.168.0.3/24 # - name: GigabitEthernet4 # - name: Loopback999 # ipv4: # - source_interface: # name: Loopback1 # ipv6: # - enable: true # autostate: false # - name: Vlan901 # After state: # ------------ # # Router#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.2 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # ipv6 address FD5D:12C9:2201:1::1/64 # interface GigabitEthernet3.100 # ip address 192.168.0.3 255.255.255.0 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto # interface Vlan901 # ip unnumbered Loopback1 # ipv6 enable # no autostate # Using replaced # Before state: # ------------- # # Router#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.2 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # ipv6 address FD5D:12C9:2201:1::1/64 # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto - name: Replaces device configuration of listed interfaces with provided configuration cisco.ios.ios_l3_interfaces: config: - name: GigabitEthernet2 ipv4: - address: 192.168.2.0/24 - name: GigabitEthernet3 ipv4: - dhcp: client_id: GigabitEthernet2 hostname: test.com state: replaced
# Task Output # ----------- # # before: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.2/24 # name: GigabitEthernet2 # - ipv6: # - address: FD5D:12C9:2201:1::1/64 # name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # commands: # - interface GigabitEthernet2 # - ip address 192.168.0.3 255.255.255.0 # - no ip address 192.168.0.2 255.255.255.0 # - interface GigabitEthernet3 # - ip address dhcp client-id GigabitEthernet2 hostname test.com # - no ipv6 address fd5d:12c9:2201:1::1/64 # after: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.3/24 # name: GigabitEthernet2 # - ipv4: # - dhcp: # client_id: GigabitEthernet2 # enable: true # hostname: test.com # name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # After state: # ------------ # # router-ios#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.3 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # ip address dhcp client-id GigabitEthernet2 hostname test.com # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto # Using overridden # Before state: # ------------- # # router-ios#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.3 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # ip address dhcp client-id GigabitEthernet2 hostname test.com # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto - name: Override device configuration of all interfaces with provided configuration cisco.ios.ios_l3_interfaces: config: - ipv4: - dhcp: enable: true name: GigabitEthernet1 - name: GigabitEthernet2 ipv4: - address: 192.168.0.1/24 - name: GigabitEthernet3 state: overridden
# Task Output # ----------- # before: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.3/24 # name: GigabitEthernet2 # - ipv4: # - dhcp: # client_id: GigabitEthernet2 # enable: true # hostname: test.com # name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # commands: # - interface GigabitEthernet2 # - ip address 192.168.0.1 255.255.255.0 # - no ip address 192.168.0.3 255.255.255.0 # - interface GigabitEthernet3 # - no ip address dhcp client-id GigabitEthernet2 hostname test.com # after: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.1/24 # name: GigabitEthernet2 # - name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # After state: # ------------ # # router-ios#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.1 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto # Using deleted # Before state: # ------------- # # router-ios#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.1 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto - name: "Delete attributes of given interfaces (NOTE: This won't delete the interfaces)" cisco.ios.ios_l3_interfaces: config: - name: GigabitEthernet2 - name: GigabitEthernet3.100 state: deleted
# Task Output # ----------- # # before: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.1/24 # name: GigabitEthernet2 # - name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # commands: # - interface GigabitEthernet2 # - no ip address 192.168.0.1 255.255.255.0 # after: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - name: GigabitEthernet2 # - name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # After state: # ------------- # # router-ios#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # no ip address # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto # Using deleted without config passed, only interface's configuration will be negated # Before state: # ------------- # router-ios#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.2 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # ipv6 address FD5D:12C9:2201:1::1/64 # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto - name: "Delete L3 config of all interfaces" cisco.ios.ios_l3_interfaces: state: deleted
# Task Output # ----------- # # before: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.2/24 # name: GigabitEthernet2 # - ipv6: # - address: FD5D:12C9:2201:1::1/64 # name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # commands: # - interface GigabitEthernet1 # - no ip address dhcp # - interface GigabitEthernet2 # - no ip address 192.168.0.2 255.255.255.0 # - interface GigabitEthernet3 # - no ipv6 address fd5d:12c9:2201:1::1/64 # after: # - name: GigabitEthernet1 # - name: GigabitEthernet2 # - name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # After state: # ------------- # # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # negotiation auto # interface GigabitEthernet2 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # no ip address # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto # Using gathered # Before state: # ------------- # # Router#show running-config | section ^interface # interface Loopback999 # no ip address # shutdown # interface GigabitEthernet1 # description Management interface do not change # ip address dhcp # negotiation auto # interface GigabitEthernet2 # ip address 192.168.0.3 255.255.255.0 # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3 # description Configured and Overridden by Ansible Network # ip address dhcp client-id GigabitEthernet2 hostname test.com # shutdown # speed 1000 # no negotiation auto # interface GigabitEthernet3.100 # interface GigabitEthernet4 # no ip address # shutdown # negotiation auto - name: Gather facts for l3 interfaces cisco.ios.ios_l3_interfaces: state: gathered
# Task Output # ----------- # # gathered: # - ipv4: # - dhcp: # enable: true # name: GigabitEthernet1 # - ipv4: # - address: 192.168.0.3/24 # name: GigabitEthernet2 # - ipv4: # - dhcp: # client_id: GigabitEthernet2 # enable: true # hostname: test.com # name: GigabitEthernet3 # - name: GigabitEthernet3.100 # - name: GigabitEthernet4 # - name: Loopback999 # Using rendered - name: Render the commands for provided configuration cisco.ios.ios_l3_interfaces: config: - name: GigabitEthernet1 ipv4: - dhcp: client_id: GigabitEthernet0/0 hostname: test.com - name: GigabitEthernet2 ipv4: - address: 198.51.100.1/24 secondary: true - address: 198.51.100.2/24 ipv6: - address: 2001:db8:0:3::/64 state: rendered
# Task Output # ----------- # # rendered: # - interface GigabitEthernet1 # - ip address dhcp client-id GigabitEthernet0/0 hostname test.com # - interface GigabitEthernet2 # - 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 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 provided configuration cisco.ios.ios_l3_interfaces: running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed
state: choices: - merged - replaced - overridden - deleted - rendered - gathered - parsed default: merged description: - The state the configuration should be left in - The states I(rendered), I(gathered) and I(parsed) does not perform any change on the device. - The state I(rendered) will transform the configuration in C(config) option to platform specific CLI commands which will be returned in the I(rendered) key within the result. For state I(rendered) active connection to remote host is not required. - The state I(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 I(gathered) key within the result. - The state I(parsed) reads the configuration from C(running_config) option and transforms it into JSON format as per the resource module parameters and the value is returned in the I(parsed) key within the result. The value of C(running_config) option should be the same format as the output of command I(show running-config | section ^interface) executed on device. For state I(parsed) active connection to remote host is not required. type: str config: description: A dictionary of Layer-3 interface options elements: dict suboptions: autostate: description: - Enable autostate determination for VLAN. type: bool 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. elements: dict suboptions: address: description: - Configures the IPv4 address for Interface. type: str dhcp: description: IP Address negotiated via DHCP. suboptions: client_id: description: Specify client-id to use. type: str enable: description: Enable dhcp. type: bool hostname: description: Specify value for hostname option. type: str type: dict dhcp_client: description: - 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. type: str dhcp_hostname: description: - 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. type: str pool: description: IP Address auto-configured from a local DHCP pool. type: str secondary: description: - Configures the IP address as a secondary address. type: bool source_interface: description: Enable IP processing without an explicit address suboptions: name: description: Interface name type: str point_to_point: description: Enable point-to-point connection type: bool poll: description: Enable IP connected host polling type: bool type: dict type: list 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 elements: dict suboptions: address: description: - Configures the IPv6 address for Interface. type: str anycast: description: Configure as an anycast type: bool autoconfig: description: Obtain address using auto-configuration. suboptions: default: description: Insert default route. type: bool enable: description: enable auto-configuration. type: bool type: dict cga: description: Use CGA interface identifier type: bool dhcp: description: Obtain a ipv6 address using DHCP. suboptions: enable: description: Enable dhcp. type: bool rapid_commit: description: Enable Rapid-Commit. type: bool type: dict enable: description: Enable IPv6 on interface type: bool eui: description: Use eui-64 interface identifier type: bool link_local: description: Use link-local address type: bool segment_routing: description: Segment Routing submode suboptions: default: description: Set a command to its defaults. type: bool enable: description: Enable segmented routing. type: bool ipv6_sr: description: Set ipv6_sr. type: bool type: dict type: list mac_address: description: - Manually set interface MAC address. type: str name: description: - Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1. required: true type: str type: list running_config: description: - This option is used only with state I(parsed). - The value of this option should be the output received from the IOS device by executing the command B(show running-config | section ^interface). - The state I(parsed) reads the configuration from C(running_config) option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the I(parsed) key within the result. type: str
after: description: The resulting configuration after module execution. returned: when changed sample: 'This output will always be in the same format as the module argspec. ' type: dict before: description: The configuration prior to the module execution. returned: when state is I(merged), I(replaced), I(overridden), I(deleted) or I(purged) sample: 'This output will always be in the same format as the module argspec. ' type: dict commands: description: The set of commands pushed to the remote device. returned: when state is I(merged), I(replaced), I(overridden), I(deleted) or I(purged) sample: - ip address 192.168.0.3 255.255.255.0 - ipv6 address dhcp rapid-commit - ipv6 address fd5d:12c9:2201:1::1/64 anycast type: list gathered: description: Facts about the network resource gathered from the remote device as structured data. returned: when state is I(gathered) sample: 'This output will always be in the same format as the module argspec. ' type: list parsed: description: The device native config provided in I(running_config) option parsed into structured data as per module argspec. returned: when state is I(parsed) sample: 'This output will always be in the same format as the module argspec. ' type: list rendered: description: The provided configuration in the task rendered in device-native format (offline). returned: when state is I(rendered) sample: - ipv6 address FD5D:12C9:2201:1::1/64 - ip address 192.168.0.3 255.255.255.0 - ip address autoconfig type: list