cisco.meraki.networks_switch_storm_control 模块 – 用于 networks _switch _stormcontrol 的资源模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您使用的是 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list。
要安装它,请使用:ansible-galaxy collection install cisco.meraki。您需要满足更多要求才能使用此模块,请参阅要求了解详细信息。
要在剧本中使用它,请指定:cisco.meraki.networks_switch_storm_control。
cisco.meraki 2.16.0 中的新增功能
概要
- 管理资源 networks _switch _stormcontrol 的更新操作。 
- 更新交换机网络的风暴控制配置。 
注意
此模块具有相应的 操作插件。
要求
以下要求需要在执行此模块的主机上满足。
- meraki >= 2.4.9 
- python >= 3.5 
参数
| 参数 | 注释 | 
|---|---|
| 广播流量类型的总可用端口带宽的百分比(1 到 99)。默认值 100% 表示清除配置。 | |
| meraki_action_batch_retry_wait_time (整数),操作批次并发错误重试等待时间 默认值:  | |
| meraki_api_key (字符串),仪表板中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY | |
| meraki_base_url (字符串),所有端点资源的前缀 默认值:  | |
| meraki_be_geo_id (字符串),用于 API 使用跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID 默认值:  | |
| meraki_caller (字符串),用于 API 使用跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值:  | |
| meraki_certificate_path (字符串),如果位于本地代理之后,则用于 TLS/SSL 证书验证的路径 默认值:  | |
| meraki_inherit_logging_config (布尔值),继承您自己的记录器实例 选项 
 | |
| meraki_log_file_prefix (字符串),附加了日期和时间戳的日志文件名 默认值:  | |
| log_path (字符串),输出日志的路径;如果未指定,则默认为脚本的工作目录 默认值:  | |
| meraki_maximum_retries (整数),遇到 429 或其他服务器端错误时,最多重试此次数 默认值:  | |
| meraki_nginx_429_retry_wait_time (整数),Nginx 429 重试等待时间 默认值:  | |
| meraki_output_log (布尔值),创建输出日志文件? 选项 
 | |
| meraki_print_console (布尔值),将日志输出打印到控制台? 选项 
 | |
| meraki_requests_proxy (字符串),如果需要,HTTPS 的代理服务器和端口 默认值:  | |
| meraki_retry_4xx_error (布尔值),如果遇到其他 4XX 错误(除了 429)是否重试? 选项 
 | |
| meraki_retry_4xx_error_wait_time (整数),其他 4XX 错误重试等待时间 默认值:  | |
| meraki_simulate (布尔值),模拟 POST/PUT/DELETE 调用以防止更改? 选项 
 | |
| meraki_single_request_timeout (整数),每次 API 调用的最大秒数 默认值:  | |
| meraki_suppress_logging (布尔值),禁用所有日志记录?那你自己看着办吧! 选项 
 | |
| meraki_use_iterator_for_get_pages (布尔值),list* 方法将返回一个迭代器,其中包含每个对象,而不是包含所有项的完整列表 选项 
 | |
| meraki_wait_on_rate_limit (布尔值),如果遇到 429 速率限制错误是否重试? 选项 
 | |
| 组播流量类型的总可用端口带宽的百分比(1 到 99)。默认值 100% 表示清除配置。 | |
| NetworkId 路径参数。网络 ID。 | |
| 未知单播(dlf-目标查找失败)流量类型的总可用端口带宽的百分比(1 到 99)。默认值 100% 表示清除配置。 | 
说明
注意
- 使用的 SDK 方法是 switch.Switch.update_network_switch_storm_control, 
- 使用的路径是 put /networks/{networkId}/switch/stormControl, 
- 不支持 - check_mode
- 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器 
- 以 dnac_ 开头的参数供 Cisco DNAC Python SDK 用于建立连接。 
另请参阅
另请参阅
- 有关交换机 updateNetworkSwitchStormControl 的 Cisco Meraki 文档
- updateNetworkSwitchStormControl API 的完整参考。 
示例
- name: Update all
  cisco.meraki.networks_switch_storm_control:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    broadcastThreshold: 30
    multicastThreshold: 30
    networkId: string
    unknownUnicastThreshold: 30
返回值
常见返回值记录在此处,以下是此模块独有的字段
| 键 | 描述 | 
|---|---|
| 包含 Cisco Meraki Python SDK 返回的响应的字典或列表 返回: 始终 示例:  | 
