cisco.dnac.event_subscription_rest module – Resource module for Event Subscription Rest

Note

This module is part of the cisco.dnac collection (version 6.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

To use it in a playbook, specify: cisco.dnac.event_subscription_rest.

New in cisco.dnac 3.1.0

Synopsis

  • Manage operations create and update of the resource Event Subscription Rest.

  • Create Rest/Webhook Subscription Endpoint for list of registered events.

  • Update Rest/Webhook Subscription Endpoint for list of registered events.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.5.5

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.5.3"

payload

list / elements=dictionary

Event Subscription Rest’s payload.

description

string

Description.

filter

dictionary

Event Subscription Rest’s filter.

categories

list / elements=string

Categories.

domainsSubdomains

list / elements=dictionary

Event Subscription Rest’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 Rest’s subscriptionEndpoints.

instanceId

string

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

subscriptionDetails

dictionary

Event Subscription Rest’s subscriptionDetails.

connectorType

string

Connector Type (Must be REST).

subscriptionId

string

Subscription Id (Unique UUID).

version

string

Version.

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are event_management.EventManagement.create_rest_webhook_event_subscription, event_management.EventManagement.update_rest_webhook_event_subscription,

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

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Event Management CreateRestWebhookEventSubscription

Complete reference of the CreateRestWebhookEventSubscription API.

Cisco DNA Center documentation for Event Management UpdateRestWebhookEventSubscription

Complete reference of the UpdateRestWebhookEventSubscription API.

Examples

- name: Create
  cisco.dnac.event_subscription_rest:
    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}}"
    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: Update all
  cisco.dnac.event_subscription_rest:
    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}}"
    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 DNAC Python SDK

Returned: always

Sample: {"statusUri": "string"}

Authors

  • Rafael Campos (@racampos)