cisco / cisco.ios / 8.0.0 / module / ios_lacp_interfaces Resource module to configure LACP interfaces. | "added in version" 1.0.0 of cisco.ios" Authors: Sumit Jaiswal (@justjais)cisco.ios.ios_lacp_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 LACP on Cisco IOS network devices lacp_interfaces.
# Using merged # # Before state: # ------------- # # vios#show running-config | section ^interface # interface Port-channel10 # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # interface GigabitEthernet0/2 # shutdown # interface GigabitEthernet0/3 # shutdown - name: Merge provided configuration with device configuration cisco.ios.ios_lacp_interfaces: config: - name: GigabitEthernet0/1 port_priority: 10 - name: GigabitEthernet0/2 port_priority: 20 - name: GigabitEthernet0/3 port_priority: 30 - name: Port-channel10 fast_switchover: true max_bundle: 5 state: merged
# After state: # ------------ # # vios#show running-config | section ^interface # interface Port-channel10 # lacp fast-switchover # lacp max-bundle 5 # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # lacp port-priority 10 # interface GigabitEthernet0/2 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/3 # shutdown # lacp port-priority 30 # Using overridden # # Before state: # ------------- # # vios#show running-config | section ^interface # interface Port-channel10 # lacp fast-switchover # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # lacp port-priority 10 # interface GigabitEthernet0/2 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/3 # shutdown # lacp port-priority 30 - name: Override device configuration of all lacp_interfaces with provided configuration cisco.ios.ios_lacp_interfaces: config: - name: GigabitEthernet0/1 port_priority: 20 - name: Port-channel10 max_bundle: 2 state: overridden
# After state: # ------------ # # vios#show running-config | section ^interface # interface Port-channel10 # lacp max-bundle 2 # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/2 # shutdown # interface GigabitEthernet0/3 # shutdown # Using replaced # # Before state: # ------------- # # vios#show running-config | section ^interface # interface Port-channel10 # lacp max-bundle 5 # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # lacp port-priority 10 # interface GigabitEthernet0/2 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/3 # shutdown # lacp port-priority 30 - name: Replaces device configuration of listed lacp_interfaces with provided configuration cisco.ios.ios_lacp_interfaces: config: - name: GigabitEthernet0/3 port_priority: 40 - name: Port-channel10 fast_switchover: true max_bundle: 2 state: replaced
# After state: # ------------ # # vios#show running-config | section ^interface # interface Port-channel10 # lacp fast-switchover # lacp max-bundle 2 # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # lacp port-priority 10 # interface GigabitEthernet0/2 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/3 # shutdown # lacp port-priority 40 # Using Deleted # # Before state: # ------------- # # vios#show running-config | section ^interface # interface Port-channel10 # flowcontrol receive on # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # lacp port-priority 10 # interface GigabitEthernet0/2 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/3 # shutdown # lacp port-priority 30 - name: "Delete LACP attributes of given interfaces (Note: This won't delete the interface itself)" cisco.ios.ios_lacp_interfaces: config: - name: GigabitEthernet0/1 state: deleted
# After state: # ------------- # # vios#show running-config | section ^interface # interface Port-channel10 # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # interface GigabitEthernet0/2 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/3 # shutdown # lacp port-priority 30 # Using Deleted without any config passed # "(NOTE: This will delete all of configured LLDP module attributes)" # # Before state: # ------------- # # vios#show running-config | section ^interface # interface Port-channel10 # lacp fast-switchover # interface Port-channel20 # lacp max-bundle 2 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # lacp port-priority 10 # interface GigabitEthernet0/2 # shutdown # lacp port-priority 20 # interface GigabitEthernet0/3 # shutdown # lacp port-priority 30 - name: "Delete LACP attributes for all configured interfaces (Note: This won't delete the interface itself)" cisco.ios.ios_lacp_interfaces: state: deleted
# After state: # ------------- # # vios#show running-config | section ^interface # interface Port-channel10 # interface Port-channel20 # interface Port-channel30 # interface GigabitEthernet0/1 # shutdown # interface GigabitEthernet0/2 # shutdown # interface GigabitEthernet0/3 # shutdown # Using Gathered # Before state: # ------------- # # vios#sh running-config | section ^interface # interface Port-channel10 # lacp fast-switchover # lacp max-bundle 2 # interface Port-channel40 # lacp max-bundle 5 # interface GigabitEthernet0/0 # interface GigabitEthernet0/1 # lacp port-priority 30 # interface GigabitEthernet0/2 # lacp port-priority 20 - name: Gather listed LACP interfaces with provided configurations cisco.ios.ios_lacp_interfaces: config: state: gathered
# Module Execution Result: # ------------------------ # # "gathered": [ # { # "fast_switchover": true, # "max_bundle": 2, # "name": "Port-channel10" # }, # { # "max_bundle": 5, # "name": "Port-channel40" # }, # { # "name": "GigabitEthernet0/0" # }, # { # "name": "GigabitEthernet0/1", # "port_priority": 30 # }, # { # "name": "GigabitEthernet0/2", # "port_priority": 20 # } # ] # After state: # ------------ # # vios#sh running-config | section ^interface # interface Port-channel10 # lacp fast-switchover # lacp max-bundle 2 # interface Port-channel40 # lacp max-bundle 5 # interface GigabitEthernet0/0 # interface GigabitEthernet0/1 # lacp port-priority 30 # interface GigabitEthernet0/2 # lacp port-priority 20 # Using Rendered - name: Render the commands for provided configuration cisco.ios.ios_lacp_interfaces: config: - name: GigabitEthernet0/1 port_priority: 10 - name: GigabitEthernet0/2 port_priority: 20 - name: Port-channel10 fast_switchover: true max_bundle: 2 state: rendered
# Module Execution Result: # ------------------------ # # "rendered": [ # "interface GigabitEthernet0/1", # "lacp port-priority 10", # "interface GigabitEthernet0/2", # "lacp port-priority 20", # "interface Port-channel10", # "lacp max-bundle 2", # "lacp fast-switchover" # ] # Using Parsed # File: parsed.cfg # ---------------- # # interface GigabitEthernet0/1 # lacp port-priority 10 # interface GigabitEthernet0/2 # lacp port-priority 20 # interface Port-channel10 # lacp max-bundle 2 fast-switchover - name: Parse the commands for provided configuration cisco.ios.ios_lacp_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 | include ip route|ipv6 route) executed on device. For state I(parsed) active connection to remote host is not required. type: str config: description: A dictionary of LACP lacp_interfaces option elements: dict suboptions: fast_switchover: description: - LACP fast switchover supported on this port channel. type: bool max_bundle: description: - LACP maximum number of ports to bundle in this port channel. - Refer to vendor documentation for valid port values. type: int name: description: - Name of the Interface for configuring LACP. required: true type: str port_priority: description: - LACP priority on this interface. - Refer to vendor documentation for valid port values. type: int 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 configuration as structured data after module completion. returned: when changed sample: "The configuration returned will always be in the same format\n of the parameters\ \ above.\n" type: list before: description: The configuration as structured data prior to module invocation. returned: always sample: "The configuration returned will always be in the same format\n of the parameters\ \ above.\n" type: list commands: description: The set of commands pushed to the remote device. returned: always sample: - interface GigabitEthernet 0/1 - lacp port-priority 30 type: list