cisco.dnac.event_series_info – Information module for Event Series

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_info.

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all Event Series.

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.
domain string		Domain query parameter.
endTime integer		EndTime query parameter. End Time in milliseconds.
eventIds string		EventIds query parameter. The registered EventId should be provided.
headers dictionary		Additional headers.
limit integer		Limit query parameter.
offset integer		Offset query parameter. Start Offset.
order string		Order query parameter. Ascending/Descending order asc/desc.
severity string		Severity query parameter.
sortBy string		SortBy query parameter. Sort By column.
source string		Source query parameter.
startTime integer		StartTime query parameter. Start Time in milliseconds.
subDomain string		SubDomain query parameter. Sub Domain.
type string		Type query parameter.

See Also

See also

Event Series reference

Complete reference of the Event Series object model.

Examples

- name: Get all Event Series
  cisco.dnac.event_series_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
    eventIds: string
    startTime: 0
    endTime: 0
    category: string
    type: string
    severity: string
    domain: string
    subDomain: string
    source: string
    offset: 0
    limit: 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	Returned	Description
dnac_response list / elements=dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: [ { "eventId": "string", "instanceId": "string", "nameSpace": "string", "name": "string", "description": "string", "version": "string", "category": "string", "domain": "string", "subDomain": "string", "type": "string", "severity": "string", "source": "string", "timestamp": "string", "details": "string", "eventHierarchy": "string" } ]

Authors

• Rafael Campos (@racampos)