fortinet.fortios.fortios_system_replacemsg_mm1 模块 – 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_replacemsg_mm1。

fortinet.fortios 2.0.0 中的新功能

概要

  • 此模块能够通过允许用户设置和修改 system_replacemsg 功能和 mm1 类别来配置 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"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_replacemsg_mm1

字典

替换消息。

add_smil

字符串

添加消息封装

选项

  • "enable"

  • "disable"

charset

字符串

用于替换消息的字符编码

选项

  • "utf-8"

  • "us-ascii"

class

字符串

消息类

选项

  • "not-included"

  • "personal"

  • "advertisement"

  • "information"

  • "automatic"

format

字符串

格式标志。

选项

  • "none"

  • "text"

  • "html"

  • "wml"

fos_message

字符串

消息文本

from

字符串

发件人地址

from_sender

字符串

从收件人发送的通知消息

选项

  • "enable"

  • "disable"

header

字符串

标头标志。

选项

  • "none"

  • "http"

  • "8bit"

image

字符串

消息字符串。来源 system.replacemsg-image.name。

msg_type

字符串 / 必需

消息类型。

priority

字符串

消息优先级

选项

  • "not-included"

  • "low"

  • "normal"

  • "high"

rsp_status

字符串

响应状态代码

选项

  • "ok"

  • "err-unspecified"

  • "err-srv-denied"

  • "err-msg-fmt-corrupt"

  • "err-snd-addr-unresolv"

  • "err-msg-not-found"

  • "err-net-prob"

  • "err-content-not-accept"

  • "err-unsupp-msg"

rsp_text

字符串

响应文本

sender_visibility

字符串

发件人可见性

选项

  • "not-specified"

  • "show"

  • "hide"

smil_part

字符串

消息封装文本

subject

字符串

主题文本字符串

vdom

字符串

虚拟域，在之前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认值： "root"

注意

注意

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

  • 该模块支持 check_mode。

示例

- name: Replacement messages.
  fortinet.fortios.fortios_system_replacemsg_mm1:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_mm1:
          add_smil: "enable"
          charset: "utf-8"
          class: "not-included"
          format: "none"
          fos_message: "<your_own_value>"
          from: "<your_own_value>"
          from_sender: "enable"
          header: "none"
          image: "<your_own_value> (source system.replacemsg-image.name)"
          msg_type: "<your_own_value>"
          priority: "not-included"
          rsp_status: "ok"
          rsp_text: "<your_own_value>"
          sender_visibility: "not-specified"
          smil_part: "<your_own_value>"
          subject: "<your_own_value>"

返回值

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

键

描述

build

字符串

Fortigate 映像的构建号

返回： 始终

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 中的方法

返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用操作时给出的最后结果

返回： 始终

示例： "200"

mkey

字符串

在上次调用 FortiGate 时使用的主密钥 (id)

返回： 成功

示例： "id"

name

字符串

用于满足请求的表的名称

返回： 始终

示例： "urlfilter"

path

字符串

用于满足请求的表的路径

返回： 始终

示例： "webfilter"

revision

字符串

内部修订号

返回： 始终

示例： "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

版本

字符串

FortiGate 的版本

返回： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)