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.24.0).
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.7.2
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
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 query parameter. Audit Log notification's event correlationId. |
|
Description query parameter. String full/partial search - (Provided input string is case insensitively matched for records). |
|
DeviceId query parameter. Audit Log notification's deviceId. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices: |
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: :ansible-option-default:`443` |
|
The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Domain query parameter. Audit Log notification's event domain. |
|
EndTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211 (when provided startTime is mandatory). |
|
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 query parameter. Audit Log notification's event ID. |
|
Additional headers. |
|
InstanceId query parameter. InstanceID of the Audit Log. |
|
IsSystemEvents query parameter. Parameter to filter system generated audit-logs. Choices: |
|
Limit query parameter. Number of Audit Log records to be returned per page. |
|
Name query parameter. Audit Log notification event name. |
|
Offset query parameter. Position of a particular Audit Log record in the data. |
|
Order query parameter. Order of the sorted Audit Log records. Default value is desc by timestamp. Supported values asc, desc. |
|
ParentInstanceId query parameter. Parent Audit Log record's instanceID. |
|
Severity query parameter. Audit Log notification's event severity. Supported values 1, 2, 3, 4, 5. |
|
SiteId query parameter. Audit Log notification's siteId. |
|
SortBy query parameter. Sort the Audit Logs by certain fields. Supported values are event notification header attributes. |
|
Source query parameter. Audit Log notification's event source. |
|
StartTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211 (when provided endTime is mandatory). |
|
SubDomain query parameter. Audit Log notification's event sub-domain. |
|
UserId query parameter. Audit Log notification's event userId. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
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_modeThe 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 |
|---|---|