/ home / cisco / cisco.dnac / 6.13.3 / module / event_info

cisco.dnac.event_info (6.13.3) — module

Information module for Event

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Event.

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

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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: "{{my_headers | from_json}}"
    eventId: string
    tags: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

Inputs

    
tags:
    description:
    - Tags query parameter. The registered Tags should be provided.
    type: str

limit:
    description:
    - Limit query parameter. The number of Registries to limit in the resultset whose
      default value 10.
    type: int

order:
    description:
    - Order query parameter.
    type: str

offset:
    description:
    - Offset query parameter. The number of Registries to offset in the resultset whose
      default value 0.
    type: int

sortBy:
    description:
    - SortBy query parameter. SortBy field name.
    type: str

eventId:
    description:
    - EventId query parameter. The registered EventId should be provided.
    type: str

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  returned: always
  sample: "[\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"
  type: list