cisco.dnac.event_series_audit_logs_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_series_audit_logs_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有事件序列审核日志 V1。

  • 从事件中心获取审核日志事件实例。

注意

此模块具有相应的 操作插件

要求

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

  • 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 时,endTime 是强制性的)。

eventHierarchy

字符串

EventHierarchy 查询参数。审核日志通知的事件 eventHierarchy。例如“US.CA.San Jose”或“US.CA”或“CA.San Jose” - 层次结构分隔符为“.”。

eventId

字符串

EventId 查询参数。审核日志通知的事件 ID。

headers

字典

附加标头。

instanceId

字符串

InstanceId 查询参数。审核日志的 InstanceID。

isSystemEvents

布尔值

IsSystemEvents 查询参数。用于过滤系统生成的审核日志的参数。

选项

  • false

  • true

limit

浮点数

Limit 查询参数。每页返回的审核日志记录数。

name

字符串

Name 查询参数。审核日志通知事件名称。

offset

浮点数

Offset 查询参数。数据中特定审核日志记录的位置。

order

字符串

Order 查询参数。排序后的审核日志记录的顺序。默认值为按时间戳降序排列。支持的值:asc、desc。

parentInstanceId

字符串

ParentInstanceId 查询参数。父审核日志记录的 instanceID。

severity

字符串

Severity 查询参数。审核日志通知的事件严重性。支持的值:1、2、3、4、5。

siteId

字符串

SiteId 查询参数。审核日志通知的 siteId。

sortBy

字符串

SortBy 查询参数。按特定字段对审核日志进行排序。支持的值是事件通知报头属性。

source

字符串

Source 查询参数。审核日志通知的事件源。

startTime

浮点数

StartTime 查询参数。自纪元以来的毫秒数开始时间,例如 1597950637211(当提供 endTime 时,startTime 是强制性的)。

subDomain

字符串

SubDomain 查询参数。审核日志通知的事件子域。

userId

字符串

UserId 查询参数。审核日志通知的事件 userId。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的SDK方法是event_management.EventManagement.get_auditlog_records。

  • 使用的路径是GET /dna/data/api/v1/event/event-series/audit-logs。

  • 支持check_mode

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

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

参见

另请参见

Cisco DNA Center文档,关于Event Management GetAuditLogRecordsV1。

GetAuditLogRecordsV1 API的完整参考。

示例

- name: Get all Event Series Audit Logs V1
  cisco.dnac.event_series_audit_logs_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}}"
    parentInstanceId: string
    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
    offset: 0
    limit: 0
    startTime: 0
    endTime: 0
    sortBy: string
    order: string
  register: result

返回值

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

描述

dnac_response

列表 / 元素=字典

包含Cisco DNAC Python SDK返回的响应的字典或列表。

返回值:始终返回

示例:"[\n  {\n    \"version\": \"string\",\n    \"instanceId\": \"string\",\n    \"eventId\": \"string\",\n    \"namespace\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"type\": \"string\",\n    \"category\": \"string\",\n    \"domain\": \"string\",\n    \"subDomain\": \"string\",\n    \"severity\": 0,\n    \"source\": \"string\",\n    \"timestamp\": 0,\n    \"tags\": [\n      {}\n    ],\n    \"details\": {},\n    \"ciscoDnaEventLink\": \"string\",\n    \"note\": \"string\",\n    \"tntId\": \"string\",\n    \"context\": \"string\",\n    \"userId\": \"string\",\n    \"i18n\": \"string\",\n    \"eventHierarchy\": \"string\",\n    \"message\": \"string\",\n    \"messageParams\": \"string\",\n    \"additionalDetails\": {},\n    \"parentInstanceId\": \"string\",\n    \"network\": \"string\",\n    \"childCount\": 0,\n    \"tenantId\": \"string\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)