cisco.dnac.event_email_config module – Resource module for Event Email Config

Note

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

New in cisco.dnac 3.1.0

Synopsis

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

• Create Email Destination.

• Update Email Destination.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.7.2

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: false ← (default) true
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	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: false true ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: "2.3.7.6"
emailConfigId string	Required only for update email configuration.
fromEmail string	From Email.
primarySMTPConfig dictionary	Event Email Config’s primarySMTPConfig.
hostName string	Host Name.
password string	Password.
port string	Port.
smtpType string	SmtpType.
userName string	User Name.
secondarySMTPConfig dictionary	Event Email Config’s secondarySMTPConfig.
hostName string	Host Name.
password string	Password.
port string	Port.
smtpType string	SmtpType.
userName string	User Name.
subject string	Subject.
toEmail string	To Email.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)

Notes

Note

• 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,

• 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

See Also

See also

Cisco DNA Center documentation for Event Management CreateEmailDestination

Complete reference of the CreateEmailDestination API.

Cisco DNA Center documentation for Event Management UpdateEmailDestination

Complete reference of the UpdateEmailDestination API.

Examples

- 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
      smtpType: string
      userName: string
    secondarySMTPConfig:
      hostName: string
      password: string
      port: string
      smtpType: 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
      smtpType: string
      userName: string
    secondarySMTPConfig:
      hostName: string
      password: string
      port: string
      smtpType: string
      userName: string
    subject: string
    toEmail: 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: {"statusUri": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)