cisco.dnac.event_info – Information module for Event

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Event.

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
eventId
string
EventId query parameter. The registered EventId should be provided.
headers
dictionary
Additional headers.
limit
integer
Limit query parameter. The number of Registries to limit in the resultset whose default value 10.
offset
integer
Offset query parameter. The number of Registries to offset in the resultset whose default value 0.
order
string
Order query parameter.
sortBy
string
SortBy query parameter. SortBy field name.
tags
string
Tags query parameter. The registered Tags should be provided.

See Also

See also

Event reference

Complete reference of the Event object model.

Examples

- name: Get all Event
  cisco.dnac.event_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
    eventId: string
    tags: 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", "nameSpace": "string", "name": "string", "description": "string", "version": "string", "category": "string", "domain": "string", "subDomain": "string", "type": "string", "tags": [ "string" ], "severity": 0, "details": {}, "subscriptionTypes": [ "string" ] } ]


Authors

  • Rafael Campos (@racampos)