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

在 fortinet.fortios 2.0.0 中新增

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

extension_controller_extender

字典

扩展器控制器配置。

allowaccess

列表 / 元素=字符串

控制对受管扩展器的管理访问。用空格分隔条目。

选项

  • "ping"

  • "telnet"

  • "http"

  • "https"

  • "ssh"

  • "snmp"

authorized

字符串

FortiExtender 管理（启用或禁用）。

选项

  • "discovered"

  • "disable"

  • "enable"

bandwidth_limit

整数

FortiExtender LAN 扩展带宽限制 (Mbps)。

description

字符串

描述。

device_id

整数

设备 ID。

enforce_bandwidth

字符串

启用/禁用在 LAN 扩展接口上强制执行带宽。

选项

  • "enable"

  • "disable"

ext_name

字符串

FortiExtender 名称。

extension_type

字符串

此 FortiExtender 的扩展类型。

选项

  • "wan-extension"

  • "lan-extension"

firmware_provision_latest

字符串

启用/禁用最新固件版本的一次性自动配置。

选项

  • "disable"

  • "once"

id

字符串

FortiExtender 序列号。

login_password

字符串

设置受管扩展器的管理员密码。

login_password_change

字符串

更改或重置受管扩展器的管理员密码（是、默认或否）。

选项

  • "yes"

  • "default"

  • "no"

name

字符串 / 必需

FortiExtender 条目名称。

override_allowaccess

字符串

启用以覆盖扩展器配置文件管理访问配置。

选项

  • "enable"

  • "disable"

override_enforce_bandwidth

字符串

启用以覆盖扩展器配置文件 enforce-bandwidth 设置。

选项

  • "enable"

  • "disable"

override_login_password_change

字符串

启用以覆盖扩展器配置文件登录密码（管理员密码）设置。

选项

  • "enable"

  • "disable"

profile

字符串

FortiExtender 配置文件配置。源 extension-controller.extender-profile.name。

wan_extension

字典

FortiExtender wan 扩展配置。

modem1_extension

字符串

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

modem2_extension

字符串

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

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

备注

注意

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

示例

- name: Extender controller configuration.
  fortinet.fortios.fortios_extension_controller_extender:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extension_controller_extender:
          allowaccess: "ping"
          authorized: "discovered"
          bandwidth_limit: "1024"
          description: "<your_own_value>"
          device_id: "1026"
          enforce_bandwidth: "enable"
          ext_name: "<your_own_value>"
          extension_type: "wan-extension"
          firmware_provision_latest: "disable"
          id: "12"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          name: "default_name_15"
          override_allowaccess: "enable"
          override_enforce_bandwidth: "enable"
          override_login_password_change: "enable"
          profile: "<your_own_value> (source extension-controller.extender-profile.name)"
          wan_extension:
              modem1_extension: "<your_own_value> (source system.interface.name)"
              modem2_extension: "<your_own_value> (source system.interface.name)"

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

build

字符串

FortiGate 映像的内部版本号

已返回: 始终

示例: "1547"

http_method

字符串

用于将内容配置到 FortiGate 的最后方法

已返回: 始终

示例: "PUT"

http_status

字符串

FortiGate 在上次应用操作时给出的最后结果

已返回: 始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

已返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

已返回: 始终

示例: "urlfilter"

path

字符串

用于满足请求的表路径

已返回: 始终

示例: "webfilter"

修订版本

字符串

内部修订版本号

已返回: 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

已返回: 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

已返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

已返回: 始终

示例: "root"

版本

字符串

FortiGate 的版本

已返回: 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)