cisco / cisco.ios / 8.0.0 / module / ios_lacp Resource module to configure LACP. | "added in version" 1.0.0 of cisco.ios" Authors: Sumit Jaiswal (@justjais)cisco.ios.ios_lacp (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 Global LACP on Cisco IOS network devices.
# Using merged # # Before state: # ------------- # # vios#show lacp sys-id # 32768, 5e00.0000.8000 - name: Merge provided configuration with device configuration cisco.ios.ios_lacp: config: system: priority: 123 state: merged
# After state: # ------------ # # vios#show lacp sys-id # 123, 5e00.0000.8000 # Using replaced # # Before state: # ------------- # # vios#show lacp sys-id # 500, 5e00.0000.8000 - name: Replaces Global LACP configuration cisco.ios.ios_lacp: config: system: priority: 123 state: replaced
# After state: # ------------ # # vios#show lacp sys-id # 123, 5e00.0000.8000 # Using Deleted # # Before state: # ------------- # # vios#show lacp sys-id # 500, 5e00.0000.8000 - name: Delete Global LACP attribute cisco.ios.ios_lacp: state: deleted
# After state: # ------------- # # vios#show lacp sys-id # 32768, 5e00.0000.8000 # Using Gathered # Before state: # ------------- # # vios#show lacp sys-id # 123, 5e00.0000.8000 - name: Gather listed LACP with provided configurations cisco.ios.ios_lacp: config: state: gathered
# Module Execution Result: # ------------------------ # # "gathered": { # "system": { # "priority": 500 # } # } # After state: # ------------ # # vios#show lacp sys-id # 123, 5e00.0000.8000 # Using Rendered - name: Render the commands for provided configuration cisco.ios.ios_lacp: config: system: priority: 123 state: rendered
# Module Execution Result: # ------------------------ # # "rendered": [ # "lacp system-priority 10" # ] # Using Parsed # File: parsed.cfg # ---------------- # # lacp system-priority 123 - name: Parse the commands for provided configuration cisco.ios.ios_lacp: running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed
state: choices: - merged - replaced - overridden - deleted - rendered - parsed - gathered default: merged description: - The state the configuration should be left in - The module have declaratively similar behavior for replaced and overridden state. - 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: The provided configurations. suboptions: system: description: This option sets the default system parameters for LACP. suboptions: priority: description: - LACP priority for the system. - Refer to vendor documentation for valid values. required: true type: int type: dict type: dict 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 lacp sys-id). - 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: - lacp system-priority 10 type: list