cisco.dnac.events (2.0.7) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

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

Get the count of registered Events with provided eventIds or tags as mandatory.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: get_events
  cisco.dnac.events:
    state: query  # required
    tags: SomeValue  # string, required
    event_id: SomeValue  # string
    limit: 1  #  number
    offset: 1  #  number
    order: SomeValue  # string
    sort_by: SomeValue  # string
  register: nm_get_events

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: count_of_events
  cisco.dnac.events:
    state: query  # required
    tags: SomeValue  # string, required
    count: True  # boolean, required
    event_id: SomeValue  # string
  register: nm_count_of_events

Inputs

    
tags:
    description:
    - The registered Tags should be provided.
    required: true
    type: str

count:
    description:
    - If true gets the number of objects.
    required: true
    type: bool

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

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

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

sort_by:
    description:
    - SortBy field name.
    type: str

event_id:
    description:
    - The registered EventId should be provided.
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: event_management.count_of_events
  type: str

See also

• cisco.dnac.plugins.module_utils.definitions.events
• Events reference: Complete reference of the Events object model. link
• Events reference: SDK reference. link