cisco.dnac.event_subscription_v1 模块 – 事件订阅 V1 资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要 

管理资源事件订阅 V1 的创建、更新和删除操作。
将 SubscriptionEndpoint 订阅到已注册事件列表（已弃用）。
删除 EventSubscriptions。
将 SubscriptionEndpoint 更新到已注册事件列表（已弃用）。

注意

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

要求 

以下是执行此模块的主机所需的条件。

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 列表 / 元素=字典	事件订阅的有效负载。
description 字符串	描述。
filter 字典	事件订阅的过滤器。
categories 列表 / 元素=字符串	类别。
domainsSubdomains 列表 / 元素=字典	事件订阅的 domainsSubdomains。
domain 字符串	域名。
subDomains 列表 / 元素=字符串	子域名。
eventIds 列表 / 元素=字符串	事件 ID（以逗号分隔的事件 ID）。
severities 列表 / 元素=字符串	严重性。
siteIds 列表 / 元素=字符串	站点 ID。
sources 列表 / 元素=字符串	来源。
types 列表 / 元素=字符串	类型。
name 字符串	名称。
subscriptionEndpoints 列表 / 元素=字典	事件订阅的 subscriptionEndpoints。
instanceId 字符串	（来自获取 REST/Webhook 订阅详细信息 -> 选择 instanceId）。
subscriptionDetails 字典	事件订阅的 subscriptionDetails。
connectorType 字符串	连接器类型（必须为 REST）。
subscriptionId 字符串	订阅 ID（唯一的 UUID）。
version 字符串	版本。
subscriptions 字符串	Subscriptions 查询参数。要删除的 EventSubscriptionId 列表。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

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

另请参阅 

另请参阅

Cisco DNA Center 事件管理 CreateEventSubscriptionsV1 文档: CreateEventSubscriptionsV1 API 的完整参考。
Cisco DNA Center 事件管理 DeleteEventSubscriptionsV1 文档: DeleteEventSubscriptionsV1 API 的完整参考。
Cisco DNA Center 事件管理 UpdateEventSubscriptionsV1 文档: UpdateEventSubscriptionsV1 API 的完整参考。

示例 

- name: Delete all
  cisco.dnac.event_subscription_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: absent
    subscriptions: string

- name: Update all
  cisco.dnac.event_subscription_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: Create
  cisco.dnac.event_subscription_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)