fortinet.fortimanager.fmgr_system_mail 模块 – 警报邮件。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，在使用前需要将其调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构差异时才设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

system_mail

字典

设置的顶级参数。

auth

字符串

启用身份验证。

disable - 禁用身份验证。

enable - 启用身份验证。

选项

  • "disable"

  • "enable"

auth_type

别名：auth-type

字符串

SMTP 身份验证类型。

psk - 使用用户名和密码进行身份验证。

certificate - 使用本地证书进行身份验证。

选项

  • "psk"

  • "certificate"

from

字符串

MAIL FROM 的用户名。

id

字符串 / 必需

邮件服务 ID。

local_cert

别名：local-cert

字符串

SMTP 本地证书。

passwd

任意

(列表) SMTP 帐户密码。

port

整数

SMTP 服务器端口。

secure_option

别名：secure-option

字符串

通信安全选项。

default - 尝试 STARTTLS，否则继续作为纯文本通信。

none - 通信将采用纯文本格式。

smtps - 通信将由 SMTPS 保护。

starttls - 通信将由 STARTTLS 保护。

选项

  • "default"

  • "none"

  • "smtps"

  • "starttls"

server

字符串

SMTP 服务器。

ssl_protocol

别名：ssl-protocol

字符串

设置与邮件服务器连接的最低 SSL 协议版本。

follow-global-ssl-protocol - 遵循系统设置。

sslv3 - 将 SSLv3 设置为最低版本。

tlsv1.

tlsv1.

tlsv1.

tlsv1.

选项

  • "follow-global-ssl-protocol"

  • "sslv3"

  • "tlsv1.0"

  • "tlsv1.1"

  • "tlsv1.2"

  • "tlsv1.3"

user

字符串

SMTP 帐户用户名。

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，值可以是全局的和其他值，包括 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 有助于完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。

示例

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Alert emails.
      fortinet.fortimanager.fmgr_system_mail:
        bypass_validation: false
        state: present
        system_mail:
          auth: enable
          id: 1
          passwd: fortinet
          port: 1
          secure-option: none # <value in [default, none, smtps, ...]>
          server: ALL
          user: ansible

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the alert emails
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_mail"
          params:
            mail: "your_value"

返回值

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

键

描述

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)