/ home / cisco / cisco.dnac / 6.13.3 / module / event_series_audit_logs_summary_info

cisco.dnac.event_series_audit_logs_summary_info (6.13.3) — module

Information module for Event Series Audit Logs Summary

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Event Series Audit Logs Summary.

Get Audit Log Summary from the Event-Hub.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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: "{{my_headers | from_json}}"
    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

Inputs

    
name:
    description:
    - Name query parameter. Audit Log notification event name.
    type: str

domain:
    description:
    - Domain query parameter. Audit Log notification's event domain.
    type: str

siteId:
    description:
    - SiteId query parameter. Audit Log notification's siteId.
    type: str

source:
    description:
    - Source query parameter. Audit Log notification's event source.
    type: str

userId:
    description:
    - UserId query parameter. Audit Log notification's event userId.
    type: str

context:
    description:
    - Context query parameter. Audit Log notification's event correlationId.
    type: str

endTime:
    description:
    - 'EndTime query parameter. End Time in milliseconds since Epoch Eg. 1597961437211
      (when provided startTime is mandatory).

      '
    type: int

eventId:
    description:
    - EventId query parameter. Audit Log notification's event ID.
    type: str

headers:
    description: Additional headers.
    type: dict

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

      '
    type: str

deviceId:
    description:
    - DeviceId query parameter. Audit Log notification's deviceId.
    type: str

severity:
    description:
    - Severity query parameter. Audit Log notification's event severity. Supported values
      1, 2, 3, 4, 5.
    type: str

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

startTime:
    description:
    - 'StartTime query parameter. Start Time in milliseconds since Epoch Eg. 1597950637211
      (when provided endTime is mandatory).

      '
    type: int

subDomain:
    description:
    - SubDomain query parameter. Audit Log notification's event sub-domain.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

instanceId:
    description:
    - InstanceId query parameter. InstanceID of the Audit Log.
    type: str

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

      '
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

isParentOnly:
    description:
    - IsParentOnly query parameter. Parameter to filter parent only audit-logs.
    type: bool

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

eventHierarchy:
    description:
    - '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 ".".

      '
    type: str

isSystemEvents:
    description:
    - IsSystemEvents query parameter. Parameter to filter system generated audit-logs.
    type: bool

parentInstanceId:
    description:
    - ParentInstanceId query parameter. Parent Audit Log record's instanceID.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  returned: always
  sample: "[\n  {\n    \"count\": 0,\n    \"maxTimestamp\": 0,\n    \"minTimestamp\"\
    : 0\n  }\n]\n"
  type: list