fortinet.fortios.fortios_extension_controller_extender_profile 模块 – Fortinet FortiOS 和 FortiGate 中的 FortiExtender 扩展器配置文件配置。

注意

此模块是 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_profile

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

extension_controller_extender_profile

字典

FortiExtender 扩展器配置文件配置。

allowaccess

列表 / elements=字符串

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

选项

  • "ping"

  • "telnet"

  • "http"

  • "https"

  • "ssh"

  • "snmp"

bandwidth_limit

整数

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

cellular

字典

FortiExtender 蜂窝配置。

controller_report

字典

FortiExtender 控制器报告配置。

interval

整数

控制器报告间隔。

signal_threshold

整数

控制器报告信号阈值。

status

字符串

FortiExtender 控制器报告状态。

选项

  • "disable"

  • "enable"

dataplan

列表 / elements=字典

数据计划名称。

name

字符串 / 必填

数据计划名称。源 extension-controller.dataplan.name。

modem1

字典

调制解调器 1 的配置选项。

auto_switch

字典

FortiExtender 自动切换配置。

dataplan

字符串

根据数据使用情况自动切换。

选项

  • "disable"

  • "enable"

disconnect

字符串

通过断开连接自动切换。

选项

  • "disable"

  • "enable"

disconnect_period

整数

根据断开连接时间自动切换。

disconnect_threshold

整数

根据断开连接阈值自动切换。

signal

字符串

根据信号强度自动切换。

选项

  • "disable"

  • "enable"

switch_back

列表 / elements=字符串

使用切换回多选项自动切换。

选项

  • "time"

  • "timer"

switch_back_time

字符串

在指定的时间(UTC HH:MM)自动切换到首选的 SIM/运营商。

switch_back_timer

整数

在给定的时间(3600 - 2147483647 秒)后自动切换到首选的 SIM/运营商。

default_sim

字符串

默认 SIM 卡选择。

选项

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

字符串

FortiExtender GPS 启用/禁用。

选项

  • "disable"

  • "enable"

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

列表 / elements=字符串

使用切换回多选项自动切换。

选项

  • "time"

  • "timer"

switch_back_time

字符串

在指定的时间(UTC HH:MM)自动切换到首选的 SIM/运营商。

switch_back_timer

整数

在给定的时间(3600 - 2147483647 秒)后自动切换到首选的 SIM/运营商。

default_sim

字符串

默认 SIM 卡选择。

选项

  • "sim1"

  • "sim2"

  • "carrier"

  • "cost"

gps

字符串

FortiExtender GPS 启用/禁用。

选项

  • "disable"

  • "enable"

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 卡

sms_notification

字典

FortiExtender 蜂窝 SMS 通知配置。

alert

字典

短信警报列表。

data_exhausted

字符串

数据耗尽时显示的字符串。

fgt_backup_mode_switch

字符串

切换 FortiGate 备份模式时显示的字符串。

low_signal_strength

字符串

信号强度低时显示的字符串。

mode_switch

字符串

切换模式时显示的字符串。

os_image_fallback

字符串

回退到以前的操作系统映像时显示的字符串。

session_disconnect

字符串

会话断开连接时显示的字符串。

system_reboot

字符串

系统重启时显示的字符串。

receiver

列表 / elements=字典

短信通知接收器列表。

alert

列表 / elements=字符串

警报多选项。

选项

  • "system-reboot"

  • "data-exhausted"

  • "session-disconnect"

  • "low-signal-strength"

  • "mode-switch"

  • "os-image-fallback"

  • "fgt-backup-mode-switch"

name

字符串 / 必填

FortiExtender 短信通知接收器名称。

phone_number

字符串

接收器电话号码。格式:[+][国家代码][区号][本地电话号码]。例如,+16501234567。

status

字符串

短信通知接收器状态。

选项

  • "disable"

  • "enable"

status

字符串

FortiExtender 短信通知状态。

选项

  • "disable"

  • "enable"

enforce_bandwidth

字符串

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

选项

  • "enable"

  • "disable"

extension

字符串

扩展选项。

选项

  • "wan-extension"

  • "lan-extension"

id

整数

ID。

lan_extension

字典

FortiExtender LAN 扩展配置。

backhaul

列表 / elements=字典

LAN 扩展回程隧道配置。

name

字符串 / 必填

FortiExtender LAN 扩展回程名称。

port

字符串

FortiExtender 上行链路端口。

选项

  • "wan"

  • "lte1"

  • "lte2"

  • "port1"

  • "port2"

  • "port3"

  • "port4"

  • "port5"

  • "sfp"

role

字符串

FortiExtender 上行链路端口。

选项

  • "primary"

  • "secondary"

weight

整数

WRR 权重参数。

backhaul_interface

字符串

IPsec 阶段 1 接口。源 system.interface.name。

backhaul_ip

字符串

IPsec 阶段 1 IPv4/FQDN。用于在 FortiGate 设备位于 NAT 设备后面时指定外部 IP/FQDN。

列表 / elements=字典

配置用于 LAN 扩展的 FortiExtender 下行链路接口。

字符串 / 必填

FortiExtender LAN 扩展下行链路配置条目名称。

字符串

FortiExtender LAN 扩展下行链路端口。

选项

  • "port1"

  • "port2"

  • "port3"

  • "port4"

  • "port5"

  • "lan1"

  • "lan2"

整数

FortiExtender LAN 扩展下行链路 PVID。

字符串

FortiExtender LAN 扩展下行链路类型 [port/vap]。

选项

  • "port"

  • "vap"

字符串

FortiExtender LAN 扩展下行链路 vap。源 extension-controller.extender-vap.name。

ipsec_tunnel

字符串

IPsec 隧道名称。

字符串

LAN 扩展链路负载平衡策略。

选项

  • "activebackup"

  • "loadbalance"

login_password

字符串

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

login_password_change

字符串

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

选项

  • "yes"

  • "default"

  • "no"

model

字符串

型号。

选项

  • "FX201E"

  • "FX211E"

  • "FX200F"

  • "FXA11F"

  • "FXE11F"

  • "FXA21F"

  • "FXE21F"

  • "FXA22F"

  • "FXE22F"

  • "FX212F"

  • "FX311F"

  • "FX312F"

  • "FX511F"

  • "FXR51G"

  • "FXN51G"

  • "FXW51G"

  • "FVG21F"

  • "FVA21F"

  • "FVG22F"

  • "FVA22F"

  • "FX04DA"

  • "FG"

  • "BS10FW"

  • "BS20GW"

  • "BS20GN"

name

字符串 / 必填

FortiExtender 配置文件名称。

wifi

字典

FortiExtender Wi-Fi 配置。

country

字符串

此 FEX 将运行的国家/地区。

选项

  • "--"

  • "AF"

  • "AL"

  • "DZ"

  • "AS"

  • "AO"

  • "AR"

  • "AM"

  • "AU"

  • "AT"

  • "AZ"

  • "BS"

  • "BH"

  • "BD"

  • "BB"

  • "BY"

  • "BE"

  • "BZ"

  • "BJ"

  • "BM"

  • "BT"

  • "BO"

  • "BA"

  • "BW"

  • "BR"

  • "BN"

  • "BG"

  • "BF"

  • "KH"

  • "CM"

  • "KY"

  • "CF"

  • "TD"

  • "CL"

  • "CN"

  • "CX"

  • "CO"

  • "CG"

  • "CD"

  • "CR"

  • "HR"

  • "CY"

  • "CZ"

  • "DK"

  • "DJ"

  • "DM"

  • "DO"

  • "EC"

  • "EG"

  • "SV"

  • "ET"

  • "EE"

  • "GF"

  • "PF"

  • "FO"

  • "FJ"

  • "FI"

  • "FR"

  • "GA"

  • "GE"

  • "GM"

  • "DE"

  • "GH"

  • "GI"

  • "GR"

  • "GL"

  • "GD"

  • "GP"

  • "GU"

  • "GT"

  • "GY"

  • "HT"

  • "HN"

  • "HK"

  • "HU"

  • "IS"

  • "IN"

  • "ID"

  • "IQ"

  • "IE"

  • "IM"

  • "IL"

  • "IT"

  • "CI"

  • "JM"

  • "JO"

  • "KZ"

  • "KE"

  • "KR"

  • "KW"

  • "LA"

  • "LV"

  • "LB"

  • "LS"

  • "LR"

  • "LY"

  • "LI"

  • "LT"

  • "LU"

  • "MO"

  • "MK"

  • "MG"

  • "MW"

  • "MY"

  • "MV"

  • "ML"

  • "MT"

  • "MH"

  • "MQ"

  • "MR"

  • "MU"

  • "YT"

  • "MX"

  • "FM"

  • "MD"

  • "MC"

  • "MN"

  • "MA"

  • "MZ"

  • "MM"

  • "NA"

  • "NP"

  • "NL"

  • "AN"

  • "AW"

  • "NZ"

  • "NI"

  • "NE"

  • "NG"

  • "NO"

  • "MP"

  • "OM"

  • "PK"

  • "PW"

  • "PA"

  • "PG"

  • "PY"

  • "PE"

  • "PH"

  • "PL"

  • "PT"

  • "PR"

  • "QA"

  • "RE"

  • "RO"

  • "RU"

  • "RW"

  • "BL"

  • "KN"

  • "LC"

  • "MF"

  • "PM"

  • "VC"

  • "SA"

  • "SN"

  • "RS"

  • "ME"

  • "SL"

  • "SG"

  • "SK"

  • "SI"

  • "SO"

  • "ZA"

  • "ES"

  • "LK"

  • "SR"

  • "SZ"

  • "SE"

  • "CH"

  • "TW"

  • "TZ"

  • "TH"

  • "TG"

  • "TT"

  • "TN"

  • "TR"

  • "TM"

  • "AE"

  • "TC"

  • "UG"

  • "UA"

  • "GB"

  • "US"

  • "PS"

  • "UY"

  • "UZ"

  • "VU"

  • "VE"

  • "VN"

  • "VI"

  • "WF"

  • "YE"

  • "ZM"

  • "ZW"

  • "JP"

  • "CA"

radio_1

字典

Wi-Fi 2.4GHz 的无线电 1 配置

band

字符串

Wi-Fi 频段选择 2.4GHz / 5GHz。

选项

  • "2.4GHz"

bandwidth

字符串

Wi-Fi 信道带宽。

选项

  • "auto"

  • "20MHz"

  • "40MHz"

  • "80MHz"

beacon_interval

整数

Wi-Fi 信标间隔,单位为毫秒 (100 - 3500)。

bss_color

整数

Wi-Fi 802.11AX BSS 颜色值(0 - 63,0 = 禁用)。

bss_color_mode

字符串

Wi-Fi 802.11AX BSS 颜色模式。

选项

  • "auto"

  • "static"

channel

列表 / elements=字符串

Wi-Fi 信道。

选项

  • "CH1"

  • "CH2"

  • "CH3"

  • "CH4"

  • "CH5"

  • "CH6"

  • "CH7"

  • "CH8"

  • "CH9"

  • "CH10"

  • "CH11"

extension_channel

字符串

Wi-Fi 扩展信道。

选项

  • "auto"

  • "higher"

  • "lower"

guard_interval

字符串

Wi-Fi 保护间隔。

选项

  • "auto"

  • "400ns"

  • "800ns"

lan_ext_vap

字符串

Wi-Fi LAN 扩展 VAP。仅选择一个 VAP。来源 extension-controller.extender-vap.name。

local_vaps

列表 / elements=字典

Wi-Fi 本地 VAP。最多选择三个 VAP。

name

字符串 / 必填

Wi-Fi 本地 VAP 名称。来源 extension-controller.extender-vap.name。

max_clients

整数

Wi-Fi 无线电客户端的最大数量(0 - 512,0 = 无限制)。

mode

字符串

Wi-Fi 无线电模式 AP(LAN 模式)/ Client(WAN 模式)。

选项

  • "AP"

  • "Client"

operating_standard

字符串

Wi-Fi 运行标准。

选项

  • "auto"

  • "11A-N-AC-AX"

  • "11A-N-AC"

  • "11A-N"

  • "11A"

  • "11N-AC-AX"

  • "11AC-AX"

  • "11AC"

  • "11N-AC"

  • "11B-G-N-AX"

  • "11B-G-N"

  • "11B-G"

  • "11B"

  • "11G-N-AX"

  • "11N-AX"

  • "11AX"

  • "11G-N"

  • "11N"

  • "11G"

power_level

整数

Wi-Fi 功率级别,以百分比表示(0 - 100,0 = 自动)。

set_80211d

字符串

启用/禁用 Wi-Fi 802.11d。

选项

  • "disable"

  • "enable"

status

字符串

启用/禁用 Wi-Fi 无线电。

选项

  • "disable"

  • "enable"

radio_2

字典

Wi-Fi 5GHz 的无线电 2 配置

band

字符串

Wi-Fi 频段选择 2.4GHz / 5GHz。

选项

  • "5GHz"

bandwidth

字符串

Wi-Fi 信道带宽。

选项

  • "auto"

  • "20MHz"

  • "40MHz"

  • "80MHz"

beacon_interval

整数

Wi-Fi 信标间隔,单位为毫秒 (100 - 3500)。

bss_color

整数

Wi-Fi 802.11AX BSS 颜色值(0 - 63,0 = 禁用)。

bss_color_mode

字符串

Wi-Fi 802.11AX BSS 颜色模式。

选项

  • "auto"

  • "static"

channel

列表 / elements=字符串

Wi-Fi 信道。

选项

  • "CH36"

  • "CH40"

  • "CH44"

  • "CH48"

  • "CH52"

  • "CH56"

  • "CH60"

  • "CH64"

  • "CH100"

  • "CH104"

  • "CH108"

  • "CH112"

  • "CH116"

  • "CH120"

  • "CH124"

  • "CH128"

  • "CH132"

  • "CH136"

  • "CH140"

  • "CH144"

  • "CH149"

  • "CH153"

  • "CH157"

  • "CH161"

  • "CH165"

extension_channel

字符串

Wi-Fi 扩展信道。

选项

  • "auto"

  • "higher"

  • "lower"

guard_interval

字符串

Wi-Fi 保护间隔。

选项

  • "auto"

  • "400ns"

  • "800ns"

lan_ext_vap

字符串

Wi-Fi LAN 扩展 VAP。仅选择一个 VAP。来源 extension-controller.extender-vap.name。

local_vaps

列表 / elements=字典

Wi-Fi 本地 VAP。最多选择三个 VAP。

name

字符串 / 必填

Wi-Fi 本地 VAP 名称。来源 extension-controller.extender-vap.name。

max_clients

整数

Wi-Fi 无线电客户端的最大数量(0 - 512,0 = 无限制)。

mode

字符串

Wi-Fi 无线电模式 AP(LAN 模式)/ Client(WAN 模式)。

选项

  • "AP"

  • "Client"

operating_standard

字符串

Wi-Fi 运行标准。

选项

  • "auto"

  • "11A-N-AC-AX"

  • "11A-N-AC"

  • "11A-N"

  • "11A"

  • "11N-AC-AX"

  • "11AC-AX"

  • "11AC"

  • "11N-AC"

  • "11B-G-N-AX"

  • "11B-G-N"

  • "11B-G"

  • "11B"

  • "11G-N-AX"

  • "11N-AX"

  • "11AX"

  • "11G-N"

  • "11N"

  • "11G"

power_level

整数

Wi-Fi 功率级别,以百分比表示(0 - 100,0 = 自动)。

set_80211d

字符串

启用/禁用 Wi-Fi 802.11d。

选项

  • "disable"

  • "enable"

status

字符串

启用/禁用 Wi-Fi 无线电。

选项

  • "disable"

  • "enable"

member_path

字符串

要操作的成员属性路径。

如果有多个属性,则用斜杠字符分隔。

标有 member_path 的参数可用于执行成员操作。

member_state

字符串

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

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

选项

  • "present"

  • "absent"

state

字符串 / 必填

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

注释

注意

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

示例

- name: FortiExtender extender profile configuration.
  fortinet.fortios.fortios_extension_controller_extender_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extension_controller_extender_profile:
          allowaccess: "ping"
          bandwidth_limit: "1024"
          cellular:
              controller_report:
                  interval: "300"
                  signal_threshold: "10"
                  status: "disable"
              dataplan:
                  -
                      name: "default_name_11 (source extension-controller.dataplan.name)"
              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"
                  default_sim: "sim1"
                  gps: "disable"
                  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"
                  default_sim: "sim1"
                  gps: "disable"
                  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>"
              sms_notification:
                  alert:
                      data_exhausted: "<your_own_value>"
                      fgt_backup_mode_switch: "<your_own_value>"
                      low_signal_strength: "<your_own_value>"
                      mode_switch: "<your_own_value>"
                      os_image_fallback: "<your_own_value>"
                      session_disconnect: "<your_own_value>"
                      system_reboot: "<your_own_value>"
                  receiver:
                      -
                          alert: "system-reboot"
                          name: "default_name_61"
                          phone_number: "<your_own_value>"
                          status: "disable"
                  status: "disable"
          enforce_bandwidth: "enable"
          extension: "wan-extension"
          id: "67"
          lan_extension:
              backhaul:
                  -
                      name: "default_name_70"
                      port: "wan"
                      role: "primary"
                      weight: "1"
              backhaul_interface: "<your_own_value> (source system.interface.name)"
              backhaul_ip: "<your_own_value>"
              downlinks:
                  -
                      name: "default_name_77"
                      port: "port1"
                      pvid: "0"
                      type: "port"
                      vap: "<your_own_value> (source extension-controller.extender-vap.name)"
              ipsec_tunnel: "<your_own_value>"
              link_loadbalance: "activebackup"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          model: "FX201E"
          name: "default_name_87"
          wifi:
              country: "--"
              radio_1:
                  band: "2.4GHz"
                  bandwidth: "auto"
                  beacon_interval: "100"
                  bss_color: "0"
                  bss_color_mode: "auto"
                  channel: "CH1"
                  extension_channel: "auto"
                  guard_interval: "auto"
                  lan_ext_vap: "<your_own_value> (source extension-controller.extender-vap.name)"
                  local_vaps:
                      -
                          name: "default_name_101 (source extension-controller.extender-vap.name)"
                  max_clients: "0"
                  mode: "AP"
                  operating_standard: "auto"
                  power_level: "100"
                  set_80211d: "disable"
                  status: "disable"
              radio_2:
                  band: "5GHz"
                  bandwidth: "auto"
                  beacon_interval: "100"
                  bss_color: "0"
                  bss_color_mode: "auto"
                  channel: "CH36"
                  extension_channel: "auto"
                  guard_interval: "auto"
                  lan_ext_vap: "<your_own_value> (source extension-controller.extender-vap.name)"
                  local_vaps:
                      -
                          name: "default_name_119 (source extension-controller.extender-vap.name)"
                  max_clients: "0"
                  mode: "AP"
                  operating_standard: "auto"
                  power_level: "100"
                  set_80211d: "disable"
                  status: "disable"

返回值

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

描述

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)