fortinet.fortios.fortios_system_email_server 模块 – 配置 FortiGate 使用的电子邮件服务器，用于各种用途。例如，向用户发送电子邮件以支持 Fortinet 的 FortiOS 和 FortiGate 中的用户身份验证功能。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

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

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

要在 playbook 中使用它，请指定： fortinet.fortios.fortios_system_email_server。

fortinet.fortios 2.0.0 中的新增功能

概要 

此模块能够通过允许用户设置和修改系统功能和 email_server 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。

要求 

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

ansible>=2.15

参数 

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
member_path 字符串	要操作的成员属性路径。如果有多个属性，则用斜杠字符分隔。标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。指定 member_state 时，将忽略 state 选项。选项 `"present"` `"absent"`
system_email_server 字典	配置 FortiGate 使用的电子邮件服务器，用于各种用途。例如，发送电子邮件给用户以支持用户身份验证功能。
authenticate 字符串	启用/禁用身份验证。选项 `"enable"` `"disable"`
interface 字符串	指定用于到达服务器的出站接口。来源 system.interface.name。
interface_select_method 字符串	指定如何选择用于到达服务器的出站接口。选项 `"auto"` `"sdwan"` `"specify"`
password 字符串	用于身份验证的 SMTP 服务器用户名密码。
port 整数	SMTP 服务器端口。
reply_to 字符串	回复地址。
security 字符串	电子邮件服务器使用的连接安全性。选项 `"none"` `"starttls"` `"smtps"`
server 字符串	SMTP 服务器 IP 地址或主机名。
source_ip 字符串	SMTP 服务器 IPv4 源 IP。
source_ip6 字符串	SMTP 服务器 IPv6 源 IP。
ssl_min_proto_version 字符串	SSL/TLS 连接支持的最低协议版本。选项 `"default"` `"SSLv3"` `"TLSv1"` `"TLSv1.1"` `"TLSv1.2"` `"TLSv1.3"`
type 字符串	使用 FortiGuard 消息服务或自定义电子邮件服务器。选项 `"custom"`
username 字符串	用于身份验证的 SMTP 服务器用户名。
validate_server 字符串	启用/禁用服务器证书验证。选项 `"enable"` `"disable"`
vdom 字符串	虚拟域，在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置和用作不同的单元。默认值： `"root"`

备注 

注意

旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方式。

示例 

- name: Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication
   features.
  fortinet.fortios.fortios_system_email_server:
      vdom: "{{ vdom }}"
      system_email_server:
          authenticate: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          password: "<your_own_value>"
          port: "25"
          reply_to: "<your_own_value>"
          security: "none"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          ssl_min_proto_version: "default"
          type: "custom"
          username: "<your_own_value>"
          validate_server: "enable"

返回值 

常见的返回值已记录在此处，以下是此模块特有的字段。

键	描述
build 字符串	FortiGate 镜像的版本号返回：始终示例： `"1547"`
http_method 字符串	上次用于将内容置备到 FortiGate 的方法返回：始终示例： `"PUT"`
http_status 字符串	FortiGate 在上次应用的操作中给出的最后结果返回：始终示例： `"200"`
mkey 字符串	上次调用 FortiGate 时使用的主密钥 (ID) 返回：成功示例： `"id"`
name 字符串	用于完成请求的表的名称返回：始终示例： `"urlfilter"`
path 字符串	用于完成请求的表的路径返回：始终示例： `"webfilter"`
revision 字符串	内部修订号返回：始终示例： `"17.0.2.10658"`
serial 字符串	设备的序列号返回：始终示例： `"FGVMEVYYQT3AB5352"`
status 字符串	操作结果的指示返回：始终示例： `"success"`
vdom 字符串	使用的虚拟域返回：始终示例： `"root"`
版本字符串	FortiGate 版本返回：始终示例： `"v5.6.3"`

作者

郑链 (@chillancezen)
薛杰 (@JieX19)
陆洪斌 (@fgtdev-hblu)
沈芳 (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)