W3cubDocs

/Ansible

cisco.meraki.meraki_ms_storm_control – Manage storm control configuration on a switch in the Meraki cloud

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_ms_storm_control.

New in version 0.0.1: of cisco.meraki

Synopsis

  • Allows for management of storm control settings for Meraki MS switches.

Parameters

Parameter Choices/Defaults Comments
auth_key
string / required
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
broadcast_threshold
integer
Percentage (1 to 99) of total available port bandwidth for broadcast traffic type.
Default value 100 percent rate is to clear the configuration.
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.
multicast_threshold
integer
Percentage (1 to 99) of total available port bandwidth for multicast traffic type.
Default value 100 percent rate is to clear the configuration.
net_id
string
ID of network.
net_name
string
Name of network.
org_id
string
ID of organization.
org_name
string
Name of organization.

aliases: organization
output_format
string
    Choices:
  • snakecase ←
  • camelcase
Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId).
output_level
string
    Choices:
  • debug
  • normal ←
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
    Choices:
  • query ←
  • present
Specifies whether storm control configuration should be queried or modified.
timeout
integer
Default:
30
Time to timeout for HTTP requests.
unknown_unicast_threshold
integer
Percentage (1 to 99) of total available port bandwidth for unknown unicast traffic type.
Default value 100 percent rate is to clear the configuration.
use_https
boolean
    Choices:
  • no
  • yes ←
If no, it will use HTTP. Otherwise it will use HTTPS.
Only useful for internal Meraki developers.
use_proxy
boolean
    Choices:
  • no ←
  • yes
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether to validate HTTP certificates.

Notes

Note

  • 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 to camelcase.
  • 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 broadcast settings
  meraki_switch_storm_control:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    broadcast_threshold: 75
    multicast_threshold: 70
    unknown_unicast_threshold: 65
  delegate_to: localhost

- name: Query storm control settings
  meraki_switch_storm_control:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  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 queried or updated storm control configuration.
broadcast_threshold
integer
success
Percentage (1 to 99) of total available port bandwidth for broadcast traffic type.
Default value 100 percent rate is to clear the configuration.

Sample:
42
multicast_threshold
integer
success
Percentage (1 to 99) of total available port bandwidth for multicast traffic type.
Default value 100 percent rate is to clear the configuration.

Sample:
42
unknown_unicast_threshold
integer
success
Percentage (1 to 99) of total available port bandwidth for unknown unicast traffic type.
Default value 100 percent rate is to clear the configuration.

Sample:
42


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_ms_storm_control_module.html