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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 external_resource 类别来配置 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_external_resource

字典

配置外部资源。

category

整数

用户资源类别。

comments

字符串

注释。

interface

字符串

指定到达服务器的出站接口。来源 system.interface.name。

interface_select_method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

name

字符串 / 必需

外部资源名称。

password

字符串

HTTP 基本身份验证密码。

refresh_rate

整数

刷新外部资源的时间间隔 (1 - 43200 分钟)。

resource

字符串

外部资源的 URL。

server_identity_check

字符串

证书验证选项。

选项

  • "none"

  • "basic"

  • "full"

source_ip

字符串

用于与服务器通信的源 IPv4 地址。

status

字符串

启用/禁用用户资源。

选项

  • "enable"

  • "disable"

type

字符串

用户资源类型。

选项

  • "category"

  • "address"

  • "domain"

  • "malware"

  • "mac-address"

  • "data"

update_method

字符串

外部资源更新方法。

选项

  • "feed"

  • "push"

user_agent

字符串

HTTP User-Agent 头。

username

字符串

HTTP 基本身份验证用户名。

uuid

字符串

通用唯一标识符 (UUID；自动分配，但可以手动重置)。

vdom

字符串

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

默认值： "root"

备注

注意

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

  • 此模块支持 check_mode。

示例

- name: Configure external resource.
  fortinet.fortios.fortios_system_external_resource:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_external_resource:
          category: "0"
          comments: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_7"
          password: "<your_own_value>"
          refresh_rate: "5"
          resource: "<your_own_value>"
          server_identity_check: "none"
          source_ip: "84.230.14.43"
          status: "enable"
          type: "category"
          update_method: "feed"
          user_agent: "<your_own_value>"
          username: "<your_own_value>"
          uuid: "<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)