fortinet.fortios.fortios_wireless_controller_wtp 模块 – 配置无线终端点 (WTP),即由 Fortinet 的 FortiOS 和 FortiGate 中的 FortiGate 管理的 FortiAP 或 AP。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortios
。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。
要在 playbook 中使用它,请指定:fortinet.fortios.fortios_wireless_controller_wtp
。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改 wireless_controller 功能和 wtp 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,并且在使用前需要将值调整到数据源。在 FOS v6.0.0 上测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 FortiGate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性,则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
虚拟域,在之前定义的那些虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。 默认: |
|
配置无线终端点 (WTP),即由 FortiGate 管理的 FortiAP 或 AP。 |
|
配置充当无线控制器来发现和管理此 WTP、AP 或 FortiAP 的 FortiGate 的方式。 选项
|
|
控制对受管理的 WTP、FortiAP 或 AP 的管理访问。用空格分隔条目。 选项
|
|
AP 本地配置配置文件名称。来源 wireless-controller.apcfg-profile.name。 |
|
覆盖 BLE 主 ID。 |
|
覆盖 BLE 次 ID。 |
|
Bonjour 配置文件名称。来源 wireless-controller.bonjour-profile.name。 |
|
启用/禁用 WTP 坐标 (X、Y 轴)。 选项
|
|
WTP 纬度坐标。 |
|
WTP 经度坐标。 |
|
X 轴坐标。 |
|
Y 轴坐标。 |
|
启动时为此 FortiAP 提供的固件版本 (major.minor.build,即 6.2.1234)。 |
|
启用/禁用一次性自动配置最新固件版本。 选项
|
|
启用/禁用 WTP 镜像下载。 选项
|
|
索引 (0 - 4294967295)。 |
|
通过 CAPWAP 隧道防止控制和数据分组 IP 分片的方法。 选项
|
|
WTP LAN 端口映射。 |
|
LAN 端口 1 模式。 选项
|
|
将 LAN 端口 1 桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口 2 模式。 选项
|
|
将 LAN 端口 2 桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口 3 模式。 选项
|
|
将 LAN 端口 3 桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口 4 模式。 选项
|
|
将 LAN 端口 4 桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口 5 模式。 选项
|
|
将 LAN 端口 5 桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口 6 模式。 选项
|
|
将 LAN 端口 6 桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口 7 模式。 选项
|
|
将 LAN 端口 7 桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口 8 模式。 选项
|
|
将 LAN 端口 8 桥接到 SSID。来源 system.interface.name。 |
|
ESL 端口模式。 选项
|
|
将 ESL 端口桥接到 SSID。来源 system.interface.name。 |
|
LAN 端口模式。 选项
|
|
将 LAN 端口桥接到 SSID。来源 system.interface.name。 |
|
启用以允许 FortiAP 的 LED 灯亮起。禁用以保持 LED 灯熄灭。您可能希望保持 LED 灯熄灭,以免在弱光环境等情况下造成干扰。 选项
|
|
用于描述 WTP、AP 或 FortiAP 的物理位置的字段。 |
|
设置受管理的 WTP、FortiAP 或 AP 的管理员密码。 |
|
更改或重置受管理的 WTP、FortiAP 或 AP 的管理员密码(是、默认或否)。 选项
|
|
当 WTP 配置为网状分支/叶子 AP 时,启用/禁用网状以太网桥。 选项
|
|
WTP、AP 或 FortiAP 配置名称。 |
|
启用以覆盖 WTP 配置文件管理访问配置。 选项
|
|
启用/禁用覆盖 WTP 配置文件 IP 分片防护设置。 选项
|
|
启用以覆盖 WTP 配置文件 LAN 端口设置。 选项
|
|
启用以覆盖此 FortiAP 的配置文件 LED 状态设置。您必须启用此选项才能使用 led-state 命令关闭 FortiAP 的 LED 灯。 选项
|
|
启用以覆盖 WTP 配置文件登录密码(管理员密码)设置。 选项
|
|
启用/禁用覆盖 WTP 配置文件拆分隧道设置。 选项
|
|
启用/禁用覆盖 WTP 配置文件中的 wan-port-mode。 选项
|
|
此 WTP 的 Purdue 等级。 选项
|
|
无线电 1 的配置选项。 |
|
自动发射功率调整的上限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
启用/禁用自动功率电平调整,以防止同信道干扰。 选项
|
|
自动发射功率调整的下限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
自动发射功率调整的目标值(dBm)(-95 至 -20)。 |
|
无线电 1 运行的 WiFi 频段。 选项
|
|
选择的无线电信道列表。 |
|
信道编号。 |
|
用于 DRMA 手动模式的无线电模式。 选项
|
|
启用以覆盖 WTP 配置文件频谱分析配置。 选项
|
|
启用以覆盖 WTP 配置文件频段设置。 选项
|
|
启用以覆盖 WTP 配置文件信道设置。 选项
|
|
启用以覆盖 WTP 配置文件功率电平配置。 选项
|
|
启用以覆盖 WTP 配置文件虚拟接入点 (VAP) 设置。 选项
|
|
无线电 EIRP 功率电平,占最大 EIRP 功率的百分比 (0 - 100)。 |
|
设置无线电有效各向同性辐射功率 (EIRP),单位为 dBm 或占最大 EIRP 的百分比。此功率同时考虑了无线电发射功率和天线增益。较高的功率电平设置可能会受到当地法规要求和 AP 功能的限制。 选项
|
|
无线电 EIRP 功率 (dBm) (1 - 33)。 |
|
无线电 ID |
|
启用/禁用频谱分析,以查找会对无线性能产生负面影响的干扰。 选项
|
|
配置将 SSID 分配给此 FortiAP 的方法。 选项
|
|
手动选择的虚拟接入点 (VAP) 列表。 |
|
虚拟接入点 (VAP) 名称。来源 wireless-controller.vap-group.name system.interface.name。 |
|
无线电 2 的配置选项。 |
|
自动发射功率调整的上限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
启用/禁用自动功率电平调整,以防止同信道干扰。 选项
|
|
自动发射功率调整的下限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
自动发射功率调整的目标值(dBm)(-95 至 -20)。 |
|
无线电 2 运行的 WiFi 频段。 选项
|
|
选择的无线电信道列表。 |
|
信道编号。 |
|
用于 DRMA 手动模式的无线电模式。 选项
|
|
启用以覆盖 WTP 配置文件频谱分析配置。 选项
|
|
启用以覆盖 WTP 配置文件频段设置。 选项
|
|
启用以覆盖 WTP 配置文件信道设置。 选项
|
|
启用以覆盖 WTP 配置文件功率电平配置。 选项
|
|
启用以覆盖 WTP 配置文件虚拟接入点 (VAP) 设置。 选项
|
|
无线电 EIRP 功率电平,占最大 EIRP 功率的百分比 (0 - 100)。 |
|
设置无线电有效各向同性辐射功率 (EIRP),单位为 dBm 或占最大 EIRP 的百分比。此功率同时考虑了无线电发射功率和天线增益。较高的功率电平设置可能会受到当地法规要求和 AP 功能的限制。 选项
|
|
无线电 EIRP 功率 (dBm) (1 - 33)。 |
|
无线电 ID |
|
启用/禁用频谱分析,以查找会对无线性能产生负面影响的干扰。 选项
|
|
配置将 SSID 分配给此 FortiAP 的方法。 选项
|
|
手动选择的虚拟接入点 (VAP) 列表。 |
|
虚拟接入点 (VAP) 名称。来源 wireless-controller.vap-group.name system.interface.name。 |
|
无线电 3 的配置选项。 |
|
自动发射功率调整的上限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
启用/禁用自动功率电平调整,以防止同信道干扰。 选项
|
|
自动发射功率调整的下限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
自动发射功率调整的目标值(dBm)(-95 至 -20)。 |
|
无线电 3 运行的 WiFi 频段。 选项
|
|
选择的无线电信道列表。 |
|
信道编号。 |
|
用于 DRMA 手动模式的无线电模式。 选项
|
|
启用以覆盖 WTP 配置文件频谱分析配置。 选项
|
|
启用以覆盖 WTP 配置文件频段设置。 选项
|
|
启用以覆盖 WTP 配置文件信道设置。 选项
|
|
启用以覆盖 WTP 配置文件功率电平配置。 选项
|
|
启用以覆盖 WTP 配置文件虚拟接入点 (VAP) 设置。 选项
|
|
无线电 EIRP 功率电平,占最大 EIRP 功率的百分比 (0 - 100)。 |
|
设置无线电有效各向同性辐射功率 (EIRP),单位为 dBm 或占最大 EIRP 的百分比。此功率同时考虑了无线电发射功率和天线增益。较高的功率电平设置可能会受到当地法规要求和 AP 功能的限制。 选项
|
|
无线电 EIRP 功率 (dBm) (1 - 33)。 |
|
无线电 ID |
|
启用/禁用频谱分析,以查找会对无线性能产生负面影响的干扰。 选项
|
|
配置将 SSID 分配给此 FortiAP 的方法。 选项
|
|
手动选择的虚拟接入点 (VAP) 列表。 |
|
虚拟接入点 (VAP) 名称。来源 wireless-controller.vap-group.name system.interface.name。 |
|
无线电 4 的配置选项。 |
|
自动发射功率调整的上限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
启用/禁用自动功率电平调整,以防止同信道干扰。 选项
|
|
自动发射功率调整的下限(dBm)(实际发射功率范围取决于 AP 平台类型)。 |
|
自动发射功率调整的目标值(dBm)(-95 至 -20)。 |
|
无线电 4 运行的 WiFi 频段。 选项
|
|
选择的无线电信道列表。 |
|
信道编号。 |
|
用于 DRMA 手动模式的无线电模式。 选项
|
|
启用以覆盖 WTP 配置文件频谱分析配置。 选项
|
|
启用以覆盖 WTP 配置文件频段设置。 选项
|
|
启用以覆盖 WTP 配置文件信道设置。 选项
|
|
启用以覆盖 WTP 配置文件功率电平配置。 选项
|
|
启用以覆盖 WTP 配置文件虚拟接入点 (VAP) 设置。 选项
|
|
无线电 EIRP 功率电平,占最大 EIRP 功率的百分比 (0 - 100)。 |
|
设置无线电有效各向同性辐射功率 (EIRP),单位为 dBm 或占最大 EIRP 的百分比。此功率同时考虑了无线电发射功率和天线增益。较高的功率电平设置可能会受到当地法规要求和 AP 功能的限制。 选项
|
|
无线电 EIRP 功率 (dBm) (1 - 33)。 |
|
启用/禁用频谱分析,以查找会对无线性能产生负面影响的干扰。 选项
|
|
配置将 SSID 分配给此 FortiAP 的方法。 选项
|
|
手动选择的虚拟接入点 (VAP) 列表。 |
|
虚拟接入点 (VAP) 名称。来源 wireless-controller.vap-group.name system.interface.name。 |
|
WTP 关联的区域名称。来源 wireless-controller.region.name。 |
|
相对水平区域坐标 (0 到 1 之间)。 |
|
相对垂直区域坐标 (0 到 1 之间)。 |
|
拆分隧道 ACL 过滤器列表。 |
|
拆分隧道子网的目标 IP 和掩码。 |
|
ID。请参见 注释。 |
|
启用/禁用自动将 FortiAP 的本地子网添加到拆分隧道 ACL。 选项
|
|
拆分隧道 ACL 路径为本地/隧道。 选项
|
|
下行链路 CAPWAP 隧道的 MTU (576 - 1500 字节或 0;0 表示 FortiAP 的本地 MTU;)。 |
|
上行链路 CAPWAP 隧道的最大传输单元 (MTU) (576 - 1500 字节或 0;0 表示 FortiAP 的本地 MTU;)。 |
|
通用唯一标识符 (UUID;自动分配,但可以手动重置)。 |
|
启用/禁用将 FortiAP WAN 端口用作 LAN 端口。 选项
|
|
WTP ID。 |
|
WTP、AP 或 FortiAP 操作模式;正常(默认)或远程。可以在正常模式下但不能在远程模式下将隧道模式 SSID 分配给 AP,而可以在正常模式或远程模式下将本地桥接模式 SSID 分配给 AP。 选项
|
|
要应用于此 WTP、AP 或 FortiAP 的 WTP 配置文件名称。来源 wireless-controller.wtp-profile.name。 |
注释
注意
旧的 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方法。
此模块支持 check_mode。
示例
- name: Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate.
fortinet.fortios.fortios_wireless_controller_wtp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_wtp:
admin: "discovered"
allowaccess: "https"
apcfg_profile: "<your_own_value> (source wireless-controller.apcfg-profile.name)"
ble_major_id: "0"
ble_minor_id: "0"
bonjour_profile: "<your_own_value> (source wireless-controller.bonjour-profile.name)"
coordinate_enable: "enable"
coordinate_latitude: "<your_own_value>"
coordinate_longitude: "<your_own_value>"
coordinate_x: "<your_own_value>"
coordinate_y: "<your_own_value>"
firmware_provision: "<your_own_value>"
firmware_provision_latest: "disable"
image_download: "enable"
index: "0"
ip_fragment_preventing: "tcp-mss-adjust"
lan:
port_esl_mode: "offline"
port_esl_ssid: "<your_own_value> (source system.interface.name)"
port_mode: "offline"
port_ssid: "<your_own_value> (source system.interface.name)"
port1_mode: "offline"
port1_ssid: "<your_own_value> (source system.interface.name)"
port2_mode: "offline"
port2_ssid: "<your_own_value> (source system.interface.name)"
port3_mode: "offline"
port3_ssid: "<your_own_value> (source system.interface.name)"
port4_mode: "offline"
port4_ssid: "<your_own_value> (source system.interface.name)"
port5_mode: "offline"
port5_ssid: "<your_own_value> (source system.interface.name)"
port6_mode: "offline"
port6_ssid: "<your_own_value> (source system.interface.name)"
port7_mode: "offline"
port7_ssid: "<your_own_value> (source system.interface.name)"
port8_mode: "offline"
port8_ssid: "<your_own_value> (source system.interface.name)"
led_state: "enable"
location: "<your_own_value>"
login_passwd: "<your_own_value>"
login_passwd_change: "yes"
mesh_bridge_enable: "default"
name: "default_name_45"
override_allowaccess: "enable"
override_ip_fragment: "enable"
override_lan: "enable"
override_led_state: "enable"
override_login_passwd_change: "enable"
override_split_tunnel: "enable"
override_wan_port_mode: "enable"
purdue_level: "1"
radio_1:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
radio_id: "2"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_75 (source wireless-controller.vap-group.name system.interface.name)"
radio_2:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
radio_id: "2"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_97 (source wireless-controller.vap-group.name system.interface.name)"
radio_3:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
radio_id: "2"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_119 (source wireless-controller.vap-group.name system.interface.name)"
radio_4:
auto_power_high: "17"
auto_power_level: "enable"
auto_power_low: "10"
auto_power_target: "<your_own_value>"
band: "802.11a"
channel:
-
chan: "<your_own_value>"
drma_manual_mode: "ap"
override_analysis: "enable"
override_band: "enable"
override_channel: "enable"
override_txpower: "enable"
override_vaps: "enable"
power_level: "100"
power_mode: "dBm"
power_value: "27"
spectrum_analysis: "enable"
vap_all: "tunnel"
vaps:
-
name: "default_name_140 (source wireless-controller.vap-group.name system.interface.name)"
region: "<your_own_value> (source wireless-controller.region.name)"
region_x: "<your_own_value>"
region_y: "<your_own_value>"
split_tunneling_acl:
-
dest_ip: "<your_own_value>"
id: "146"
split_tunneling_acl_local_ap_subnet: "enable"
split_tunneling_acl_path: "tunnel"
tun_mtu_downlink: "0"
tun_mtu_uplink: "0"
uuid: "<your_own_value>"
wan_port_mode: "wan-lan"
wtp_id: "<your_own_value>"
wtp_mode: "normal"
wtp_profile: "<your_own_value> (source wireless-controller.wtp-profile.name)"
返回值
常见的返回值已在 此处 记录,以下是此模块独有的字段
键 |
描述 |
---|---|
FortiGate 映像的版本号 返回:始终 示例: |
|
上次用于将内容置备到 FortiGate 的方法 返回:始终 示例: |
|
FortiGate 在上次应用的操作中给出的最后结果 返回:始终 示例: |
|
上次调用 FortiGate 时使用的主密钥 (id) 返回:成功 示例: |
|
用于完成请求的表的名称 返回:始终 示例: |
|
用于完成请求的表的路径 返回:始终 示例: |
|
内部修订号 返回:始终 示例: |
|
设备的序列号 返回:始终 示例: |
|
操作结果的指示 返回:始终 示例: |
|
使用的虚拟域 返回:始终 示例: |
|
FortiGate 的版本 返回:始终 示例: |