fortinet.fortios.fortios_certificate_remote 模块 – 在 Fortinet FortiOS 和 FortiGate 中使用 PEM 格式的远程证书。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_certificate_remote。

fortinet.fortios 2.0.0 中的新功能

概要

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

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

certificate_remote

字典

PEM 格式的远程证书。

name

字符串 / 必需

名称。

range

字符串

远程证书的全局或 VDOM IP 地址范围。

选择

  • "global"

  • "vdom"

remote

字符串

远程证书。

source

字符串

远程证书源类型。

选择

  • "factory"

  • "user"

  • "bundle"

enable_log

布尔值

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

选择

  • false ←（默认）

  • true

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选择

  • "present"

  • "absent"

state

字符串 / 必需

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

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Remote certificate as a PEM file.
  fortinet.fortios.fortios_certificate_remote:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      certificate_remote:
          name: "default_name_3"
          range: "global"
          remote: "<your_own_value>"
          source: "factory"

返回值

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

键

描述

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)