cisco.meraki.meraki_ms_storm_control 模块 – 在 Meraki 云中管理交换机的风暴控制配置

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定：cisco.meraki.meraki_ms_storm_control。

cisco.meraki 0.0.1 中的新增功能

已弃用

在以下版本中移除：

版本 3.0.0

原因：

发布了具有增强功能的更新模块

替代方案：

cisco.meraki.networks_switch_storm_control

概要

• 允许管理 Meraki MS 交换机的风暴控制设置。

参数

参数	注释
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
broadcast_threshold 整数	广播流量类型的总可用端口带宽的百分比 (1 到 99)。 默认值为 100%，用于清除配置。
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
multicast_threshold 整数	多播流量类型的总可用端口带宽的百分比 (1 到 99)。 默认值为 100%，用于清除配置。
net_id 字符串	网络 ID。
net_name 字符串	网络名称。
org_id 字符串	组织 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键应该是蛇形命名法 (例如 net_id) 还是驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	指定是否应查询或修改风暴控制配置。 选项 "query" ← (默认) "present"
timeout 整数	HTTP 请求的超时时间。 默认值： 30
unknown_unicast_threshold 整数	未知单播流量类型的总可用端口带宽的百分比 (1 到 99)。 默认值为 100%，用于清除配置。
use_https 布尔值	如果为 no，则使用 HTTP。否则将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，则即使目标主机上的环境变量中定义了代理，也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)

注释

注意

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

• 检查模式会从仪表板下载当前配置，然后将更改与该下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- 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

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
数据 复杂数据	查询或更新的风暴控制配置信息。 返回： 成功
broadcast_threshold 整数	广播流量类型的总可用端口带宽的百分比 (1 到 99)。 默认值为 100%，用于清除配置。 返回： 成功 示例： 42
multicast_threshold 整数	多播流量类型的总可用端口带宽的百分比 (1 到 99)。 默认值为 100%，用于清除配置。 返回： 成功 示例： 42
unknown_unicast_threshold 整数	未知单播流量类型的总可用端口带宽的百分比 (1 到 99)。 默认值为 100%，用于清除配置。 返回： 成功 示例： 42

状态

• 此模块将在3.0.0版本中移除。[已弃用]

• 更多信息请参见 已弃用。

作者

• Kevin Breit (@kbreit)

收藏链接

• 问题跟踪器
• 代码库 (源代码)