cisco.nxos.nxos_linkagg module – (deprecated, removed after 2022-06-01) Manage link aggregation groups on Cisco NXOS devices.
Note
This module is part of the cisco.nxos collection (version 3.2.0).
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.nxos.
To use it in a playbook, specify: cisco.nxos.nxos_linkagg.
New in cisco.nxos 1.0.0
DEPRECATED
- Removed in:
major release after 2022-06-01
- Why:
Updated modules released with more functionality.
- Alternative:
nxos_lag_interfaces
Synopsis
This module provides declarative management of link aggregation groups on Cisco NXOS devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
|---|---|
List of link aggregation definitions. |
|
When true it forces link aggregation group members to match what is declared in the members param. This can be used to remove members. Choices:
|
|
Channel-group number for the port-channel Link aggregation group. |
|
List of interfaces that will be managed in the link aggregation group. |
|
Minimum number of ports required up before bringing up the link aggregation group. |
|
Mode for the link aggregation group. Choices:
|
|
State of the link aggregation group. Choices:
|
|
When true it forces link aggregation group members to match what is declared in the members param. This can be used to remove members. Choices:
|
|
Channel-group number for the port-channel Link aggregation group. |
|
List of interfaces that will be managed in the link aggregation group. |
|
Minimum number of ports required up before bringing up the link aggregation group. |
|
Mode for the link aggregation group. Choices:
|
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable Choices:
|
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable |
|
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). |
|
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). |
|
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable |
|
If Choices:
|
|
Purge links not defined in the aggregate parameter. Choices:
|
|
State of the link aggregation group. Choices:
|
Notes
Note
Tested against NXOSv 7.0(3)I5(1).
Unsupported for Cisco MDS
state=absentremoves the portchannel config and interface if it already exists. If members to be removed are not explicitly passed, all existing members (if any), are removed.Members must be a list.
LACP needs to be enabled first if active/passive modes are used.
For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: create link aggregation group
cisco.nxos.nxos_linkagg:
group: 99
state: present
- name: delete link aggregation group
cisco.nxos.nxos_linkagg:
group: 99
state: absent
- name: set link aggregation group to members
cisco.nxos.nxos_linkagg:
group: 10
min_links: 3
mode: active
members:
- Ethernet1/2
- Ethernet1/4
- name: remove link aggregation group from Ethernet1/2
cisco.nxos.nxos_linkagg:
group: 10
min_links: 3
mode: active
members:
- Ethernet1/4
- name: Create aggregate of linkagg definitions
cisco.nxos.nxos_linkagg:
aggregate:
- {group: 3}
- {group: 100, min_links: 3}
- name: Remove aggregate of linkagg definitions
cisco.nxos.nxos_linkagg:
aggregate:
- {group: 3}
- {group: 100, min_links: 3}
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The list of configuration mode commands to send to the device Returned: always, except for the platforms that use Netconf transport to manage the device. Sample: |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.