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
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
FortiExtender 扩展器配置文件配置。 |
|
控制对受管扩展器的管理访问。用空格分隔条目。 选项
|
|
FortiExtender LAN 扩展带宽限制(Mbps)。 |
|
FortiExtender 蜂窝配置。 |
|
FortiExtender 控制器报告配置。 |
|
控制器报告间隔。 |
|
控制器报告信号阈值。 |
|
FortiExtender 控制器报告状态。 选项
|
|
数据计划名称。 |
|
数据计划名称。源 extension-controller.dataplan.name。 |
|
调制解调器 1 的配置选项。 |
|
FortiExtender 自动切换配置。 |
|
根据数据使用情况自动切换。 选项
|
|
通过断开连接自动切换。 选项
|
|
根据断开连接时间自动切换。 |
|
根据断开连接阈值自动切换。 |
|
根据信号强度自动切换。 选项
|
|
使用切换回多选项自动切换。 选项
|
|
在指定的时间(UTC HH:MM)自动切换到首选的 SIM/运营商。 |
|
在给定的时间(3600 - 2147483647 秒)后自动切换到首选的 SIM/运营商。 |
|
默认 SIM 卡选择。 选项
|
|
FortiExtender GPS 启用/禁用。 选项
|
|
首选运营商。 |
|
冗余接口。 |
|
FortiExtender 模式。 选项
|
|
SIM 卡 选项
|
|
SIM 卡 |
|
SIM 卡 选项
|
|
SIM 卡 |
|
调制解调器 2 的配置选项。 |
|
FortiExtender 自动切换配置。 |
|
根据数据使用情况自动切换。 选项
|
|
通过断开连接自动切换。 选项
|
|
根据断开连接时间自动切换。 |
|
根据断开连接阈值自动切换。 |
|
根据信号强度自动切换。 选项
|
|
使用切换回多选项自动切换。 选项
|
|
在指定的时间(UTC HH:MM)自动切换到首选的 SIM/运营商。 |
|
在给定的时间(3600 - 2147483647 秒)后自动切换到首选的 SIM/运营商。 |
|
默认 SIM 卡选择。 选项
|
|
FortiExtender GPS 启用/禁用。 选项
|
|
首选运营商。 |
|
冗余接口。 |
|
FortiExtender 模式。 选项
|
|
SIM 卡 选项
|
|
SIM 卡 |
|
SIM 卡 选项
|
|
SIM 卡 |
|
FortiExtender 蜂窝 SMS 通知配置。 |
|
短信警报列表。 |
|
数据耗尽时显示的字符串。 |
|
切换 FortiGate 备份模式时显示的字符串。 |
|
信号强度低时显示的字符串。 |
|
切换模式时显示的字符串。 |
|
回退到以前的操作系统映像时显示的字符串。 |
|
会话断开连接时显示的字符串。 |
|
系统重启时显示的字符串。 |
|
短信通知接收器列表。 |
|
警报多选项。 选项
|
|
FortiExtender 短信通知接收器名称。 |
|
接收器电话号码。格式:[+][国家代码][区号][本地电话号码]。例如,+16501234567。 |
|
短信通知接收器状态。 选项
|
|
FortiExtender 短信通知状态。 选项
|
|
启用/禁用在 LAN 扩展接口上强制执行带宽。 选项
|
|
扩展选项。 选项
|
|
ID。 |
|
FortiExtender LAN 扩展配置。 |
|
LAN 扩展回程隧道配置。 |
|
FortiExtender LAN 扩展回程名称。 |
|
FortiExtender 上行链路端口。 选项
|
|
FortiExtender 上行链路端口。 选项
|
|
WRR 权重参数。 |
|
IPsec 阶段 1 接口。源 system.interface.name。 |
|
IPsec 阶段 1 IPv4/FQDN。用于在 FortiGate 设备位于 NAT 设备后面时指定外部 IP/FQDN。 |
|
配置用于 LAN 扩展的 FortiExtender 下行链路接口。 |
|
FortiExtender LAN 扩展下行链路配置条目名称。 |
|
FortiExtender LAN 扩展下行链路端口。 选项
|
|
FortiExtender LAN 扩展下行链路 PVID。 |
|
FortiExtender LAN 扩展下行链路类型 [port/vap]。 选项
|
|
FortiExtender LAN 扩展下行链路 vap。源 extension-controller.extender-vap.name。 |
|
IPsec 隧道名称。 |
|
LAN 扩展链路负载平衡策略。 选项
|
|
设置受管扩展器的管理员密码。 |
|
更改或重置受管扩展器的管理员密码(是、默认或否)。 选项
|
|
型号。 选项
|
|
FortiExtender 配置文件名称。 |
|
FortiExtender Wi-Fi 配置。 |
|
此 FEX 将运行的国家/地区。 选项
|
|
Wi-Fi 2.4GHz 的无线电 1 配置 |
|
Wi-Fi 频段选择 2.4GHz / 5GHz。 选项
|
|
Wi-Fi 信道带宽。 选项
|
|
Wi-Fi 信标间隔,单位为毫秒 (100 - 3500)。 |
|
Wi-Fi 802.11AX BSS 颜色值(0 - 63,0 = 禁用)。 |
|
Wi-Fi 802.11AX BSS 颜色模式。 选项
|
|
Wi-Fi 信道。 选项
|
|
Wi-Fi 扩展信道。 选项
|
|
Wi-Fi 保护间隔。 选项
|
|
Wi-Fi LAN 扩展 VAP。仅选择一个 VAP。来源 extension-controller.extender-vap.name。 |
|
Wi-Fi 本地 VAP。最多选择三个 VAP。 |
|
Wi-Fi 本地 VAP 名称。来源 extension-controller.extender-vap.name。 |
|
Wi-Fi 无线电客户端的最大数量(0 - 512,0 = 无限制)。 |
|
Wi-Fi 无线电模式 AP(LAN 模式)/ Client(WAN 模式)。 选项
|
|
Wi-Fi 运行标准。 选项
|
|
Wi-Fi 功率级别,以百分比表示(0 - 100,0 = 自动)。 |
|
启用/禁用 Wi-Fi 802.11d。 选项
|
|
启用/禁用 Wi-Fi 无线电。 选项
|
|
Wi-Fi 5GHz 的无线电 2 配置 |
|
Wi-Fi 频段选择 2.4GHz / 5GHz。 选项
|
|
Wi-Fi 信道带宽。 选项
|
|
Wi-Fi 信标间隔,单位为毫秒 (100 - 3500)。 |
|
Wi-Fi 802.11AX BSS 颜色值(0 - 63,0 = 禁用)。 |
|
Wi-Fi 802.11AX BSS 颜色模式。 选项
|
|
Wi-Fi 信道。 选项
|
|
Wi-Fi 扩展信道。 选项
|
|
Wi-Fi 保护间隔。 选项
|
|
Wi-Fi LAN 扩展 VAP。仅选择一个 VAP。来源 extension-controller.extender-vap.name。 |
|
Wi-Fi 本地 VAP。最多选择三个 VAP。 |
|
Wi-Fi 本地 VAP 名称。来源 extension-controller.extender-vap.name。 |
|
Wi-Fi 无线电客户端的最大数量(0 - 512,0 = 无限制)。 |
|
Wi-Fi 无线电模式 AP(LAN 模式)/ Client(WAN 模式)。 选项
|
|
Wi-Fi 运行标准。 选项
|
|
Wi-Fi 功率级别,以百分比表示(0 - 100,0 = 自动)。 |
|
启用/禁用 Wi-Fi 802.11d。 选项
|
|
启用/禁用 Wi-Fi 无线电。 选项
|
|
要操作的成员属性路径。 如果有多个属性,则用斜杠字符分隔。 标有 member_path 的参数可用于执行成员操作。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时,将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
虚拟域,在之前定义的那些中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。 默认值: |
注释
注意
传统的 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"
返回值
常见返回值记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
FortiGate 映像的版本号 返回:始终 示例: |
|
用于将内容配置到 FortiGate 中的最后方法 返回:始终 示例: |
|
FortiGate 在应用的最后操作中给出的最后结果 返回:始终 示例: |
|
上次调用 FortiGate 时使用的主键 (id) 返回:成功 示例: |
|
用于满足请求的表名称 返回:始终 示例: |
|
用于满足请求的表的路径 返回:始终 示例: |
|
内部修订号 返回:始终 示例: |
|
设备的序列号 返回:始终 示例: |
|
指示操作结果 返回:始终 示例: |
|
使用的虚拟域 返回:始终 示例: |
|
FortiGate 的版本 返回:始终 示例: |