.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.event_series_audit_logs_summary_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.event_series_audit_logs_summary_info -- Information module for Event Series Audit Logs Summary +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.1.2). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.event_series_audit_logs_summary_info`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Event Series Audit Logs Summary. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults 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.
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.
isParentOnly
boolean
    Choices:
  • no
  • yes
IsParentOnly query parameter. Parameter to filter parent only audit-logs.
isSystemEvents
boolean
    Choices:
  • no
  • yes
IsSystemEvents query parameter. Parameter to filter system generated audit-logs.
name
string
Name query parameter. Audit Log notification event name.
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.
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.

.. Notes .. Seealso See Also -------- .. seealso:: `Event Series Audit Logs Summary reference `_ Complete reference of the Event Series Audit Logs Summary object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Get all Event Series Audit Logs Summary 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: custom: value 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
list / elements=dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
[ { "count": 0, "maxTimestamp": 0, "minTimestamp": 0 } ]


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors