cisco.catalystcenter.event_series_info module -- Information module for Event Series

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.event_series_info.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all Event Series.

  • Get the list of Published Notifications.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

category

string

Category query parameter.

domain

string

Domain query parameter.

endTime

float

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.

namespace

string

Namespace query parameter.

offset

integer

Offset query parameter. Start Offset.

order

string

Order query parameter. Ascending/Descending order asc/desc.

severity

string

Severity query parameter.

siteId

string

SiteId query parameter. Site Id.

sortBy

string

SortBy query parameter. Sort By column.

source

string

Source query parameter.

startTime

float

StartTime query parameter. Start Time in milliseconds.

subDomain

string

SubDomain query parameter. Sub Domain.

tags

string

Tags query parameter.

type

string

Type query parameter.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are event_management.EventManagement.get_notifications,

  • Paths used are get /dna/intent/api/v1/event/event-series,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Event Management GetNotifications

Complete reference of the GetNotifications API.

Examples

---
- name: Get all Event Series
  cisco.catalystcenter.event_series_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    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
    tags: string
    namespace: string
    siteId: string
  register: result

Return Values

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

Key

Description

dnac_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"eventId\\": \\"string\\",\\n \\"instanceId\\": \\"string\\",\\n \\"namespace\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"version\\": \\"string\\",\\n \\"category\\": \\"string\\",\\n \\"domain\\": \\"string\\",\\n \\"subDomain\\": \\"string\\",\\n \\"type\\": \\"string\\",\\n \\"severity\\": \\"string\\",\\n \\"source\\": \\"string\\",\\n \\"timestamp\\": \\"string\\",\\n \\"details\\": \\"string\\",\\n \\"eventHierarchy\\": \\"string\\",\\n \\"network\\": {\\n \\"siteId\\": \\"string\\",\\n \\"deviceId\\": \\"string\\"\\n }\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)