cisco.dnac.event_subscription_rest_v1_info 模块 – Event Subscription 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_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有 Event Subscription Rest V1。

  • 根据提供的查询参数获取 Rest/Webhook 订阅列表。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

category

字符串

类别查询参数。与相应类别相关的订阅列表。

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"

domain

字符串

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

eventIds

字符串

EventIds 查询参数。与相应 eventIds 相关的订阅列表(逗号分隔的事件 ID)。

headers

字典

其他标头。

limit

浮点数

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

name

字符串

名称查询参数。与相应名称相关的订阅列表。

offset

浮点数

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

order

字符串

排序查询参数。

sortBy

字符串

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

subDomain

字符串

子域查询参数。与相应子域相关的订阅列表。

type

字符串

类型查询参数。与相应类型相关的订阅列表。

validate_response_schema

布尔值

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

选项

  • false

  • true ←(默认)

备注

注意

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

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

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关 Event Management GetRestWebhookEventSubscriptionsV1 的 Cisco DNA Center 文档

GetRestWebhookEventSubscriptionsV1 API 的完整参考。

示例

- name: Get all Event Subscription Rest V1
  cisco.dnac.event_subscription_rest_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
    domain: string
    subDomain: string
    category: string
    type: string
    name: string
  register: result

返回值

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

描述

dnac_response

列表 / 元素=字典

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

返回:总是

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

作者

  • Rafael Campos (@racampos)