/ home / cisco / cisco.dnac / 6.13.3 / module / event_series_info

cisco.dnac.event_series_info (6.13.3) — module

Information module for Event Series

| "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 Series.

Get the list of Published Notifications.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Event Series
  cisco.dnac.event_series_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}}"
    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

Inputs

    
tags:
    description:
    - Tags query parameter.
    type: str

type:
    description:
    - Type query parameter.
    type: str

limit:
    description:
    - Limit query parameter.
    type: int

order:
    description:
    - Order query parameter. Ascending/Descending order asc/desc.
    type: str

domain:
    description:
    - Domain query parameter.
    type: str

offset:
    description:
    - Offset query parameter. Start Offset.
    type: int

siteId:
    description:
    - SiteId query parameter. Site Id.
    type: str

sortBy:
    description:
    - SortBy query parameter. Sort By column.
    type: str

source:
    description:
    - Source query parameter.
    type: str

endTime:
    description:
    - EndTime query parameter. End Time in milliseconds.
    type: int

headers:
    description: Additional headers.
    type: dict

category:
    description:
    - Category query parameter.
    type: str

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

severity:
    description:
    - Severity query parameter.
    type: str

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

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

namespace:
    description:
    - Namespace query parameter.
    type: str

startTime:
    description:
    - StartTime query parameter. Start Time in milliseconds.
    type: int

subDomain:
    description:
    - SubDomain query parameter. Sub Domain.
    type: str

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    \"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"
  type: list