ios_lacp_interfaces – Manage Link Aggregation Control Protocol (LACP) on Cisco IOS devices interface
New in version 2.9.
Synopsis
- This module provides declarative management of LACP on Cisco IOS network devices lacp_interfaces.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
config
list /
elements=dictionary
|
A dictionary of LACP lacp_interfaces option
|
||
fast_switchover
boolean
|
|
LACP fast switchover supported on this port channel.
|
|
max_bundle
integer
|
LACP maximum number of ports to bundle in this port channel.
Refer to vendor documentation for valid port values.
|
||
name
string /
required
|
Name of the Interface for configuring LACP.
|
||
port_priority
integer
|
LACP priority on this interface.
Refer to vendor documentation for valid port values.
|
||
state
string
|
|
The state of the configuration after module completion
|
Notes
Note
- Tested against Cisco IOSv Version 15.2 on VIRL.
- This module works with connection
network_cli
, See IOS Platform Options.
Examples
# 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 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 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 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)" 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)" 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
after
list
|
when changed |
The configuration as structured data after module completion.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
before
list
|
always |
The configuration as structured data prior to module invocation.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
commands
list
|
always |
The set of commands pushed to the remote device.
Sample:
['interface GigabitEthernet 0/1', 'lacp port-priority 30']
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Sumit Jaiswal (@justjais)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ios_lacp_interfaces_module.html