cisco.meraki.meraki_ms_link_aggregation module -- Manage link aggregations on MS switches
Note
This module is part of the cisco.meraki collection (version 2.18.2).
To install it, use: ansible-galaxy collection install cisco.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_ms_link_aggregation
.
New in cisco.meraki 1.2.0
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.networks_switch_link_aggregations
Synopsis
Allows for management of MS switch link aggregations in a Meraki environment.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. |
|
Number of seconds to retry if server returns an internal server error. Default: :ansible-option-default:`60` |
|
ID of lag to query or modify. |
|
ID of network. |
|
Name of network. |
|
ID of organization. |
|
Name of organization. |
|
Instructs module whether response keys should be snake case (ex. Choices: |
|
Set amount of debug output during module execution. Choices: |
|
Number of seconds to retry if rate limiter is triggered. Default: :ansible-option-default:`165` |
|
Specifies whether SNMP information should be queried or modified. Choices: |
|
List of switchports to include in link aggregation. |
|
Port number which should be included in link aggregation. |
|
Serial number of switch to own link aggregation. |
|
Time to timeout for HTTP requests. Default: :ansible-option-default:`30` |
|
If Only useful for internal Meraki developers. Choices: |
|
If Choices: |
|
Whether to validate HTTP certificates. Choices: |
Notes
Note
Switch profile ports are not supported in this module.
More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
Some of the options are likely only used for developers within Meraki.
As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the
ANSIBLE_MERAKI_FORMAT
environment variable tocamelcase
.Ansible's Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.
Examples
- name: Create LAG
meraki_ms_link_aggregation:
auth_key: '{{auth_key}}'
state: present
org_name: '{{test_org_name}}'
net_name: '{{test_switch_net_name}}'
switch_ports:
- serial: '{{serial_switch}}'
port_id: "1"
- serial: '{{serial_switch}}'
port_id: "2"
delegate_to: localhost
- name: Update LAG
meraki_ms_link_aggregation:
auth_key: '{{auth_key}}'
state: present
org_name: '{{test_org_name}}'
net_name: '{{test_switch_net_name}}'
lag_id: '{{lag_id}}'
switch_ports:
- serial: '{{serial_switch}}'
port_id: "1"
- serial: '{{serial_switch}}'
port_id: "2"
- serial: '{{serial_switch}}'
port_id: "3"
- serial: '{{serial_switch}}'
port_id: "4"
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of aggregated links. Returned: success |
|
List of switch ports to be included in link aggregation. Returned: success |
|
Serial number of switch on which port resides. Returned: success |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.