cisco.catalystcenter.event_info module -- Information module for Event

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all Event.

  • Gets the list 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.

  • 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"`

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.

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_events,

  • Paths used are get /dna/intent/api/v1/events,

  • 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 GetEvents

Complete reference of the GetEvents API.

Examples

---
- name: Get all Event
  cisco.catalystcenter.event_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}}"
    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

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 \\"nameSpace\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"version\\": \\"string\\",\\n \\"category\\": \\"string\\",\\n \\"domain\\": \\"string\\",\\n \\"subDomain\\": \\"string\\",\\n \\"type\\": \\"string\\",\\n \\"tags\\": [\\n \\"string\\"\\n ],\\n \\"severity\\": 0,\\n \\"details\\": {},\\n \\"subscriptionTypes\\": [\\n \\"string\\"\\n ]\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)