cisco.meraki.meraki_mx_uplink_bandwidth module – Manage uplinks on Meraki MX appliances
Note
This module is part of the cisco.meraki collection (version 2.13.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.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_mx_uplink_bandwidth
.
New in cisco.meraki 1.1.0
Synopsis
Configure and query information about uplinks on Meraki MX appliances.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
Configuration of cellular uplink |
|
Structure for configuring bandwidth limits |
|
Maximum download speed for interface |
|
Maximum upload speed for interface |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Number of seconds to retry if server returns an internal server error. Default: |
|
ID of network which VLAN is in or should be in. |
|
Name of network which VLAN is in or should be in. |
|
ID of organization associated to a network. |
|
Name of organization associated to a network. |
|
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: |
|
Specifies whether object should be queried, created/modified, or removed. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
|
Configuration of WAN1 uplink |
|
Structure for configuring bandwidth limits |
|
Maximum download speed for interface |
|
Maximum upload speed for interface |
|
Configuration of WAN2 uplink |
|
Structure for configuring bandwidth limits |
|
Maximum download speed for interface |
|
Maximum upload speed for interface |
Notes
Note
Some of the options are likely only used for developers within Meraki.
Module was formerly named cisco.meraki.meraki_mx_uplink.
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: Set MX uplink settings
meraki_mx_uplink_bandwidth:
auth_key: '{{auth_key}}'
state: present
org_name: '{{test_org_name}}'
net_name: '{{test_net_name}} - Uplink'
wan1:
bandwidth_limits:
limit_down: 1000000
limit_up: 1000
cellular:
bandwidth_limits:
limit_down: 0
limit_up: 0
delegate_to: localhost
- name: Query MX uplink settings
meraki_mx_uplink_bandwidth:
auth_key: '{{auth_key}}'
state: query
org_name: '{{test_org_name}}'
net_name: '{{test_net_name}} - Uplink'
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about the organization which was created or modified Returned: success |
|
cellular interface Returned: success |
|
Structure for uplink bandwidth limits Returned: success |
|
Download bandwidth limit Returned: success |
|
Upload bandwidth limit Returned: success |
|
WAN1 interface Returned: success |
|
Structure for uplink bandwidth limits Returned: success |
|
Download bandwidth limit Returned: success |
|
Upload bandwidth limit Returned: success |
|
WAN2 interface Returned: success |
|
Structure for uplink bandwidth limits Returned: success |
|
Download bandwidth limit Returned: success |
|
Upload bandwidth limit Returned: success |