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。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在剧本中使用它，请指定： 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 是运行剧本的首选方法。

  • 此模块支持 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"

serial

字符串

设备序列号

返回：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回：始终

示例： "root"

version

字符串

FortiGate 版本

返回：始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪宾 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)