cisco.meraki.networks_alerts_settings 模块 – 网络_警报_设置的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在剧本中使用它，请指定：cisco.meraki.networks_alerts_settings。

cisco.meraki 2.16.0 中的新增功能

概要

• 管理资源网络_警报_设置的操作更新。

• 更新此网络的警报配置。

注意

此模块具有相应的 操作插件。

要求

执行此模块的主机需要以下要求。

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
alerts 列表 / 元素=字典	每种类型的特定于警报的配置。只能更新与网络相关的警报。
alertDestinations 字典	此特定警报的目标哈希。
allAdmins 布尔值	如果为真，则所有网络管理员都会收到此警报的电子邮件。 选项 false true
emails 列表 / 元素=字符串	将接收有关警报信息的电子邮件列表。
httpServerIds 列表 / 元素=字符串	要为此警报发送 Webhook 的 HTTP 服务器 ID 列表。
snmp 布尔值	如果为真，则如果为此网络配置了 SNMP 陷阱服务器，则会为此警报发送 SNMP 陷阱。 选项 false true
enabled 布尔值	表示警报是否开启的布尔值。 选项 false true
filters 字典	警报的特定配置数据哈希。只会更新特定于警报的过滤器。
type 字符串	警报的类型。
defaultDestinations 字典	网络上所有警报的网络范围目标。
allAdmins 布尔值	如果为真，则所有网络管理员都会收到电子邮件。 选项 false true
emails 列表 / 元素=字符串	将接收警报的电子邮件列表。
httpServerIds 列表 / 元素=字符串	要发送 Webhook 的 HTTP 服务器 ID 列表。
snmp 布尔值	如果为真，则如果为此网络配置了 SNMP 陷阱服务器，则会发送 SNMP 陷阱。 选项 false true
meraki_action_batch_retry_wait_time 整数	meraki_action_batch_retry_wait_time（整数），操作批次并发错误重试等待时间 默认值： 60
meraki_api_key 字符串 / 必需	meraki_api_key（字符串），在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY
meraki_base_url 字符串	meraki_base_url（字符串），位于所有端点资源之前 默认值： "https://api.meraki.com/api/v1"
meraki_be_geo_id 字符串	meraki_be_geo_id（字符串），用于 API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： ""
meraki_caller 字符串	meraki_caller（字符串），用于 API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： ""
meraki_certificate_path 字符串	meraki_certificate_path（字符串），如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值： ""
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config（布尔值），继承您自己的日志记录器实例 选项 false ← (默认) true
meraki_log_file_prefix 字符串	meraki_log_file_prefix（字符串），日志文件名后附加日期和时间戳 默认值： "meraki_api_"
meraki_log_path 字符串	log_path（字符串），输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值： ""
meraki_maximum_retries 整数	meraki_maximum_retries（整数），遇到 429 或其他服务器端错误时最多重试这么多次 默认值： 2
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time（整数），Nginx 429 重试等待时间 默认值： 60
meraki_output_log 布尔值	meraki_output_log（布尔值），创建输出日志文件？ 选项 false true ← (默认)
meraki_print_console 布尔值	meraki_print_console（布尔值），将日志输出打印到控制台？ 选项 false true ← (默认)
meraki_requests_proxy 字符串	meraki_requests_proxy（字符串），如果需要，用于 HTTPS 的代理服务器和端口 默认值： ""
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error（布尔值），如果遇到其他 4XX 错误（除了 429）则重试？ 选项 false ← (默认) true
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time（整数），其他 4XX 错误重试等待时间 默认值： 60
meraki_simulate 布尔值	meraki_simulate（布尔值），模拟 POST/PUT/DELETE 调用以防止更改？ 选项 false ← (默认) true
meraki_single_request_timeout 整数	meraki_single_request_timeout（整数），每个 API 调用的最大秒数 默认值： 60
meraki_suppress_logging 布尔值	meraki_suppress_logging（布尔值），禁用所有日志记录？那你就自求多福吧！ 选项 false ← (默认) true
meraki_use_iterator_for_get_pages 布尔值	meraki_use_iterator_for_get_pages（布尔值），list* 方法将返回包含每个对象的迭代器，而不是包含所有项目的完整列表 选项 false ← (默认) true
meraki_wait_on_rate_limit 布尔值	meraki_wait_on_rate_limit（布尔值），如果遇到 429 速率限制错误则重试？ 选项 false true ← (默认)
muting 字典	在特定条件下静音警报。
byPortSchedules 字典	基于交换机端口计划静音无线不可达警报。
enabled 布尔值	如果为真，则由端口计划导致的无线不可达警报将被静音。 选项 false true
networkId 字符串	NetworkId 路径参数。网络 ID。

注释

注意

• 使用的 SDK 方法为 networks.Networks.update_network_alerts_settings，

• 使用的路径为 put /networks/{networkId}/alerts/settings，

• 不支持 check_mode

• 插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器。

• 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参见

另请参见

Cisco Meraki 文档，了解 networks updateNetworkAlertsSettings

updateNetworkAlertsSettings API 的完整参考。

示例

- name: Update all
  cisco.meraki.networks_alerts_settings:
    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
    alerts:
    - alertDestinations:
        allAdmins: false
        emails:
        - [email protected]
        httpServerIds:
        - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
        snmp: false
      enabled: true
      filters:
        timeout: 60
      type: gatewayDown
    defaultDestinations:
      allAdmins: true
      emails:
      - [email protected]
      httpServerIds:
      - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
      snmp: true
    networkId: string

返回值

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

键	描述
meraki_response 字典	包含 Cisco Meraki Python SDK 返回的响应的字典或列表。 返回：始终 示例： {}

作者

• Francisco Munoz (@fmunoz)

收藏链接

• 问题追踪器
• 代码库（源代码）