cisco.meraki.meraki_alert 模块 – 管理 Meraki 云中的警报

注意

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

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

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

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

cisco.meraki 2.1.0 中的新增功能

已弃用

在以下版本中移除：

版本 3.0.0

原因：

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

替代方案：

cisco.meraki.networks_alerts_settings

摘要

• 允许在 Meraki 中创建、管理和查看警报设置。

参数

参数	注释
alerts 列表 / 元素=字典	每种类型的警报特定配置。
alert_destinations 字典	此特定警报的目标哈希。
all_admins 布尔值	如果为真，则所有网络管理员都将收到电子邮件。 选项 false true
emails 列表 / 元素=字符串	将收到警报的电子邮件列表。
http_server_ids 列表 / 元素=字符串	要向其发送 Webhook 的 HTTP 服务器 ID 列表。
snmp 布尔值	如果为真，则如果为此网络配置了 SNMP 陷阱服务器，则将发送 SNMP 陷阱。 选项 false true
alert_type 字符串	警报类型。
enabled 布尔值	表示警报是否开启的布尔值。 选项 false true
filters 任意	警报的特定配置数据哈希。仅更新特定于警报的过滤器。 不会对 filters 进行验证检查。 默认值： {}
auth_key 字符串 / 必填	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
default_destinations 字典	未指定警报特定目标时的目标属性。
all_admins 布尔值	如果为真，则所有网络管理员都将收到电子邮件。 选项 false true
emails 列表 / 元素=字符串	将收到警报的电子邮件列表。
http_server_ids 列表 / 元素=字符串	要向其发送 Webhook 的 HTTP 服务器 ID 列表。
snmp 布尔值	如果为真，则如果为此网络配置了 SNMP 陷阱服务器，则将发送 SNMP 陷阱。 选项 false true
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	网络的 ID 号。
net_name 别名：name，network 字符串	网络名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键应该是蛇形命名法 (例如 net_id) 还是驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	创建或修改警报。 选项 "present" ← (默认) "query"
timeout 整数	HTTP 请求的超时时间。 默认值： 30
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: Update settings
  meraki_alert:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    default_destinations:
      emails:
      - 'youremail@yourcorp'
      - 'youremail2@yourcorp'
      all_admins: yes
      snmp: no
    alerts:
      - alert_type: "gatewayDown"
        enabled: yes
        filters:
          timeout: 60
        alert_destinations:
          emails:
          - 'youremail@yourcorp'
          - 'youremail2@yourcorp'
          all_admins: yes
          snmp: no
      - alert_type: "usageAlert"
        enabled: yes
        filters:
          period: 1200
          threshold: 104857600
        alert_destinations:
          emails:
          - 'youremail@yourcorp'
          - 'youremail2@yourcorp'
          all_admins: yes
          snmp: no

- name: Query all settings
  meraki_alert:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

返回值

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

键	描述
data 复杂	有关已创建或操作的对象的信息。 返回： info
alerts 复杂	每种类型的警报特定配置。 返回： success
alert_destinations 复杂	此特定警报的目标哈希。 返回： success
all_admins 布尔值	如果为真，则所有网络管理员都将收到电子邮件。 返回： success
emails 列表 / 元素=字符串	将收到警报的电子邮件列表。 返回： success
http_server_ids 列表 / 元素=字符串	要向其发送 Webhook 的 HTTP 服务器 ID 列表。 返回： success
snmp 布尔值	如果为真，则如果为此网络配置了 SNMP 陷阱服务器，则将发送 SNMP 陷阱。 返回： success
alert_type 字符串	警报类型。 返回： success
enabled 布尔值	表示警报是否开启的布尔值。 返回： success
filters 复杂	警报的特定配置数据哈希。仅更新特定于警报的过滤器。 不会对 filters 进行验证检查。 返回： success
default_destinations 复杂	未指定警报特定目标时的目标属性。 返回： success
all_admins 布尔值	如果为真，则所有网络管理员都将收到电子邮件。 返回： success 示例： true
emails 列表 / 元素=字符串	将收到警报的电子邮件列表。 返回： success
http_server_ids 列表 / 元素=字符串	要向其发送 Webhook 的 HTTP 服务器 ID 列表。 返回： success
snmp 布尔值	如果为真，则如果为此网络配置了 SNMP 陷阱服务器，则将发送 SNMP 陷阱。 返回： success 示例： true

状态

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

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

作者

• Kevin Breit (@kbreit)

资源链接

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