fortinet.fortimanager.fmgr_devprof_system_emailserver 模块 – 配置 FortiGate 使用的电子邮件服务器用于各种用途。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_devprof_system_emailserver。

fortinet.fortimanager 1.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包含所有需要在使用前根据数据源调整的参数和值。

参数 

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。选项 `false` ← (默认) `true`
devprof 字符串 / 必需	请求 URL 中的参数 (devprof)。
devprof_system_emailserver 字典	设置的顶级参数。
authenticate 字符串	启用/禁用身份验证。选项 `"disable"` `"enable"`
interface 字符串	指定用于访问服务器的出站接口。
interface_select_method 别名：interface-select-method 字符串	指定如何选择用于访问服务器的出站接口。选项 `"auto"` `"sdwan"` `"specify"`
password 任意	(列表) SMTP 服务器用户密码用于身份验证。
port 整数	SMTP 服务器端口。
reply_to 别名：reply-to 字符串	回复邮件地址。
security 字符串	电子邮件服务器使用的连接安全性。选项 `"none"` `"starttls"` `"smtps"`
server 字符串	SMTP 服务器 IP 地址或主机名。
source_ip 别名：source-ip 字符串	SMTP 服务器 IPv4 源 IP。
source_ip6 别名：source-ip6 字符串	SMTP 服务器 IPv6 源 IP。
ssl_min_proto_version 别名：ssl-min-proto-version 字符串	SSL/TLS 连接支持的最低协议版本选项 `"default"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1-3"`
type 字符串	使用 FortiGuard 消息服务或自定义电子邮件服务器。选项 `"custom"`
username 字符串	SMTP 服务器用户名用于身份验证。
validate_server 别名：validate-server 字符串	启用/禁用服务器证书验证。选项 `"disable"` `"enable"`
enable_log 布尔值	启用/禁用任务日志记录。选项 `false` ← (默认) `true`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。选项 `"update"` `"set"` `"add"`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
workspace_locking_adom 字符串	在工作区模式下运行 FortiManager 时要锁定的 adom，值可以是 global 和其他包括 root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁的最大时间（秒）。默认值： `300`

备注 

注意

从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
通常情况下，如果返回非零 rc 值，则运行一个模块可能会失败。您也可以使用参数 `rc_failed` 和 `rc_succeeded` 覆盖失败或成功的条件。

示例 

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure the email server used by the FortiGate various things.
      fortinet.fortimanager.fmgr_devprof_system_emailserver:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_system_emailserver:
          authenticate: <value in [disable, enable]>
          password: <list or string>
          port: <integer>
          reply_to: <string>
          security: <value in [none, starttls, smtps]>
          server: <string>
          source_ip: <string>
          source_ip6: <string>
          ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]>
          type: <value in [custom]>
          username: <string>
          validate_server: <value in [disable, enable]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>

返回值 

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

键	描述
meta 字典	请求的结果。返回：始终
request_url 字符串	请求的完整 URL。返回：始终示例： `"/sys/login/user"`
response_code 整数	API 请求的状态。返回：始终示例： `0`
response_data 列表 / 元素=字符串	API 响应。返回：始终
response_message 字符串	API 响应的描述性消息。返回：始终示例： `"OK."`
system_information 字典	目标系统的信息。返回：始终
rc 整数	请求的状态。返回：始终示例： `0`
version_check_warning 列表 / 元素=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。返回：复杂类型

作者

杜欣伟 (@dux-fortinet)
李兴 (@lix-fortinet)
薛杰 (@JieX19)
郑琳 (@chillancezen)
沈芳 (@fshen01)
卢洪斌 (@fgtdev-hblu)