cisco.dnac.event_subscription_email_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_email_v1_info。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有事件订阅邮件 V1。
根据提供的查询参数获取电子邮件订阅的列表。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
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 版本。 默认： |
|
域查询参数。与各自域相关的电子邮件订阅列表。 |
|
EventIds 查询参数。与各自 eventIds 相关的电子邮件订阅列表（逗号分隔的事件 ID）。 |
|
其他标头。 |
|
Limit 查询参数。要在结果集中限制的订阅数，其默认值为 10。 |
|
名称查询参数。与各自名称相关的电子邮件订阅列表。 |
|
Offset 查询参数。要在结果集中偏移的订阅数，其默认值为 0。 |
|
Order 查询参数。 |
|
SortBy 查询参数。SortBy 字段名称。 |
|
SubDomain 查询参数。与各自子域相关的电子邮件订阅列表。 |
|
Type 查询参数。与各自类型相关的电子邮件订阅列表。 |
|
用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求体的标志。 选项
|
注释
注意
使用的 SDK 方法是 event_management.EventManagement.get_email_event_subscriptions_v1，
使用的路径是 get /dna/intent/api/v1/event/subscription/email，
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关事件管理 GetEmailEventSubscriptionsV1 的 Cisco DNA Center 文档
GetEmailEventSubscriptionsV1 API 的完整参考。
示例
- name: Get all Event Subscription Email V1
cisco.dnac.event_subscription_email_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
返回值
常见返回值在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回： 始终 示例： |