cisco.ios.ios_linkagg – Manage link aggregation groups on Cisco IOS network devices¶
Note
This plugin is part of the cisco.ios collection (version 2.4.0).
To install it use: ansible-galaxy collection install cisco.ios.
To use it in a playbook, specify: cisco.ios.ios_linkagg.
New in version 1.0.0: of cisco.ios
Synopsis¶
This module provides declarative management of link aggregation groups on Cisco IOS network devices.
Note
This module has a corresponding action plugin.
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
aggregate
list
/ elements=dictionary
|
List of link aggregation definitions.
|
||
|
group
string
/ required
|
Channel-group number for the port-channel Link aggregation group. Range 1-255.
|
||
|
members
list
/ elements=string
|
List of members of the link aggregation group.
|
||
|
mode
string
|
|
Mode of the link aggregation group.
On mode has to be quoted as 'on' or else pyyaml will convert to True before it gets to Ansible.
|
|
|
state
string
|
|
State of the link aggregation group.
|
|
|
group
integer
|
Channel-group number for the port-channel Link aggregation group. Range 1-255.
|
||
|
members
list
/ elements=string
|
List of members of the link aggregation group.
|
||
|
mode
string
|
|
Mode of the link aggregation group.
On mode has to be quoted as 'on' or else pyyaml will convert to True before it gets to Ansible.
|
|
|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli.For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html.
A dict object containing connection details.
|
||
|
auth_pass
string
|
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
ANSIBLE_NET_AUTH_PASS will be used instead. |
||
|
authorize
boolean
|
|
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
ANSIBLE_NET_AUTHORIZE will be used instead. |
|
|
host
string
|
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.
|
||
|
password
string
|
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_PASSWORD will be used instead. |
||
|
port
integer
|
Specifies the port to use when building the connection to the remote device.
|
||
|
ssh_keyfile
path
|
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
|
timeout
integer
|
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.
|
||
|
username
string
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_USERNAME will be used instead. |
||
|
purge
boolean
|
|
Purge links not defined in the aggregate parameter.
|
|
|
state
string
|
|
State of the link aggregation group.
|
|
Notes¶
Note
Tested against IOS 15.2
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples¶
- name: create link aggregation group
cisco.ios.ios_linkagg:
group: 10
state: present
- name: delete link aggregation group
cisco.ios.ios_linkagg:
group: 10
state: absent
- name: set link aggregation group to members
cisco.ios.ios_linkagg:
group: 200
mode: active
members:
- GigabitEthernet0/0
- GigabitEthernet0/1
- name: remove link aggregation group from GigabitEthernet0/0
cisco.ios.ios_linkagg:
group: 200
mode: active
members:
- GigabitEthernet0/1
- name: Create aggregate of linkagg definitions
cisco.ios.ios_linkagg:
aggregate:
- {group: 3, mode: on, members: [GigabitEthernet0/1]}
- {group: 100, mode: passive, members: [GigabitEthernet0/2]}
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Trishna Guha (@trishnaguha)