cisco.dnac.event_subscription_v1_info 模块 – 事件订阅 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_info

cisco.dnac 3.1.0 中的新功能

概要

  • 获取所有事件订阅 V1。

  • 根据提供的偏移量和限制获取订阅列表。已弃用。

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

boolean

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

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

string

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

dnac_port

integer

Cisco DNA Center 端口。

默认: 443

dnac_username

别名:user

string

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

默认: "admin"

dnac_verify

boolean

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

选项

  • false

  • true ← (默认)

dnac_version

string

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

默认: "2.3.7.6"

eventIds

string

EventIds 查询参数。与相应 eventIds 相关的订阅列表。

headers

dictionary

其他标头。

limit

float

Limit 查询参数。结果集中要限制的订阅数量,默认值为 10。

offset

float

Offset 查询参数。结果集中要偏移的订阅数量,默认值为 0。

order

string

Order 查询参数。

sortBy

string

SortBy 查询参数。SortBy 字段名称。

validate_response_schema

boolean

用于 Cisco DNA Center SDK 启用针对 JSON 模式验证请求体的标志。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 event_management.EventManagement.get_event_subscriptions_v1,

  • 使用的路径是 get /dna/intent/api/v1/event/subscription,

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解事件管理 GetEventSubscriptionsV1

GetEventSubscriptionsV1 API 的完整参考。

示例

- name: Get all Event Subscription V1
  cisco.dnac.event_subscription_v1_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    eventIds: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

返回值

通用返回值记录在 此处,以下是此模块特有的字段

描述

dnac_response

列表 / elements=dictionary

一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应

返回: 始终

示例: "[\n  {\n    \"version\": \"string\",\n    \"subscriptionId\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"subscriptionEndpoints\": [\n      {\n        \"instanceId\": \"string\",\n        \"subscriptionDetails\": {\n          \"connectorType\": \"string\",\n          \"instanceId\": \"string\",\n          \"name\": \"string\",\n          \"description\": \"string\",\n          \"url\": \"string\",\n          \"basePath\": \"string\",\n          \"resource\": \"string\",\n          \"method\": \"string\",\n          \"trustCert\": true,\n          \"headers\": [\n            {\n              \"string\": \"string\"\n            }\n          ],\n          \"queryParams\": [\n            {\n              \"string\": \"string\"\n            }\n          ],\n          \"pathParams\": [\n            {\n              \"string\": \"string\"\n            }\n          ],\n          \"body\": \"string\",\n          \"connectTimeout\": 0,\n          \"readTimeout\": 0\n        },\n        \"connectorType\": \"string\"\n      }\n    ],\n    \"filter\": {\n      \"eventIds\": [\n        \"string\"\n      ],\n      \"others\": [\n        \"string\"\n      ],\n      \"domainsSubdomains\": [\n        {\n          \"domain\": \"string\",\n          \"subDomains\": [\n            \"string\"\n          ]\n        }\n      ],\n      \"types\": [\n        \"string\"\n      ],\n      \"categories\": [\n        \"string\"\n      ],\n      \"severities\": [\n        \"string\"\n      ],\n      \"sources\": [\n        \"string\"\n      ],\n      \"siteIds\": [\n        \"string\"\n      ]\n    },\n    \"isPrivate\": true,\n    \"tenantId\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)