fortinet.fortios.fortios_system_acme 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 ACME 客户端。

注意

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

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

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

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_system_acme

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备,允许用户设置和修改系统功能和 acme 类别。示例包括所有参数和值,需要在使用前调整为数据源。已使用 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"

system_acme

字典

配置 ACME 客户端。

accounts

列表 / 元素=字典

ACME 帐户列表。

ca_url

字符串

帐户 ca_url。

email

字符串

帐户电子邮件。

id

字符串 / 必需

帐户 ID。

privatekey

字符串

帐户私钥。

status

字符串

帐户状态。

url

字符串

帐户 URL。

interface

列表 / 元素=字典

ACME 客户端将在其上侦听质询的接口。

interface_name

字符串 / 必需

接口名称。源 system.interface.name。

source_ip

字符串

用于连接到 ACME 服务器的源 IPv4 地址。

source_ip6

字符串

用于连接到 ACME 服务器的源 IPv6 地址。

use_ha_direct

字符串

在 HA 配置中启用“ha-direct”时,启用使用“ha-mgmt”接口连接到 ACME 服务器

选择

  • "enable"

  • "disable"

vdom

字符串

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

默认值: "root"

注释

注意

  • 传统的 fortiosapi 已被弃用,httpapi 是运行 playbook 的首选方式

示例

- name: Configure ACME client.
  fortinet.fortios.fortios_system_acme:
      vdom: "{{ vdom }}"
      system_acme:
          accounts:
              -
                  ca_url: "<your_own_value>"
                  email: "<your_own_value>"
                  id: "6"
                  privatekey: "<your_own_value>"
                  status: "<your_own_value>"
                  url: "myurl.com"
          interface:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          use_ha_direct: "enable"

返回值

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

描述

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)