fortinet.fortios.fortios_system_replacemsg_image 模块 – 在 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_image。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 replacemsg_image 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值，需要在使用前调整为数据源。已使用 FOS v6.0.0 测试

要求

以下要求需要在执行此模块的主机上满足。

  • ansible>=2.15

参数

参数

注释

access_token

string

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

boolean

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

选项

  • false ←（默认）

  • true

member_path

string

要操作的成员属性路径。

如果存在多个属性，则用斜杠字符分隔。

标记为 member_path 的参数对于执行成员操作是合法的。

member_state

string

在指定的属性路径下添加或删除成员。

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

string / 必填

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

选项

  • "present"

  • "absent"

system_replacemsg_image

dictionary

配置替换消息图像。

image_base64

string

图像数据。

image_type

string

图像类型。

选项

  • "gif"

  • "jpg"

  • "tiff"

  • "png"

name

string / 必填

图像名称。

vdom

string

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

默认值： "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure replacement message images.
  fortinet.fortios.fortios_system_replacemsg_image:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_replacemsg_image:
          image_base64: "<your_own_value>"
          image_type: "gif"
          name: "default_name_5"

返回值

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

键

描述

build

string

Fortigate 映像的内部版本号

返回： 始终

示例： "1547"

http_method

string

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

返回： 始终

示例： "PUT"

http_status

string

上次 FortiGate 在上次应用的操作中给出的结果

返回： 始终

示例： "200"

mkey

string

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

返回： 成功

示例： "id"

name

string

用于满足请求的表的名称

返回： 始终

示例： "urlfilter"

path

string

用于满足请求的表的路径

返回： 始终

示例： "webfilter"

revision

string

内部修订号

返回： 始终

示例： "17.0.2.10658"

serial

string

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

string

指示操作的结果

返回： 始终

示例： "success"

vdom

string

使用的虚拟域

返回： 始终

示例： "root"

version

string

FortiGate 的版本

返回： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)