cisco.meraki.meraki_webhook 模块 – 管理 Meraki 云中配置的 Webhook

注意

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

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

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

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

已弃用

在以下版本中移除：

3.0.0 版本

原因：

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

替代方案：

cisco.meraki.networks_webhooks_http_servers

概要

• 配置和查询 Meraki 云中 Webhook 的信息。

参数

参数	注释
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
name 字符串	Webhook 的名称。
net_id 字符串	应用配置的网络 ID。
net_name 别名：network 字符串	应用配置的网络名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。
output_format 字符串	指示模块响应键是否应为蛇形命名法 (例如 net_id) 或驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
payload_template_id 字符串	有效负载模板的 ID。如果也传递了 payload_template_name，则会覆盖它。
payload_template_name 字符串	有效负载模板的名称
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
shared_secret 字符串	访问 Webhook 时使用的密钥密码。
state 字符串	指定应查询、创建/修改或删除对象。 选项 "absent" "present" "query" ← (默认)
test 字符串	指示是测试还是查询状态。 选项 "test"
test_id 字符串	Webhook 测试查询的 ID。
timeout 整数	HTTP 请求的超时时间。 默认值： 30
url 字符串	调用 Webhook 时访问的 URL。
use_https 布尔值	如果为 no，它将使用 HTTP。否则，它将使用 HTTPS。 仅对 Meraki 内部开发者有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，即使目标主机上的环境变量中定义了代理，它也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)
webhook_id 字符串	Webhook 的唯一 ID。

备注

注意

• 一些选项可能仅供 Meraki 内部开发者使用。

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

• 一些选项可能仅供 Meraki 内部开发者使用。

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

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

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

示例

- name: Create webhook
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
    url: https://webhook.url/
    shared_secret: shhhdonttellanyone
    payload_template_name: 'Slack (included)'
  delegate_to: localhost

- name: Query one webhook
  meraki_webhook:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
  delegate_to: localhost

- name: Query all webhooks
  meraki_webhook:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

- name: Delete webhook
  meraki_webhook:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
  delegate_to: localhost

- name: Test webhook
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    test: test
    url: https://webhook.url/abc123
  delegate_to: localhost

- name: Get webhook status
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    test: status
    test_id: abc123531234
  delegate_to: localhost

返回值

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

键	描述
数据 复杂的	管理员列表。 返回：成功
ID 字符串	Webhook 的唯一 ID。 返回：成功 示例："aHR0cHM6Ly93ZWJob22LnvpdGUvOGViNWI3NmYtYjE2Ny00Y2I4LTlmYzQtND32Mj3F5NzIaMjQ0"
name 字符串	Webhook 的描述性名称。 返回：成功 示例："Test_Hook"
networkId 字符串	包含 Webhook 对象的网络 ID。 返回：成功 示例："N_12345"
payloadTemplate 字符串	将数据发布到 HTTP 服务器时使用的有效负载模板。 返回：成功 示例："{'name': 'Meraki (included)', 'payloadTemplateId': 'wpt_00001'}"
shared_secret 字符串	Webhook 密码。 返回：成功 示例："VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
状态 字符串	Webhook 测试的状态。 返回：测试 Webhook 时成功 示例："enqueued"
url 字符串	Webhook 端点的 URL。 返回：成功 示例："https://webhook.url/abc123"

状态

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

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

作者

• Kevin Breit (@kbreit)

资源链接

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