ansible / ansible.builtin / v2.8.13 / module / nxos_linkagg Manage link aggregation groups on Cisco NXOS devices. | "added in version" 2.5 of ansible.builtin" Authors: Trishna Guha (@trishnaguha) preview | supported by networkansible.builtin.nxos_linkagg (v2.8.13) — module
pip
Install with pip install ansible==2.8.13
This module provides declarative management of link aggregation groups on Cisco NXOS devices.
- name: create link aggregation group nxos_linkagg: group: 99 state: present
- name: delete link aggregation group nxos_linkagg: group: 99 state: absent
- name: set link aggregation group to members nxos_linkagg: group: 10 min_links: 3 mode: active members: - Ethernet1/2 - Ethernet1/4
- name: remove link aggregation group from Ethernet1/2 nxos_linkagg: group: 10 min_links: 3 mode: active members: - Ethernet1/4
- name: Create aggregate of linkagg definitions nxos_linkagg: aggregate: - { group: 3 } - { group: 100, min_links: 3 }
- name: Remove aggregate of linkagg definitions nxos_linkagg: aggregate: - { group: 3 } - { group: 100, min_links: 3 } state: absent
mode: choices: - active - 'on' - passive default: 'on' description: - Mode for the link aggregation group. force: default: 'no' description: - When true it forces link aggregation group members to match what is declared in the members param. This can be used to remove members. type: bool group: description: - Channel-group number for the port-channel Link aggregation group. required: true type: str purge: default: 'no' description: - Purge links not defined in the I(aggregate) parameter. type: bool state: choices: - present - absent default: present description: - State of the link aggregation group. members: description: - List of interfaces that will be managed in the link aggregation group. provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.' - This option will be removed in a release after 2022-06-01. - For more information please see the U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool host: description: - 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. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either I(cli) or I(nxapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: description: - Specifies the port to use when building the connection to the remote device. This value applies to either I(cli) or I(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). type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: str timeout: description: - 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). type: int transport: choices: - cli - nxapi default: cli description: - 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. type: str use_proxy: default: true description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. type: bool use_ssl: default: false description: - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi), otherwise this value is ignored. type: bool username: description: - 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 C(ANSIBLE_NET_USERNAME) will be used instead. type: str validate_certs: default: false description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored. type: bool type: dict aggregate: description: List of link aggregation definitions. min_links: description: - Minimum number of ports required up before bringing up the link aggregation group.
commands: 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: - interface port-channel 30 - lacp min-links 5 - interface Ethernet2/1 - channel-group 30 mode active - no interface port-channel 30 type: list