cisco.meraki.meraki_webhook_payload_template 模块 – 管理 Meraki 云中网络的 Webhook 负载模板

注意

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

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

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

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

已弃用

在以下版本中移除：

版本 3.0.0

原因：

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

替代方案：

cisco.meraki.networks_webhooks_payload_templates

概要

• 允许查询、删除、创建和更新 Webhook 负载模板。

参数

参数	注释
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
body 字符串	Webhook 消息正文使用的 Liquid 模板。
headers 列表 / 元素=字典	与 Webhook 标头一起使用的 Liquid 模板列表。 默认值： []
name 字符串	标头模板的名称。
template 字符串	标头的 Liquid 模板
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
name 字符串	模板的名称。
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 字符串	指定是否应查询、创建、修改或删除负载模板。 选项 "absent" "query" ← (默认) "present"
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模块将键输出为蛇形命名法（snake case）。要使用驼峰命名法（camel case），请将ANSIBLE_MERAKI_FORMAT环境变量设置为camelcase。

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

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

示例

- name: Query all configuration templates
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Query specific configuration templates
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
    name: Twitter
  delegate_to: localhost

- name: Create payload template
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
    name: TestTemplate
    body: Testbody
    headers:
        - name: testheader
          template: testheadertemplate
  delegate_to: localhost

- name: Delete a configuration template
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    name: TestTemplate
  delegate_to: localhost

返回值

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

键	描述
数据 复杂数据	查询对象的有关信息。 返回值：成功
body 字符串	Webhook 消息正文使用的 Liquid 模板。 返回值：成功 示例： "{'client_payload': {'text': '{{alertData}}'}, 'event_type': '{{alertTypeId}}'}"
headers 列表 / 元素=字符串	与 Webhook 标头一起使用的 Liquid 模板列表。 返回值：成功
name 字符串	模板名称 返回值：成功 示例： "testTemplate"
template 字符串	页眉的Liquid模板 返回值：成功 示例： "Bearer {{sharedSecret}}"
name 字符串	模板名称 返回值：成功 示例： "testTemplate"

状态

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

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

作者

• Joshua Coronado (@joshuajcoronado)

资源链接

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