fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile 模块 – FortiExtender 扩展器配置文件配置。
注意
此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile
。
在 fortinet.fortimanager 2.2.0 中新增
概要
此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整到数据源的参数和值。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块架构与 FortiManager API 结构不同时才设置为 True,模块将继续执行而不验证参数。 选择
|
|
启用/禁用任务日志记录。 选择
|
|
设置的顶层参数。 |
|
是否为出厂设置。 选择
|
|
控制对托管扩展器的管理访问。 选择
|
|
FortiExtender LAN 扩展带宽限制 |
|
蜂窝网络。 |
|
控制器报告。 |
|
控制器报告间隔。 |
|
控制器报告信号阈值。 |
|
FortiExtender 控制器报告状态。 选择
|
|
(列表)数据计划名称。 |
|
调制解调器 1。 |
|
自动切换。 |
|
根据数据使用情况自动切换。 选择
|
|
通过断开连接自动切换。 选择
|
|
根据断开连接时间自动切换。 |
|
根据断开连接阈值自动切换。 |
|
根据信号强度自动切换。 选择
|
|
使用多选项切换回自动切换。 选择
|
|
在指定的 UTC 时间自动切换回首选的 SIM 卡/运营商 |
|
在给定时间后自动切换回首选的 SIM 卡/运营商 |
|
连接状态。 |
|
默认 SIM 卡选择。 选择
|
|
启用/禁用 FortiExtender GPS。 选择
|
|
调制解调器 ID。 |
|
首选运营商。 |
|
冗余接口。 |
|
FortiExtender 模式。 选择
|
|
SIM 卡 选择
|
|
(列表) SIM 卡 |
|
SIM 卡 选择
|
|
(列表) SIM 卡 |
|
调制解调器 2。 |
|
自动切换。 |
|
根据数据使用情况自动切换。 选择
|
|
通过断开连接自动切换。 选择
|
|
根据断开连接时间自动切换。 |
|
根据断开连接阈值自动切换。 |
|
根据信号强度自动切换。 选择
|
|
使用多选项切换回自动切换。 选择
|
|
在指定的 UTC 时间自动切换回首选的 SIM 卡/运营商 |
|
在给定时间后自动切换回首选的 SIM 卡/运营商 |
|
连接状态。 |
|
默认 SIM 卡选择。 选择
|
|
启用/禁用 FortiExtender GPS。 选择
|
|
调制解调器 ID。 |
|
首选运营商。 |
|
冗余接口。 |
|
FortiExtender 模式。 选择
|
|
SIM 卡 选择
|
|
(列表) SIM 卡 |
|
SIM 卡 选择
|
|
(列表) SIM 卡 |
|
短信通知。 |
|
警报。 |
|
当数据耗尽时显示的字符串。 |
|
当 FortiGate 备份模式切换时显示的字符串。 |
|
当信号强度低时显示的字符串。 |
|
当模式切换时显示的字符串。 |
|
当回退到以前的操作系统映像时显示的字符串。 |
|
当会话断开连接时显示的字符串。 |
|
当系统重启时显示的字符串。 |
|
接收者。 |
|
警报多选项。 选择
|
|
FortiExtender 短信通知接收者名称。 |
|
接收者电话号码。 |
|
短信通知接收者状态。 选择
|
|
FortiExtender 短信通知状态。 选择
|
|
启用/禁用 LAN 扩展接口上的带宽强制。 选择
|
|
扩展选项。 选择
|
|
ID。 |
|
LAN 扩展。 |
|
回程。 |
|
FortiExtender LAN 扩展回程名称。 |
|
FortiExtender 上行链路端口。 选择
|
|
FortiExtender 上行链路端口。 选择
|
|
WRR 权重参数。 |
|
IPsec phase1 接口。 |
|
IPsec phase1 IPv4/FQDN。 |
|
下行链路。 |
|
FortiExtender LAN 扩展下行链路配置条目名称。 |
|
FortiExtender LAN 扩展下行链路端口。 选择
|
|
FortiExtender LAN 扩展下行链路 PVID。 |
|
FortiExtender LAN 扩展下行链路类型 [端口/vap]。 选择
|
|
(列表) FortiExtender LAN 扩展下行链路 vap。 |
|
IPsec 隧道名称。 |
|
LAN 扩展链路负载均衡策略。 选择
|
|
(列表) 设置受管理扩展器的管理员密码。 |
|
更改或重置受管理扩展器的管理员密码 选择
|
|
模型。 选择
|
|
FortiExtender 配置文件名称。 |
|
无线。 |
|
此 FEX 将运行所在的国家/地区 选择
|
|
Wi-Fi 5G 射频 DFS 通道启用/禁用。 选择
|
|
射频 1。 |
|
Wi-Fi 频段选择 2。 选择
|
|
Wi-Fi 信道带宽。 选择
|
|
Wi-Fi 信标间隔(毫秒) |
|
Wi-Fi 802。 |
|
Wi-Fi 802。 选择
|
|
Wi-Fi 通道。 选择
|
|
启用/禁用 Wi-Fi 802。 选择
|
|
Wi-Fi 扩展通道。 选择
|
|
Wi-Fi 保护间隔。 选择
|
|
(列表) Wi-Fi LAN 扩展 VAP。 |
|
(列表) Wi-Fi 本地 VAP。 |
|
Wi-Fi 射频客户端的最大数量 |
|
Wi-Fi 射频模式 AP 选择
|
|
Wi-Fi 操作标准。 选择
|
|
Wi-Fi 功率级别(百分比) |
|
射频 ID。 |
|
启用/禁用 Wi-Fi 射频。 选择
|
|
射频 2。 |
|
Wi-Fi 频段选择 2。 选择
|
|
Wi-Fi 信道带宽。 选择
|
|
Wi-Fi 信标间隔(毫秒) |
|
Wi-Fi 802。 |
|
Wi-Fi 802。 选择
|
|
Wi-Fi 通道。 选择
|
|
启用/禁用 Wi-Fi 802。 选择
|
|
Wi-Fi 扩展通道。 选择
|
|
Wi-Fi 保护间隔。 选择
|
|
(列表) Wi-Fi LAN 扩展 VAP。 |
|
(列表) Wi-Fi 本地 VAP。 |
|
Wi-Fi 射频客户端的最大数量 |
|
Wi-Fi 射频模式 AP 选择
|
|
Wi-Fi 操作标准。 选择
|
|
Wi-Fi 功率级别(百分比) |
|
射频 ID。 |
|
启用/禁用 Wi-Fi 射频。 选择
|
|
使用 FortiCloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的重写方法。 选择
|
|
将被覆盖以表示失败的返回代码列表。 |
|
将被覆盖以表示成功的返回代码列表。 |
|
用于创建、更新或删除对象的指令。 选择
|
|
在工作区模式下运行的 FortiManager 的锁定 ADOM,该值可以是 global 以及其他包括 root 的值。 |
|
等待其他用户释放工作区锁定的最大时间(秒)。 默认: |
注释
注意
从 2.4.0 版本开始,所有输入参数都使用下划线命名约定 (snake_case) 命名。 请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用,但您会收到弃用警告。 您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行,顶层参数 workspace_locking_adom 和 workspace_locking_timeout 可帮助完成工作。
要创建或更新对象,请使用 state present 指令。
要删除对象,请使用 state absent 指令。
通常,当返回非零 rc 时,运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。
示例
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: FortiExtender extender profile configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
extensioncontroller_extenderprofile:
allowaccess:
- "https"
- "ping"
- "ssh"
- "snmp"
- "http"
- "telnet"
bandwidth_limit: <integer>
cellular:
controller_report:
interval: <integer>
signal_threshold: <integer>
status: <value in [disable, enable]>
dataplan: <list or string>
modem1:
auto_switch:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect_period: <integer>
disconnect_threshold: <integer>
signal: <value in [disable, enable]>
switch_back:
- "time"
- "timer"
switch_back_time: <string>
switch_back_timer: <integer>
conn_status: <integer>
default_sim: <value in [sim1, sim2, carrier, ...]>
gps: <value in [disable, enable]>
modem_id: <integer>
preferred_carrier: <string>
redundant_intf: <string>
redundant_mode: <value in [disable, enable]>
sim1_pin: <value in [disable, enable]>
sim1_pin_code: <list or string>
sim2_pin: <value in [disable, enable]>
sim2_pin_code: <list or string>
modem2:
auto_switch:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect_period: <integer>
disconnect_threshold: <integer>
signal: <value in [disable, enable]>
switch_back:
- "time"
- "timer"
switch_back_time: <string>
switch_back_timer: <integer>
conn_status: <integer>
default_sim: <value in [sim1, sim2, carrier, ...]>
gps: <value in [disable, enable]>
modem_id: <integer>
preferred_carrier: <string>
redundant_intf: <string>
redundant_mode: <value in [disable, enable]>
sim1_pin: <value in [disable, enable]>
sim1_pin_code: <list or string>
sim2_pin: <value in [disable, enable]>
sim2_pin_code: <list or string>
sms_notification:
alert:
data_exhausted: <string>
fgt_backup_mode_switch: <string>
low_signal_strength: <string>
mode_switch: <string>
os_image_fallback: <string>
session_disconnect: <string>
system_reboot: <string>
receiver:
-
alert:
- "system-reboot"
- "data-exhausted"
- "session-disconnect"
- "low-signal-strength"
- "mode-switch"
- "os-image-fallback"
- "fgt-backup-mode-switch"
name: <string>
phone_number: <string>
status: <value in [disable, enable]>
status: <value in [disable, enable]>
enforce_bandwidth: <value in [disable, enable]>
extension: <value in [wan-extension, lan-extension]>
id: <integer>
lan_extension:
backhaul:
-
name: <string>
port: <value in [wan, lte1, lte2, ...]>
role: <value in [primary, secondary]>
weight: <integer>
backhaul_interface: <string>
backhaul_ip: <string>
ipsec_tunnel: <string>
link_loadbalance: <value in [activebackup, loadbalance]>
downlinks:
-
name: <string>
port: <value in [port1, port2, port3, ...]>
pvid: <integer>
type: <value in [port, vap]>
vap: <list or string>
login_password: <list or string>
login_password_change: <value in [no, yes, default]>
model: <value in [FX201E, FX211E, FX200F, ...]>
name: <string>
_is_factory_setting: <value in [disable, enable, ext]>
wifi:
DFS: <value in [disable, enable]>
country: <value in [AL, DZ, AR, ...]>
radio_1:
d80211d: <value in [disable, enable]>
band: <value in [2.4GHz]>
bandwidth: <value in [auto, 20MHz, 40MHz, ...]>
beacon_interval: <integer>
bss_color: <integer>
bss_color_mode: <value in [auto, static]>
channel:
- "CH1"
- "CH2"
- "CH3"
- "CH4"
- "CH5"
- "CH6"
- "CH7"
- "CH8"
- "CH9"
- "CH10"
- "CH11"
extension_channel: <value in [auto, higher, lower]>
guard_interval: <value in [auto, 400ns, 800ns]>
lan_ext_vap: <list or string>
local_vaps: <list or string>
max_clients: <integer>
mode: <value in [AP, Client]>
operating_standard: <value in [auto, 11A-N-AC-AX, 11A-N-AC, ...]>
power_level: <integer>
radio_id: <integer>
status: <value in [disable, enable]>
radio_2:
d80211d: <value in [disable, enable]>
band: <value in [5GHz]>
bandwidth: <value in [auto, 20MHz, 40MHz, ...]>
beacon_interval: <integer>
bss_color: <integer>
bss_color_mode: <value in [auto, static]>
channel:
- "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: <value in [auto, higher, lower]>
guard_interval: <value in [auto, 400ns, 800ns]>
lan_ext_vap: <list or string>
local_vaps: <list or string>
max_clients: <integer>
mode: <value in [AP, Client]>
operating_standard: <value in [auto, 11A-N-AC-AX, 11A-N-AC, ...]>
power_level: <integer>
radio_id: <integer>
status: <value in [disable, enable]>
返回值
通用返回值在此处记录 这里,以下是此模块独有的字段
键 |
描述 |
---|---|
请求的结果。 返回: 始终 |
|
请求的完整 URL。 返回: 始终 示例: |
|
API 请求的状态。 返回: 始终 示例: |
|
API 响应。 返回: 始终 |
|
API 响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则会发出警告。 返回: 复杂 |