cisco.dnac.event_series – Manage EventSeries 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.event_series.

New in version 1.0.0: of cisco.dnac

Synopsis

• Get the list of Published Notifications.

• Get the Count of Published Notifications.

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 .
count boolean / required	Choices: no yes	If true gets the number of objects.
domain string		Domain .
end_time string		EndTime .
event_ids string		The registered EventIds should be provided.
limit integer		Limit whose default value 10.
offset integer		Offset whose default value 0.
order string		Order query parameter.
severity string		Severity .
sort_by string		SortBy field name.
source string		Source .
start_time string		StartTime .
sub_domain string		SubDomain .
type string		Type .

See Also

See also

cisco.dnac.plugins.module_utils.definitions.event_series

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

EventSeries reference

Complete reference of the EventSeries object model.

EventSeries reference

SDK reference.

Examples

- name: get_notifications
  cisco.dnac.event_series:
    state: query  # required
    category: SomeValue  # string
    domain: SomeValue  # string
    end_time: SomeValue  # string
    event_ids: SomeValue  # string
    limit: 1  #  number
    offset: 1  #  number
    order: SomeValue  # string
    severity: SomeValue  # string
    sort_by: SomeValue  # string
    source: SomeValue  # string
    start_time: SomeValue  # string
    sub_domain: SomeValue  # string
    type: SomeValue  # string
  register: nm_get_notifications

- name: count_of_notifications
  cisco.dnac.event_series:
    state: query  # required
    count: True  # boolean, required
    category: SomeValue  # string
    domain: SomeValue  # string
    end_time: SomeValue  # string
    event_ids: SomeValue  # string
    severity: SomeValue  # string
    source: SomeValue  # string
    start_time: SomeValue  # string
    sub_domain: SomeValue  # string
    type: SomeValue  # string
  register: nm_count_of_notifications

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_notifications

Authors

• Rafael Campos (@racampos)