cisco.dnac.event_subscription_syslog_info 模块 – 事件订阅 Syslog 信息的信息模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您使用的是 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在 Playbook 中使用它,请指定:cisco.dnac.event_subscription_syslog_info
。
cisco.dnac 3.1.0 中的新增功能
概要
此模块表示模块 event_subscription_syslog_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机上需要以下要求。
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)。 |
|
其他标头。 |
|
限制查询参数。要在结果集中限制的订阅数量,默认值为 10。 |
|
名称查询参数。与相应名称相关的订阅列表。 |
|
偏移查询参数。要在结果集中偏移的订阅数量,默认值为 0。 |
|
顺序查询参数。 |
|
排序依据查询参数。排序依据字段名称。 |
|
子域查询参数。与相应子域相关的订阅列表。 |
|
类型查询参数。与相应类型相关的订阅列表。 |
|
Cisco DNA Center SDK 的标志,用于启用针对 JSON 模式验证请求正文。 选项
|
注释
注意
SDK 使用的方法是 event_management.EventManagement.get_syslog_event_subscriptions_v1,
使用的路径是 get /dna/intent/api/v1/event/subscription/syslog,
应该注意的是,此模块是 event_subscription_syslog_v1_info 的别名
支持
check_mode
该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中嵌入的连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 文档,了解 Event Management GetSyslogEventSubscriptionsV1
GetSyslogEventSubscriptionsV1 API 的完整参考。
示例
- name: Get all Event Subscription Syslog Info
cisco.dnac.event_subscription_syslog_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 返回的响应 已返回: 始终 示例: |