fortinet.fortios.fortios_extender_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_extender_controller_extender。

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
extender_controller_extender 字典	扩展器控制器配置。
aaa_shared_secret 字符串	AAA 共享密钥。
access_point_name 字符串	接入点名称 (APN)。
admin 字符串	FortiExtender 管理 (启用或禁用)。 选项 "disable" "discovered" "enable"
allowaccess 列表 / 元素=字符串	控制对受管理扩展器的管理访问。用空格分隔条目。 选项 "ping" "telnet" "http" "https" "ssh" "snmp"
at_dial_script 字符串	特定于调制解调器的初始化 AT 命令。
authorized 字符串	FortiExtender 管理 (启用或禁用)。 选项 "disable" "enable"
bandwidth_limit 整数	FortiExtender LAN 扩展带宽限制 (Mbps)。
billing_start_day 整数	计费开始日。
cdma_aaa_spi 字符串	CDMA AAA SPI。
cdma_ha_spi 字符串	CDMA HA SPI。
cdma_nai 字符串	CDMA 调制解调器的 NAI。
conn_status 整数	连接状态。
controller_report 字典	FortiExtender 控制器报告配置。
interval 整数	控制器报告间隔。
signal_threshold 整数	控制器报告信号阈值。
status 字符串	FortiExtender 控制器报告状态。 选项 "disable" "enable"
description 字符串	描述。
device_id 整数	设备 ID。
dial_mode 字符串	拨号模式（按需拨号或始终连接）。 选项 "dial-on-demand" "always-connect"
dial_status 整数	拨号状态。
enforce_bandwidth 字符串	启用/禁用对 LAN 扩展接口上的带宽的强制执行。 选项 "enable" "disable"
ext_name 字符串	FortiExtender 名称。
extension_type 字符串	此 FortiExtender 的扩展类型。 选项 "wan-extension" "lan-extension"
ha_shared_secret 字符串	HA 共享密钥。
id 字符串	FortiExtender 序列号。
ifname 字符串	FortiExtender 接口名称。源系统.接口.名称。
initiated_update 字符串	允许/不允许网络启动对调制解调器的更新。 选项 "enable" "disable"
login_password 字符串	设置受管理扩展器的管理员密码。
login_password_change 字符串	更改或重置受管理扩展器的管理员密码（是、默认或否）。 选项 "yes" "default" "no"
mode 字符串	FortiExtender 模式。 选项 "standalone" "redundant"
modem1 字典	调制解调器 1 的配置选项。
auto_switch 字典	FortiExtender 自动切换配置。
dataplan 字符串	根据数据使用情况自动切换。 选项 "disable" "enable"
disconnect 字符串	通过断开连接自动切换。 选项 "disable" "enable"
disconnect_period 整数	根据断开连接时间自动切换。
disconnect_threshold 整数	根据断开连接阈值自动切换。
signal 字符串	根据信号强度自动切换。 选项 "disable" "enable"
switch_back 列表 / 元素=字符串	带回切多选项的自动切换。 选项 "time" "timer"
switch_back_time 字符串	在指定的 UTC 时间 (HH:MM) 自动切换到首选 SIM 卡/运营商。
switch_back_timer 整数	在给定时间 (3600 - 2147483647 秒) 后自动切换到首选 SIM 卡/运营商。
conn_status 整数	连接状态。
default_sim 字符串	默认 SIM 卡选择。 选项 "sim1" "sim2" "carrier" "cost"
gps 字符串	FortiExtender GPS 启用/禁用。 选项 "disable" "enable"
ifname 字符串	FortiExtender 接口名称。源系统.接口.名称。
preferred_carrier 字符串	首选运营商。
redundant_intf 字符串	冗余接口。
redundant_mode 字符串	FortiExtender 模式。 选项 "disable" "enable"
sim1_pin 字符串	SIM 卡 选项 "disable" "enable"
sim1_pin_code 字符串	SIM 卡
sim2_pin 字符串	SIM 卡 选项 "disable" "enable"
sim2_pin_code 字符串	SIM 卡
modem2 字典	调制解调器 2 的配置选项。
auto_switch 字典	FortiExtender 自动切换配置。
dataplan 字符串	根据数据使用情况自动切换。 选项 "disable" "enable"
disconnect 字符串	通过断开连接自动切换。 选项 "disable" "enable"
disconnect_period 整数	根据断开连接时间自动切换。
disconnect_threshold 整数	根据断开连接阈值自动切换。
signal 字符串	根据信号强度自动切换。 选项 "disable" "enable"
switch_back 列表 / 元素=字符串	带回切多选项的自动切换。 选项 "time" "timer"
switch_back_time 字符串	在指定的 UTC 时间 (HH:MM) 自动切换到首选 SIM 卡/运营商。
switch_back_timer 整数	在给定时间 (3600 - 2147483647 秒) 后自动切换到首选 SIM 卡/运营商。
conn_status 整数	连接状态。
default_sim 字符串	默认 SIM 卡选择。 选项 "sim1" "sim2" "carrier" "cost"
gps 字符串	FortiExtender GPS 启用/禁用。 选项 "disable" "enable"
ifname 字符串	FortiExtender 接口名称。源系统.接口.名称。
preferred_carrier 字符串	首选运营商。
redundant_intf 字符串	冗余接口。
redundant_mode 字符串	FortiExtender 模式。 选项 "disable" "enable"
sim1_pin 字符串	SIM 卡 选项 "disable" "enable"
sim1_pin_code 字符串	SIM 卡
sim2_pin 字符串	SIM 卡 选项 "disable" "enable"
sim2_pin_code 字符串	SIM 卡
modem_passwd 字符串	调制解调器密码。
modem_type 字符串	调制解调器类型 (CDMA、GSM/LTE 或 WiMAX)。 选项 "cdma" "gsm/lte" "wimax"
multi_mode 字符串	调制解调器的运行模式 (3G、LTE 等)。 选项 "auto" "auto-3g" "force-lte" "force-3g" "force-2g"
name 字符串 / 必需	FortiExtender 条目名称。
override_allowaccess 字符串	启用以覆盖扩展器配置文件管理访问配置。 选项 "enable" "disable"
override_enforce_bandwidth 字符串	启用以覆盖扩展器配置文件强制执行带宽设置。 选项 "enable" "disable"
override_login_password_change 字符串	启用以覆盖扩展器配置文件登录密码（管理员密码）设置。 选项 "enable" "disable"
ppp_auth_protocol 字符串	PPP 身份验证协议 (PAP、CHAP 或 auto)。 选项 "auto" "pap" "chap"
ppp_echo_request 字符串	启用/禁用 PPP 回显请求。 选项 "enable" "disable"
ppp_password 字符串	PPP 密码。
ppp_username 字符串	PPP 用户名。
primary_ha 字符串	主 HA。
profile 字符串	FortiExtender 配置文件配置。源扩展器控制器.扩展器配置文件.名称。
quota_limit_mb 整数	每月配额限制 (MB)。
redial 字符串	根据失败尝试允许的重拨次数。 选项 "none" "1" "2" "3" "4" "5" "6" "7" "8" "9" "10"
redundant_intf 字符串	冗余接口。
roaming 字符串	启用/禁用调制解调器漫游。 选项 "enable" "disable"
role 字符串	FortiExtender 工作角色（主、辅助、无）。 选项 "none" "primary" "secondary"
secondary_ha 字符串	辅助 HA。
sim_pin 字符串	SIM 卡 PIN。
vdom 整数	VDOM。
wan_extension 字典	FortiExtender WAN 扩展配置。
modem1_extension 字符串	FortiExtender 接口名称。源系统.接口.名称。
modem2_extension 字符串	FortiExtender 接口名称。源系统.接口.名称。
wimax_auth_protocol 字符串	WiMax 身份验证协议 (TLS 或 TTLS)。 选项 "tls" "ttls"
wimax_carrier 字符串	WiMax 运营商。
wimax_realm 字符串	WiMax 领域。
member_path 字符串	要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 当指定 `member_state` 时，`state` 选项将被忽略。 选项 “present” “absent”
state 字符串 / 必需	指示是创建还是删除对象。 选项 “present” “absent”
vdom 字符串	虚拟域，在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： "root"

备注

注意

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

• 该模块支持 check_mode。

示例

- name: Extender controller configuration.
  fortinet.fortios.fortios_extender_controller_extender:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_extender:
          aaa_shared_secret: "<your_own_value>"
          access_point_name: "<your_own_value>"
          admin: "disable"
          allowaccess: "ping"
          at_dial_script: "<your_own_value>"
          authorized: "disable"
          bandwidth_limit: "1024"
          billing_start_day: "14"
          cdma_aaa_spi: "<your_own_value>"
          cdma_ha_spi: "<your_own_value>"
          cdma_nai: "<your_own_value>"
          conn_status: "2147483647"
          controller_report:
              interval: "300"
              signal_threshold: "10"
              status: "disable"
          description: "<your_own_value>"
          device_id: "1024"
          dial_mode: "dial-on-demand"
          dial_status: "2147483647"
          enforce_bandwidth: "enable"
          ext_name: "<your_own_value>"
          extension_type: "wan-extension"
          ha_shared_secret: "<your_own_value>"
          id: "27"
          ifname: "<your_own_value> (source system.interface.name)"
          initiated_update: "enable"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          mode: "standalone"
          modem_passwd: "<your_own_value>"
          modem_type: "cdma"
          modem1:
              auto_switch:
                  dataplan: "disable"
                  disconnect: "disable"
                  disconnect_period: "600"
                  disconnect_threshold: "3"
                  signal: "disable"
                  switch_back: "time"
                  switch_back_time: "<your_own_value>"
                  switch_back_timer: "86400"
              conn_status: "0"
              default_sim: "sim1"
              gps: "disable"
              ifname: "<your_own_value> (source system.interface.name)"
              preferred_carrier: "<your_own_value>"
              redundant_intf: "<your_own_value>"
              redundant_mode: "disable"
              sim1_pin: "disable"
              sim1_pin_code: "<your_own_value>"
              sim2_pin: "disable"
              sim2_pin_code: "<your_own_value>"
          modem2:
              auto_switch:
                  dataplan: "disable"
                  disconnect: "disable"
                  disconnect_period: "600"
                  disconnect_threshold: "3"
                  signal: "disable"
                  switch_back: "time"
                  switch_back_time: "<your_own_value>"
                  switch_back_timer: "86400"
              conn_status: "0"
              default_sim: "sim1"
              gps: "disable"
              ifname: "<your_own_value> (source system.interface.name)"
              preferred_carrier: "<your_own_value>"
              redundant_intf: "<your_own_value>"
              redundant_mode: "disable"
              sim1_pin: "disable"
              sim1_pin_code: "<your_own_value>"
              sim2_pin: "disable"
              sim2_pin_code: "<your_own_value>"
          multi_mode: "auto"
          name: "default_name_78"
          override_allowaccess: "enable"
          override_enforce_bandwidth: "enable"
          override_login_password_change: "enable"
          ppp_auth_protocol: "auto"
          ppp_echo_request: "enable"
          ppp_password: "<your_own_value>"
          ppp_username: "<your_own_value>"
          primary_ha: "<your_own_value>"
          profile: "<your_own_value> (source extender-controller.extender-profile.name)"
          quota_limit_mb: "5242880"
          redial: "none"
          redundant_intf: "<your_own_value>"
          roaming: "enable"
          role: "none"
          secondary_ha: "<your_own_value>"
          sim_pin: "<your_own_value>"
          vdom: "0"
          wan_extension:
              modem1_extension: "<your_own_value> (source system.interface.name)"
              modem2_extension: "<your_own_value> (source system.interface.name)"
          wimax_auth_protocol: "tls"
          wimax_carrier: "<your_own_value>"
          wimax_realm: "<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)

• 尼古拉斯·托马斯 (@thomnico)

资源链接

• 问题追踪器
• 主页
• 代码库 (源代码)