racampos.dnac.events (0.0.1) — module

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

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: query_result

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: query_result

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

count_of_events:
  contains: null
  description: Get the count of registered Events with provided eventIds or tags as
    mandatory.
  response:
    description: Response, property of the response body.
    returned: always
    sample: 0
    type: int
  returned: always
  type: dict
get_events:
  contains: null
  description: Gets the list of registered Events with provided eventIds or tags as
    mandatory.
  payload:
    contains:
      category:
        description: It is the Events's category.
        returned: always
        sample: <category>
        type: str
      description:
        description: It is the Events's description.
        returned: always
        sample: <description>
        type: str
      details:
        description: It is the Events's details.
        returned: always
        type: dict
      domain:
        description: It is the Events's domain.
        returned: always
        sample: <domain>
        type: str
      eventId:
        description: It is the Events's eventId.
        returned: always
        sample: <eventid>
        type: str
      name:
        description: It is the Events's name.
        returned: always
        sample: <name>
        type: str
      nameSpace:
        description: It is the Events's nameSpace.
        returned: always
        sample: <namespace>
        type: str
      severity:
        description: It is the Events's severity.
        returned: always
        sample: 0
        type: int
      subDomain:
        description: It is the Events's subDomain.
        returned: always
        sample: <subdomain>
        type: str
      subscriptionTypes:
        description: It is the Events's subscriptionTypes.
        returned: always
        type: list
      tags:
        description: It is the Events's tags.
        returned: always
        type: list
      type:
        description: It is the Events's type.
        returned: always
        sample: <type>
        type: str
      version:
        description: It is the Events's version.
        returned: always
        sample: '1.0'
        type: str
    description: It is the Events's payload.
    returned: always
    type: list
  returned: always
  type: dict

See also

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