cisco.dnac.event_subscription_email module – Resource module for Event Subscription Email

Note

This module is part of the cisco.dnac collection (version 6.0.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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

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

• Create Email Subscription Endpoint for list of registered events.

• Update Email 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.4.6

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port string	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: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
payload list / elements=string	Event Subscription Email’s payload.
description string	Description.
filter dictionary	Event Subscription Email’s filter.
eventIds list / elements=string	Event Ids (Comma separated event ids).
name string	Name.
subscriptionEndpoints list / elements=string	Event Subscription Email’s subscriptionEndpoints.
instanceId string	(From Get Email Subscription Details –> pick InstanceId).
subscriptionDetails dictionary	Event Subscription Email’s subscriptionDetails.
connectorType string	Connector Type (Must be EMAIL).
fromEmailAddress string	Senders Email Address.
subject string	Email Subject.
toEmailAddresses list / elements=string	Recipient’s Email Addresses (Comma separated).
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: no yes ← (default)

Notes

Note

• SDK Method used are event_management.EventManagement.create_email_event_subscription, event_management.EventManagement.update_email_event_subscription,

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

• 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

Examples

- name: Create
  cisco.dnac.event_subscription_email:
    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:
        eventIds:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
          fromEmailAddress: string
          subject: string
          toEmailAddresses:
          - string
      subscriptionId: string
      version: string

- name: Update all
  cisco.dnac.event_subscription_email:
    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:
        eventIds:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
          fromEmailAddress: string
          subject: string
          toEmailAddresses:
          - 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: “{\n \”statusUri\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)