File: //lib/python3.9/site-packages/ansible_collections/cisco/dnac/plugins/modules/event_email_config.py
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: event_email_config
short_description: Resource module for Event Email Config
description:
- Manage operations create and update of the resource Event Email Config.
- Create Email Destination.
- Update Email Destination.
version_added: '6.7.0'
extends_documentation_fragment:
- cisco.dnac.module
author: Rafael Campos (@racampos)
options:
emailConfigId:
description: Required only for update email configuration.
type: str
fromEmail:
description: From Email.
type: str
primarySMTPConfig:
description: Event Email Config's primarySMTPConfig.
suboptions:
hostName:
description: Host Name.
type: str
password:
description: Password.
type: str
port:
description: Port.
type: str
userName:
description: User Name.
type: str
type: dict
secondarySMTPConfig:
description: Event Email Config's secondarySMTPConfig.
suboptions:
hostName:
description: Host Name.
type: str
password:
description: Password.
type: str
port:
description: Port.
type: str
userName:
description: User Name.
type: str
type: dict
subject:
description: Subject.
type: str
toEmail:
description: To Email.
type: str
requirements:
- dnacentersdk >= 2.5.5
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Event Management CreateEmailDestination
description: Complete reference of the CreateEmailDestination API.
link: https://developer.cisco.com/docs/dna-center/#!create-email-destination
- name: Cisco DNA Center documentation for Event Management UpdateEmailDestination
description: Complete reference of the UpdateEmailDestination API.
link: https://developer.cisco.com/docs/dna-center/#!update-email-destination
notes:
- SDK Method used are
event_management.EventManagement.create_email_destination,
event_management.EventManagement.update_email_destination,
- Paths used are
post /dna/intent/api/v1/event/email-config,
put /dna/intent/api/v1/event/email-config,
"""
EXAMPLES = r"""
- name: Update all
cisco.dnac.event_email_config:
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
emailConfigId: string
fromEmail: string
primarySMTPConfig:
hostName: string
password: string
port: string
userName: string
secondarySMTPConfig:
hostName: string
password: string
port: string
userName: string
subject: string
toEmail: string
- name: Create
cisco.dnac.event_email_config:
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
emailConfigId: string
fromEmail: string
primarySMTPConfig:
hostName: string
password: string
port: string
userName: string
secondarySMTPConfig:
hostName: string
password: string
port: string
userName: string
subject: string
toEmail: string
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"statusUri": "string"
}
"""