cisco.dnac.event_series_audit_logs_summary_info – Information module for Event Series Audit Logs Summary

Note

This plugin is part of the cisco.dnac collection (version 3.1.3).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all Event Series Audit Logs Summary.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

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.

See Also

See also

Event Series Audit Logs Summary reference

Complete reference of the Event Series Audit Logs Summary object model.

Examples

- 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

Return Values

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

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 } ]

Authors

• Rafael Campos (@racampos)