cisco.dnac.event_subscription_email_info module – Information module for Event Subscription Email
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_email_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Event Subscription Email.
Gets the list of email Subscriptions’s based on provided query params.
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 |
|---|---|
Category query parameter. List of email subscriptions related to the respective category. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Domain query parameter. List of email subscriptions related to the respective domain. |
|
EventIds query parameter. List of email subscriptions related to the respective eventIds (Comma separated event ids). |
|
Additional headers. |
|
Limit query parameter. The number of Subscriptions’s to limit in the resultset whose default value 10. |
|
Name query parameter. List of email subscriptions related to the respective name. |
|
Offset query parameter. The number of Subscriptions’s to offset in the resultset whose default value 0. |
|
Order query parameter. |
|
SortBy query parameter. SortBy field name. |
|
SubDomain query parameter. List of email subscriptions related to the respective sub-domain. |
|
Type query parameter. List of email subscriptions related to the respective type. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are event_management.EventManagement.get_email_event_subscriptions,
Paths used are get /dna/intent/api/v1/event/subscription/email,
Supports
check_modeThe 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 GetEmailEventSubscriptions
Complete reference of the GetEmailEventSubscriptions API.
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}}"
headers: "{{my_headers | from_json}}"
eventIds: string
offset: 0
limit: 0
sortBy: string
order: string
domain: string
subDomain: string
category: string
type: string
name: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |