cisco.dnac.event_series_audit_logs_info module – Information module for Event Series Audit Logs

Note

This module is part of the cisco.dnac collection (version 6.6.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.event_series_audit_logs_info.

New in cisco.dnac 3.1.0

Synopsis

  • Get all Event Series Audit Logs.

  • Get Audit Log Event instances from the Event-Hub.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.5.4

  • python >= 3.5

Parameters

Parameter

Comments

category

string

Category query parameter. Audit Log notification’s event category. Supported values INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION.

context

string

Context query parameter. Audit Log notification’s event correlationId.

description

string

Description query parameter. String full/partial search - (Provided input string is case insensitively matched for records).

deviceId

string

DeviceId query parameter. Audit Log notification’s deviceId.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.3.0"

domain

string

Domain query parameter. Audit Log notification’s event domain.

endTime

integer

EndTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory).

eventHierarchy

string

EventHierarchy query parameter. Audit Log notification’s event eventHierarchy. Example “US.CA.San Jose” OR “US.CA” OR “CA.San Jose” - Delimiter for hierarchy separation is “.”.

eventId

string

EventId query parameter. Audit Log notification’s event ID.

headers

dictionary

Additional headers.

instanceId

string

InstanceId query parameter. InstanceID of the Audit Log.

isSystemEvents

boolean

IsSystemEvents query parameter. Parameter to filter system generated audit-logs.

Choices:

  • false

  • true

limit

integer

Limit query parameter. Number of Audit Log records to be returned per page.

name

string

Name query parameter. Audit Log notification event name.

offset

integer

Offset query parameter. Position of a particular Audit Log record in the data.

order

string

Order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values asc, desc.

parentInstanceId

string

ParentInstanceId query parameter. Parent Audit Log record’s instanceID.

severity

string

Severity query parameter. Audit Log notification’s event severity. Supported values 1, 2, 3, 4, 5.

siteId

string

SiteId query parameter. Audit Log notification’s siteId.

sortBy

string

SortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes.

source

string

Source query parameter. Audit Log notification’s event source.

startTime

integer

StartTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory).

subDomain

string

SubDomain query parameter. Audit Log notification’s event sub-domain.

userId

string

UserId query parameter. Audit Log notification’s event userId.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are event_management.EventManagement.get_auditlog_records,

  • Paths used are get /dna/data/api/v1/event/event-series/audit-logs,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Event Management GetAuditLogRecords

Complete reference of the GetAuditLogRecords API.

Examples

- name: Get all Event Series Audit Logs
  cisco.dnac.event_series_audit_logs_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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: "[\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"

Authors

  • Rafael Campos (@racampos)