fortinet.fortios.fortios_system_replacemsg_group 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置替换消息组。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

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

fortinet.fortios 2.0.0 中的新增功能

概要

• 此模块能够通过允许用户设置和修改系统功能和 replacemsg_group 类别来配置 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_group 字典	配置替换消息组。
admin 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
alertmail 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
auth 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
automation 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
comment 字符串	注释。
custom_message 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
device_detection_portal 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
ec 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
fortiguard_wf 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
ftp 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
group_type 字符串	组类型。 选择 "default" "utm" "auth" "ec"
http 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
icap 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
mail 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
mm1 列表 / elements=字典	替换消息表条目。
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 字符串	主题文本字符串
mm3 列表 / elements=字典	替换消息表条目。
add_html 字符串	添加消息封装 选择 "enable" "disable"
charset 字符串	用于替换消息的字符编码 选择 "utf-8" "us-ascii"
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
fos_message 字符串	消息文本
from 字符串	发件人地址
from_sender 字符串	从收件人发送的通知消息 选择 "enable" "disable"
header 字符串	标头标志。 选择 "none" "http" "8bit"
html_part 字符串	消息封装文本
image 字符串	消息字符串。源 system.replacemsg-image.name。
msg_type 字符串 / 必需	消息类型。
priority 字符串	消息优先级 选择 "not-included" "low" "normal" "high"
subject 字符串	主题文本字符串
mm4 列表 / elements=字典	替换消息表条目。
add_smil 字符串	添加消息封装 选择 "enable" "disable"
charset 字符串	用于替换消息的字符编码 选择 "utf-8" "us-ascii"
class 字符串	消息类 选择 "not-included" "personal" "informational" "advertisement" "auto"
domain 字符串	发件人地址域
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-net-prob" "err-content-not-accept" "err-unsupp-msg"
smil_part 字符串	消息封装文本
subject 字符串	主题文本字符串
mm7 列表 / elements=字典	替换消息表条目。
add_smil 字符串	添加消息封装 选择 "enable" "disable"
addr_type 字符串	发件人地址类型 选择 "rfc2822-addr" "number" "short-code"
allow_content_adaptation 字符串	允许内容改编 选择 "enable" "disable"
charset 字符串	用于替换消息的字符编码 选择 "utf-8" "us-ascii"
class 字符串	消息类 选择 "not-included" "personal" "informational" "advertisement" "auto"
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 字符串	响应状态 选择 "success" "partial-success" "client-err" "oper-restrict" "addr-err" "addr-not-found" "content-refused" "msg-id-not-found" "link-id-not-found" "msg-fmt-corrupt" "app-id-not-found" "repl-app-id-not-found" "srv-err" "not-possible" "msg-rejected" "multiple-addr-not-supp" "app-addr-not-supp" "gen-service-err" "improper-ident" "unsupp-ver" "unsupp-oper" "validation-err" "service-err" "service-unavail" "service-denied" "app-denied"
smil_part 字符串	消息封装文本
subject 字符串	主题文本字符串
mms 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
charset 字符串	用于替换消息的字符编码 选择 "utf-8" "us-ascii"
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
image 字符串	消息字符串。源 system.replacemsg-image.name。
msg_type 字符串 / 必需	消息类型。
nac_quar 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
name 字符串 / 必需	组名称。
nntp 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
spam 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
sslvpn 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
traffic_quota 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
utm 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
webproxy 列表 / elements=字典	替换消息表条目。
buffer 字符串	消息字符串。
format 字符串	格式标志。 选择 "none" "text" "html" "wml"
header 字符串	标头标志。 选择 "none" "http" "8bit"
msg_type 字符串 / 必需	消息类型。
vdom 字符串	虚拟域，在先前定义的那些中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： "root"

备注

注意

• 遗留 fortiosapi 已被弃用，httpapi 是运行剧本的首选方式

• 该模块支持 check_mode。

示例

- name: Configure replacement message groups.
  fortinet.fortios.fortios_system_replacemsg_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_group:
          admin:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          alertmail:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          auth:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          automation:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          comment: "Comment."
          custom_message:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          device_detection_portal:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          ec:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          fortiguard_wf:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          ftp:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          group_type: "default"
          http:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          icap:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          mail:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          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>"
          mm3:
              -
                  add_html: "enable"
                  charset: "utf-8"
                  format: "none"
                  fos_message: "<your_own_value>"
                  from: "<your_own_value>"
                  from_sender: "enable"
                  header: "none"
                  html_part: "<your_own_value>"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
                  priority: "not-included"
                  subject: "<your_own_value>"
          mm4:
              -
                  add_smil: "enable"
                  charset: "utf-8"
                  class: "not-included"
                  domain: "<your_own_value>"
                  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"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mm7:
              -
                  add_smil: "enable"
                  addr_type: "rfc2822-addr"
                  allow_content_adaptation: "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: "success"
                  smil_part: "<your_own_value>"
                  subject: "<your_own_value>"
          mms:
              -
                  buffer: "<your_own_value>"
                  charset: "utf-8"
                  format: "none"
                  header: "none"
                  image: "<your_own_value> (source system.replacemsg-image.name)"
                  msg_type: "<your_own_value>"
          nac_quar:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          name: "default_name_140"
          nntp:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          spam:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          sslvpn:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          traffic_quota:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          utm:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<your_own_value>"
          webproxy:
              -
                  buffer: "<your_own_value>"
                  format: "none"
                  header: "none"
                  msg_type: "<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"
serial 字符串	设备的序列号 返回： 总是 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果的指示 返回： 总是 示例： "success"
vdom 字符串	使用的虚拟域 返回： 总是 示例： "root"
version 字符串	FortiGate 的版本 返回： 总是 示例： "v5.6.3"

作者

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

集合链接

• 问题跟踪器
• 主页
• 仓库 (源代码)