.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.dnac.event_series_audit_logs_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.event_series_audit_logs_info -- Information module for Event Series Audit Logs +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 4.0.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 :code:`ansible-galaxy collection list`. 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_info`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Event Series Audit Logs. .. 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 >= 2.4.0 - python >= 3.5 .. 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.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
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
    Choices:
  • no
  • yes
IsSystemEvents query parameter. Parameter to filter system generated audit-logs.
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
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Event Series Audit Logs reference `_ Complete reference of the Event Series Audit Logs object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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: custom: value 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 .. 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:
[ { "version": "string", "instanceId": "string", "eventId": "string", "namespace": "string", "name": "string", "description": "string", "type": "string", "category": "string", "domain": "string", "subDomain": "string", "severity": 0, "source": "string", "timestamp": 0, "tags": [ {} ], "details": {}, "ciscoDnaEventLink": "string", "note": "string", "tntId": "string", "context": "string", "userId": "string", "i18n": "string", "eventHierarchy": "string", "message": "string", "messageParams": "string", "additionalDetails": {}, "parentInstanceId": "string", "network": "string", "childCount": 0, "tenantId": "string" } ]


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