cisco.dnac.event_subscription_email_info – Information module for Event Subscription Email

Note

This plugin is part of the cisco.dnac collection (version 3.1.0).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Event Subscription Email.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
eventIds
string
EventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids).
limit
integer
Limit query parameter. The number of Subscriptions's to limit in the resultset whose default value 10.
offset
integer
Offset query parameter. The number of Subscriptions's to offset in the resultset whose default value 0.
order
string
Order query parameter.
sortBy
string
SortBy query parameter. SortBy field name.

See Also

See also

Event Subscription Email reference

Complete reference of the Event Subscription Email object model.

Examples

- name: Get all Event Subscription Email
  cisco.dnac.event_subscription_email_info:
    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}}"
    eventIds: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

Return Values

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

Key Returned Description
dnac_response
list / elements=dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
[ { "version": "string", "subscriptionId": "string", "name": "string", "description": "string", "subscriptionEndpoints": [ { "instanceId": "string", "subscriptionDetails": { "connectorType": "string", "instanceId": "string", "name": "string", "description": "string", "fromEmailAddress": "string", "toEmailAddresses": [ "string" ], "subject": "string" }, "connectorType": "string" } ], "filter": { "eventIds": [ "string" ], "others": [ "string" ], "domainsSubdomains": [ "string" ], "types": [ "string" ], "categories": [ "string" ], "severities": [ "string" ], "sources": [ "string" ] }, "isPrivate": "string", "tenantId": "string" } ]


Authors

  • Rafael Campos (@racampos)