cisco.catalystcenter.event_subscription_email module -- Resource module for Event Subscription Email

Note

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

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_email.

New in cisco.catalystcenter 3.1.0

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.

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_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 Email's payload.
description string	Description.
filter dictionary	Event Subscription Email's filter.
categories list / elements=string	Categories.
domainsSubdomains list / elements=dictionary	Event Subscription Email's domainsSubdomains.
domain string	Domain.
subDomains list / elements=string	Sub Domains.
eventIds list / elements=string	Event Ids.
severities list / elements=integer	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 Email's subscriptionEndpoints.
instanceId string	(From Get Email Subscription Details --> pick InstanceId if available).
subscriptionDetails dictionary	Event Subscription Email's subscriptionDetails.
connectorType string	Connector Type (Must be EMAIL).
description string	Description.
fromEmailAddress string	Senders Email Address.
name string	Name.
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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (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 uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Event Management CreateEmailEventSubscription

Complete reference of the CreateEmailEventSubscription API.

Cisco DNA Center documentation for Event Management UpdateEmailEventSubscription

Complete reference of the UpdateEmailEventSubscription API.

Examples

---
- name: Create
  cisco.catalystcenter.event_subscription_email:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    payload:
      - description: string
        filter:
          categories:
            - string
          domainsSubdomains:
            - domain: string
              subDomains:
                - string
          eventIds:
            - string
          severities:
            - 0
          siteIds:
            - string
          sources:
            - string
          types:
            - string
        name: string
        subscriptionEndpoints:
          - instanceId: string
            subscriptionDetails:
              connectorType: string
              description: string
              fromEmailAddress: string
              name: string
              subject: string
              toEmailAddresses:
                - string
        subscriptionId: string
        version: string
- name: Update all
  cisco.catalystcenter.event_subscription_email:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    payload:
      - description: string
        filter:
          categories:
            - string
          domainsSubdomains:
            - domain: string
              subDomains:
                - string
          eventIds:
            - string
          severities:
            - 0
          siteIds:
            - string
          sources:
            - string
          types:
            - string
        name: string
        subscriptionEndpoints:
          - instanceId: string
            subscriptionDetails:
              connectorType: string
              description: string
              fromEmailAddress: string
              name: 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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"statusUri": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)