cisco.catalystcenter.event_subscription module -- Resource module for Event Subscription

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.event_subscription.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operations create, update and delete of the resource Event Subscription. - > Subscribe SubscriptionEndpoint to list of registered events. Deprecated since Guardian release. Alternative POST /intent/api/v1/event/subscription/rest.

  • Delete EventSubscriptions. - > Update SubscriptionEndpoint to list of registered events. Deprecated since Guardian release. Alternative PUT /intent/api/v1/event/subscription/rest.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

payload

list / elements=dictionary

Event Subscription's payload.

description

string

Description.

filter

dictionary

Event Subscription's filter.

categories

list / elements=string

Categories.

domainsSubdomains

list / elements=dictionary

Event Subscription's domainsSubdomains.

domain

string

Domain.

subDomains

list / elements=string

Sub Domains.

eventIds

list / elements=string

Event Ids (Comma separated event ids).

severities

list / elements=string

Severities.

siteIds

list / elements=string

Site Ids.

sources

list / elements=string

Sources.

types

list / elements=string

Types.

name

string

Name.

subscriptionEndpoints

list / elements=dictionary

Event Subscription's subscriptionEndpoints.

instanceId

string

(From Get Rest/Webhook Subscription Details --> pick instanceId).

subscriptionDetails

dictionary

Event Subscription's subscriptionDetails.

connectorType

string

Connector Type (Must be REST).

subscriptionId

string

Subscription Id (Unique UUID).

version

string

Version.

subscriptions

string

Subscriptions query parameter. List of EventSubscriptionId's for removal.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are event_management.EventManagement.create_event_subscriptions, event_management.EventManagement.delete_event_subscriptions, event_management.EventManagement.update_event_subscriptions,

  • Paths used are post /dna/intent/api/v1/event/subscription, delete /dna/intent/api/v1/event/subscription, put /dna/intent/api/v1/event/subscription,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Event Management CreateEventSubscriptions

Complete reference of the CreateEventSubscriptions API.

Cisco DNA Center documentation for Event Management DeleteEventSubscriptions

Complete reference of the DeleteEventSubscriptions API.

Cisco DNA Center documentation for Event Management UpdateEventSubscriptions

Complete reference of the UpdateEventSubscriptions API.

Examples

---
- name: Delete all
  cisco.catalystcenter.event_subscription:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    subscriptions: string
- name: Update all
  cisco.catalystcenter.event_subscription:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - description: string
        filter:
          categories:
            - string
          domainsSubdomains:
            - domain: string
              subDomains:
                - string
          eventIds:
            - string
          severities:
            - string
          siteIds:
            - string
          sources:
            - string
          types:
            - string
        name: string
        subscriptionEndpoints:
          - instanceId: string
            subscriptionDetails:
              connectorType: string
        subscriptionId: string
        version: string
- name: Create
  cisco.catalystcenter.event_subscription:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - description: string
        filter:
          categories:
            - string
          domainsSubdomains:
            - domain: string
              subDomains:
                - string
          eventIds:
            - string
          severities:
            - string
          siteIds:
            - string
          sources:
            - string
          types:
            - string
        name: string
        subscriptionEndpoints:
          - instanceId: string
            subscriptionDetails:
              connectorType: string
        subscriptionId: string
        version: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"statusUri": "string"}`

Authors

  • Rafael Campos (@racampos)