cisco.dnac.event_api_status_v1_info 模块 – Event Api Status V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。
要在 playbook 中使用它，请指定：cisco.dnac.event_api_status_v1_info。
cisco.dnac 3.1.0 新增功能
概要
通过 ID 获取 Event Api Status V1。
获取以提供的 executionId 作为强制路径参数的事件 API 调用的状态。
注意
此模块有一个相应的操作插件。
要求
执行此模块的主机需要以下要求。
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 版本。 默认值： |
|
ExecutionId 路径参数。执行 ID。 |
|
其他标头。 |
|
用于启用针对 JSON 模式验证请求正文的 Cisco DNA Center SDK 标志。 选择
|
注释
注意
使用的 SDK 方法是 event_management.EventManagement.get_status_api_for_events_v1，
使用的路径是 get /dna/intent/api/v1/event/api-status/{executionId}，
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关事件管理 GetStatusAPIForEventsV1 的 Cisco DNA Center 文档
GetStatusAPIForEventsV1 API 的完整参考。
示例
- name: Get Event Api Status V1 by id
cisco.dnac.event_api_status_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}}"
executionId: string
register: result
返回值
常见的返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回： 始终 示例： |