cisco.dnac.events – Manage Events objects of EventManagement

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Gets the list of registered Events with provided eventIds or tags as mandatory.

  • Get the count of registered Events with provided eventIds or tags as mandatory.

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
count
boolean / required
    Choices:
  • no
  • yes
If true gets the number of objects.
event_id
string
The registered EventId should be provided.
limit
integer
The number of Registries to limit in the resultset whose default value 10.
offset
integer
The number of Registries to offset in the resultset whose default value 0.
order
string
Order query parameter.
sort_by
string
SortBy field name.
tags
string / required
The registered Tags should be provided.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.events

The official documentation on the cisco.dnac.plugins.module_utils.definitions.events module.

Events reference

Complete reference of the Events object model.

Events reference

SDK reference.

Examples

- name: get_events
  cisco.dnac.events:
    state: query  # required
    tags: SomeValue  # string, required
    event_id: SomeValue  # string
    limit: 1  #  number
    offset: 1  #  number
    order: SomeValue  # string
    sort_by: SomeValue  # string
  register: nm_get_events

- name: count_of_events
  cisco.dnac.events:
    state: query  # required
    tags: SomeValue  # string, required
    count: True  # boolean, required
    event_id: SomeValue  # string
  register: nm_count_of_events

Return Values

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

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
event_management.count_of_events


Authors

  • Rafael Campos (@racampos)