cisco.dnac.event_email_config_v1 模块 – 事件邮件配置 V1 资源模块

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅需求。

要在剧本中使用它，请指定： cisco.dnac.event_email_config_v1。

cisco.dnac 3.1.0 中的新增功能

概要 

管理事件邮件配置 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 字符串	SMTP 类型。
userName 字符串	用户名。
secondarySMTPConfig 字典	事件邮件配置的 secondarySMTPConfig。
hostName 字符串	主机名。
password 字符串	密码。
port 字符串	端口。
smtpType 字符串	SMTP 类型。
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，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参见 

另请参见

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

示例 

- name: Update all
  cisco.dnac.event_email_config_v1:
    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_v1:
    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": "string"}`

作者

Rafael Campos (@racampos)