cisco.dnac.event_series (2.0.7) — module

Manage EventSeries objects of EventManagement

| "added in version" 1.0.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:==2.0.7


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Get the list of Published Notifications.

Get the Count of Published Notifications.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_notifications
  cisco.dnac.event_series:
    state: query  # required
    category: SomeValue  # string
    domain: SomeValue  # string
    end_time: SomeValue  # string
    event_ids: SomeValue  # string
    limit: 1  #  number
    offset: 1  #  number
    order: SomeValue  # string
    severity: SomeValue  # string
    sort_by: SomeValue  # string
    source: SomeValue  # string
    start_time: SomeValue  # string
    sub_domain: SomeValue  # string
    type: SomeValue  # string
  register: nm_get_notifications
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: count_of_notifications
  cisco.dnac.event_series:
    state: query  # required
    count: True  # boolean, required
    category: SomeValue  # string
    domain: SomeValue  # string
    end_time: SomeValue  # string
    event_ids: SomeValue  # string
    severity: SomeValue  # string
    source: SomeValue  # string
    start_time: SomeValue  # string
    sub_domain: SomeValue  # string
    type: SomeValue  # string
  register: nm_count_of_notifications

Inputs

    
type:
    description:
    - Type .
    type: str

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

limit:
    description:
    - Limit whose default value 10.
    type: int

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

domain:
    description:
    - Domain .
    type: str

offset:
    description:
    - Offset whose default value 0.
    type: int

source:
    description:
    - Source .
    type: str

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

category:
    description:
    - Category .
    type: str

end_time:
    description:
    - EndTime .
    type: str

severity:
    description:
    - Severity .
    type: str

event_ids:
    description:
    - The registered EventIds should be provided.
    type: str

start_time:
    description:
    - StartTime .
    type: str

sub_domain:
    description:
    - SubDomain .
    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_notifications
  type: str

See also