cisco.dnac.event_artifact_v1_info 模块 – Event Artifact V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。 它不包含在 ansible-core 中。 要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。 您需要更多要求才能使用此模块，请参阅要求 以了解详细信息。
要在剧本中使用它，请指定：cisco.dnac.event_artifact_v1_info。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有 Event Artifact 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 查询参数。 事件 ID 列表。 |
|
其他标头。 |
|
限制查询参数。 |
|
偏移量查询参数。 记录起始偏移量。 |
|
排序查询参数。 排序顺序 (asc/desc)。 |
|
搜索查询参数。 在名称、描述、eventId、类型、类别中查找匹配项。 |
|
SortBy 查询参数。 按字段排序。 |
|
标签查询参数。 已定义的标签。 |
|
用于 Cisco DNA Center SDK 启用针对 JSON 模式验证请求体的标志。 选项
|
注释
注意
使用的 SDK 方法是 event_management.EventManagement.get_eventartifacts,
使用的路径是 get /dna/system/api/v1/event/artifact,
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关 Event Management GetEventArtifactsV1 的 Cisco DNA Center 文档
GetEventArtifactsV1 API 的完整参考。
示例
- name: Get all Event Artifact V1
cisco.dnac.event_artifact_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
tags: string
offset: 0
limit: 0
sortBy: string
order: string
search: string
register: result
返回值
通用返回值在此处记录 here，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回：总是 示例: |