cisco.dnac.event_subscription_details_rest_v1_info 模块 – 事件订阅详情 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_details_rest_v1_info
。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有事件订阅详情 Rest V1。
获取指定 connectorType 的订阅详情列表。
注意
此模块具有相应的 action 插件。
需求
在执行此模块的主机上需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
---|---|
用于 Cisco DNA Center SDK 的标志,用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值: |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值: |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值: |
|
附加的头部。 |
|
InstanceId 查询参数。特定配置的实例 ID。 |
|
Limit 查询参数。结果集中要限制的 Rest/Webhook 订阅详情的数量,默认值为 10。 |
|
Name 查询参数。特定配置的名称。 |
|
Offset 查询参数。结果集中要偏移的 Rest/Webhook 订阅详情的数量,默认值为 0。 |
|
Order 查询参数。 |
|
SortBy 查询参数。SortBy 字段名。 |
|
用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 架构验证请求体。 选项
|
注释
注意
使用的 SDK 方法为 event_management.EventManagement.get_rest_webhook_subscription_details_v1,
使用的路径为 get /dna/intent/api/v1/event/subscription-details/rest,
支持
check_mode
插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参见
另请参见
- Cisco DNA Center 事件管理 GetRestWebhookSubscriptionDetailsV1 文档
GetRestWebhookSubscriptionDetailsV1 API 的完整参考。
示例
- name: Get all Event Subscription Details Rest V1
cisco.dnac.event_subscription_details_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}}"
name: string
instanceId: string
offset: 0
limit: 0
sortBy: string
order: string
register: result
返回值
常见的返回值已记录在 此处,以下是此模块独有的字段
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回:始终 示例: |