cisco.dnac.event_subscription_rest_v1 模块 – 用于事件订阅 Rest V1 的资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.dnac.event_subscription_rest_v1。

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源事件订阅 Rest V1 的创建和更新操作。
为已注册事件列表创建 Rest/Webhook 订阅端点。
为已注册事件列表更新 Rest/Webhook 订阅端点。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
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"`
payload 列表 / 元素=字典	事件订阅 Rest 的 payload。
description 字符串	描述。
filter 字典	事件订阅 Rest 的过滤器。
categories 列表 / 元素=字符串	类别。
domainsSubdomains 列表 / 元素=字典	事件订阅 Rest 的 domainsSubdomains。
domain 字符串	域。
subDomains 列表 / 元素=字符串	子域。
eventIds 列表 / 元素=字符串	事件 ID（逗号分隔的事件 ID）。
severities 列表 / 元素=字符串	严重性。
siteIds 列表 / 元素=字符串	站点 ID。
sources 列表 / 元素=字符串	来源。
types 列表 / 元素=字符串	类型。
name 字符串	名称。
subscriptionEndpoints 列表 / 元素=字典	事件订阅 Rest 的 subscriptionEndpoints。
instanceId 字符串	（从获取 Rest/Webhook 订阅详细信息 –> 选择 instanceId）。
subscriptionDetails 字典	事件订阅 Rest 的 subscriptionDetails。
connectorType 字符串	连接器类型（必须为 REST）。
subscriptionId 字符串	订阅 ID（唯一的 UUID）。
version 字符串	版本。
validate_response_schema 布尔值	Cisco DNA Center SDK 用于启用针对 JSON 模式验证请求主体的标志。选项 `false` `true` ←（默认）

备注 

注意

使用的 SDK 方法是 event_management.EventManagement.create_rest_webhook_event_subscription_v1, event_management.EventManagement.update_rest_webhook_event_subscription_v1,
使用的路径是 post /dna/intent/api/v1/event/subscription/rest, put /dna/intent/api/v1/event/subscription/rest,
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 文档，了解事件管理 CreateRestWebhookEventSubscriptionV1: CreateRestWebhookEventSubscriptionV1 API 的完整参考。
Cisco DNA Center 文档，了解事件管理 UpdateRestWebhookEventSubscriptionV1: UpdateRestWebhookEventSubscriptionV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.event_subscription_rest_v1:
    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
    payload:
    - description: string
      filter:
        categories:
        - string
        domainsSubdomains:
        - domain: string
          subDomains:
          - string
        eventIds:
        - string
        severities:
        - string
        siteIds:
        - string
        sources:
        - string
        types:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
      subscriptionId: string
      version: string

- name: Update all
  cisco.dnac.event_subscription_rest_v1:
    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
    payload:
    - description: string
      filter:
        categories:
        - string
        domainsSubdomains:
        - domain: string
          subDomains:
          - string
        eventIds:
        - string
        severities:
        - string
        siteIds:
        - string
        sources:
        - string
        types:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
      subscriptionId: string
      version: string

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表返回：始终示例： `{"statusUri": "string"}`

作者

Rafael Campos (@racampos)