cisco.dnac.event_series_audit_logs_summary_info 模块 – 事件系列审计日志摘要信息信息模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 需求 获取详细信息。

要在 playbook 中使用它，请指定：cisco.dnac.event_series_audit_logs_summary_info。

cisco.dnac 3.1.0 中的新增功能

概要

• 此模块表示模块 event_series_audit_logs_summary_v1_info 的别名

注意

此模块具有相应的 action 插件。

需求

在执行此模块的主机上需要以下需求。

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
category 字符串	类别查询参数。审计日志通知的事件类别。支持的值：INFO、WARN、ERROR、ALERT、TASK_PROGRESS、TASK_FAILURE、TASK_COMPLETE、COMMAND、QUERY、CONVERSATION。
context 字符串	上下文查询参数。审计日志通知的事件 correlationId。
description 字符串	描述查询参数。字符串全文/部分搜索 - （提供的输入字符串不区分大小写地与记录匹配）。
deviceId 字符串	DeviceId 查询参数。审计日志通知的 deviceId。
dnac_debug 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项 false ← (默认) true
dnac_host 字符串 / 必填	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。 默认值： 443
dnac_username 别名：user 字符串	用于身份验证的 Cisco DNA Center 用户名。 默认值： "admin"
dnac_verify 布尔值	启用或禁用 SSL 证书验证的标志。 选项 false true ← (默认)
dnac_version 字符串	告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： "2.3.7.6"
domain 字符串	域查询参数。审计日志通知的事件域。
endTime 浮点数	EndTime 查询参数。自纪元以来的毫秒数结束时间，例如 1597961437211（提供 startTime 时是必需的）。
eventHierarchy 字符串	EventHierarchy 查询参数。审计日志通知的事件 eventHierarchy。例如“US.CA.San Jose”或“US.CA”或“CA.San Jose” - 层次结构分隔符是“.”。
eventId 字符串	EventId 查询参数。审计日志通知的事件 ID。
headers 字典	附加标头。
instanceId 字符串	InstanceId 查询参数。审计日志的 InstanceID。
isParentOnly 布尔值	IsParentOnly 查询参数。用于过滤仅父级审计日志的参数。 选项 false true
isSystemEvents 布尔值	IsSystemEvents 查询参数。用于过滤系统生成的审计日志的参数。 选项 false true
name 字符串	名称查询参数。审计日志通知事件名称。
parentInstanceId 字符串	ParentInstanceId 查询参数。父级审计日志记录的 instanceID。
severity 字符串	严重性查询参数。审计日志通知的事件严重性。支持的值：1、2、3、4、5。
siteId 字符串	SiteId 查询参数。审计日志通知的 siteId。
source 字符串	源查询参数。审计日志通知的事件源。
startTime 浮点数	StartTime 查询参数。自纪元以来的毫秒数开始时间，例如 1597950637211（提供 endTime 时是必需的）。
subDomain 字符串	SubDomain 查询参数。审计日志通知的事件子域。
userId 字符串	UserId 查询参数。审计日志通知的事件 userId。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构验证请求正文。 选项 false true ← (默认)

注释

注意

• 使用的 SDK 方法是 event_management.EventManagement.get_auditlog_summary，

• 使用的路径是 get /dna/data/api/v1/event/event-series/audit-log/summary，

• 需要注意的是，此模块是 event_series_audit_logs_summary_v1_info 的别名

• 支持 check_mode

• 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器

• 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 事件管理 GetAuditLogSummaryV1 文档

GetAuditLogSummaryV1 API 的完整参考。

示例

- name: Get all Event Series Audit Logs Summary Info
  cisco.dnac.event_series_audit_logs_summary_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}}"
    parentInstanceId: string
    isParentOnly: True
    instanceId: string
    name: string
    eventId: string
    category: string
    severity: string
    domain: string
    subDomain: string
    source: string
    userId: string
    context: string
    eventHierarchy: string
    siteId: string
    deviceId: string
    isSystemEvents: True
    description: string
    startTime: 0
    endTime: 0
  register: result

返回值

常见的返回值已记录在 此处，以下是此模块特有的字段

键	描述
dnac_response 列表 / 元素=字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值： 始终 示例： "[\n  {\n    \"count\": 0,\n    \"maxTimestamp\": 0,\n    \"minTimestamp\": 0\n  }\n]\n"

作者

• Rafael Campos (@racampos)

资源链接

• 问题追踪器
• 代码仓库