cisco.dnac.event_webhook 模块 – 事件 Webhook 资源模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

摘要

  • 此模块表示模块 event_webhook_v1 的别名

注意

此模块具有相应的 action 插件。

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

description

字符串

描述。

dnac_debug

布尔值

用于 Cisco DNA Center SDK 的标志，用于启用调试。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认： 443

dnac_username

别名：user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认： "admin"

dnac_verify

布尔值

用于启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

dnac_version

字符串

告知 SDK 使用哪个版本的 Cisco DNA Center。

默认： "2.3.7.6"

headers

列表 / 元素=字典

事件 Webhook 的标头。

defaultValue

字符串

默认值。

encrypt

布尔值

加密。

选项

  • false

  • true

name

字符串

名称。

value

字符串

值。

isProxyRoute

布尔值

是否为代理路由。

选项

  • false

  • true

method

字符串

方法。

name

字符串

名称。

trustCert

布尔值

信任证书。

选项

  • false

  • true

url

字符串

URL。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

webhookId

字符串

仅更新 webhook 配置时才需要。

备注

注意

  • 使用的 SDK 方法为 event_management.EventManagement.create_webhook_destination_v1、event_management.EventManagement.update_webhook_destination_v1，

  • 使用的路径为 post /dna/intent/api/v1/event/webhook、put /dna/intent/api/v1/event/webhook，

  • 需要注意的是，此模块是 event_webhook_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 事件管理 CreateWebhookDestinationV1 文档

CreateWebhookDestinationV1 API 的完整参考。

Cisco DNA Center 事件管理 UpdateWebhookDestinationV1 文档

UpdateWebhookDestinationV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.event_webhook:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    description: string
    headers:
    - defaultValue: string
      encrypt: true
      name: string
      value: string
    isProxyRoute: true
    method: string
    name: string
    trustCert: true
    url: string
    webhookId: string

- name: Update all
  cisco.dnac.event_webhook:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    description: string
    headers:
    - defaultValue: string
      encrypt: true
      name: string
      value: string
    isProxyRoute: true
    method: string
    name: string
    trustCert: true
    url: string
    webhookId: string

返回值

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

键

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回：始终

示例： {"apiStatus": "string", "errorMessage": {"errors": ["string"]}, "statusMessage": "string"}

作者

  • Rafael Campos (@racampos)