cisco.meraki.meraki_mx_uplink_bandwidth – Manage uplinks on Meraki MX appliances
Note
This plugin is part of the cisco.meraki collection (version 2.5.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 version 1.1.0: of cisco.meraki
Synopsis
- Configure and query information about uplinks on Meraki MX appliances.
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| auth_key
string / required
|
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
|
|||
| cellular
dictionary
|
Configuration of cellular uplink
|
|||
| bandwidth_limits
dictionary
|
Structure for configuring bandwidth limits
|
|||
| limit_down
integer
|
Maximum download speed for interface
|
|||
| limit_up
integer
|
Maximum upload speed for interface
|
|||
| host
string
|
Default:
"api.meraki.com"
|
Hostname for Meraki dashboard.
Can be used to access regional Meraki environments, such as China.
|
||
| internal_error_retry_time
integer
|
Default:
60
|
Number of seconds to retry if server returns an internal server error.
|
||
| net_id
string
|
ID of network which VLAN is in or should be in.
|
|||
| net_name
string
|
Name of network which VLAN is in or should be in.
aliases: network |
|||
| org_id
string
|
ID of organization associated to a network.
|
|||
| org_name
string
|
Name of organization associated to a network.
aliases: organization |
|||
| output_format
string
|
|
Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId).
|
||
| output_level
string
|
|
Set amount of debug output during module execution.
|
||
| rate_limit_retry_time
integer
|
Default:
165
|
Number of seconds to retry if rate limiter is triggered.
|
||
| state
string
|
|
Specifies whether object should be queried, created/modified, or removed.
|
||
| timeout
integer
|
Default:
30
|
Time to timeout for HTTP requests.
|
||
| use_https
boolean
|
|
If
no, it will use HTTP. Otherwise it will use HTTPS.
Only useful for internal Meraki developers.
|
||
| use_proxy
boolean
|
|
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
|
||
| validate_certs
boolean
|
|
Whether to validate HTTP certificates.
|
||
| wan1
dictionary
|
Configuration of WAN1 uplink
|
|||
| bandwidth_limits
dictionary
|
Structure for configuring bandwidth limits
|
|||
| limit_down
integer
|
Maximum download speed for interface
|
|||
| limit_up
integer
|
Maximum upload speed for interface
|
|||
| wan2
dictionary
|
Configuration of WAN2 uplink
|
|||
| bandwidth_limits
dictionary
|
Structure for configuring bandwidth limits
|
|||
| limit_down
integer
|
Maximum download speed for interface
|
|||
| limit_up
integer
|
Maximum upload speed for interface
|
|||
Notes
Note
- Some of the options are likely only used for developers within Meraki.
- Module was formerly named M(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_FORMATenvironment 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 | Returned | Description | |||
|---|---|---|---|---|---|
| data
complex
|
success |
Information about the organization which was created or modified
|
|||
| cellular
complex
|
success |
cellular interface
|
|||
| bandwidth_limits
complex
|
success |
Structure for uplink bandwidth limits
|
|||
| limit_down
integer
|
success |
Download bandwidth limit
|
|||
| limit_up
integer
|
success |
Upload bandwidth limit
|
|||
| wan1
complex
|
success |
WAN1 interface
|
|||
| bandwidth_limits
complex
|
success |
Structure for uplink bandwidth limits
|
|||
| limit_down
integer
|
success |
Download bandwidth limit
|
|||
| limit_up
integer
|
success |
Upload bandwidth limit
|
|||
| wan2
complex
|
success |
WAN2 interface
|
|||
| bandwidth_limits
complex
|
success |
Structure for uplink bandwidth limits
|
|||
| limit_down
integer
|
success |
Download bandwidth limit
|
|||
| limit_up
integer
|
success |
Upload bandwidth limit
|
|||
Authors
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mx_uplink_bandwidth_module.html