cisco.dnac.event_email_config 模块 – 用于事件电子邮件配置的资源模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定： cisco.dnac.event_email_config。

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 event_email_config_v1 的别名

注意

此模块具有相应的操作插件。

要求 

执行此模块的主机需要满足以下要求。

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
dnac_debug 布尔值	用于启用 Cisco DNA Center SDK 调试的标志。选项 `false` ← (默认) `true`
dnac_host 字符串 / 必需	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。默认值: `443`
dnac_username 别名: user 字符串	用于身份验证的 Cisco DNA Center 用户名。默认值: `"admin"`
dnac_verify 布尔值	用于启用或禁用 SSL 证书验证的标志。选项 `false` `true` ← (默认)
dnac_version 字符串	通知 SDK 要使用的 Cisco DNA Center 版本。默认值: `"2.3.7.6"`
emailConfigId 字符串	仅在更新电子邮件配置时需要。
fromEmail 字符串	发件人电子邮件。
primarySMTPConfig 字典	事件电子邮件配置的 primarySMTPConfig。
hostName 字符串	主机名。
password 字符串	密码。
port 字符串	端口。
smtpType 字符串	SmtpType。
userName 字符串	用户名。
secondarySMTPConfig 字典	事件电子邮件配置的 secondarySMTPConfig。
hostName 字符串	主机名。
password 字符串	密码。
port 字符串	端口。
smtpType 字符串	SmtpType。
userName 字符串	用户名。
subject 字符串	主题。
toEmail 字符串	收件人电子邮件。
validate_response_schema 布尔值	用于启用 Cisco DNA Center SDK 针对 JSON 模式验证请求体的标志。选项 `false` `true` ← (默认)

说明 

注意

使用的 SDK 方法是 event_management.EventManagement.create_email_destination_v1, event_management.EventManagement.update_email_destination_v1,
使用的路径是 post /dna/intent/api/v1/event/email-config, put /dna/intent/api/v1/event/email-config,
应该注意的是，此模块是 event_email_config_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

有关事件管理 CreateEmailDestinationV1 的 Cisco DNA Center 文档: CreateEmailDestinationV1 API 的完整参考。
有关事件管理 UpdateEmailDestinationV1 的 Cisco DNA Center 文档: UpdateEmailDestinationV1 API 的完整参考。

示例 

- 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

返回值 

通用返回值记录在此处，以下是此模块特有的字段

键	描述
dnac_response 字典	一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应返回值: 始终示例: `{"statusUri": "字符串"}`

作者

Rafael Campos (@racampos)