fortinet.fortimanager.fmgr_wtpprofile_radio2 模块 – radio 2 的配置选项。

注意

此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。

如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager

要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_wtpprofile_radio2

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有在使用前需要调整到数据源的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构存在差异时才设置为 True,模块会继续执行而不验证参数。

选择

  • false ←(默认)

  • true

enable_log

布尔值

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

选择

  • false ←(默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 adom,该值可以是 global 和其他包括 root 的值。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间(秒)。

默认值: 300

wtp-profile

字符串

已弃用,请使用 “wtp_profile”

wtp_profile

字符串

请求 URL 中的参数 (wtp-profile)。

wtpprofile_radio2

字典

顶层参数集。

airtime_fairness

别名:airtime-fairness

字符串

启用/禁用空口公平

选择

  • "disable"

  • "enable"

amsdu

字符串

启用/禁用 802。

选择

  • "disable"

  • "enable"

ap_handoff

别名:ap-handoff

字符串

启用/禁用客户端切换到其他 AP

选择

  • "disable"

  • "enable"

ap_sniffer_addr

别名:ap-sniffer-addr

字符串

要监视的 MAC 地址。

ap_sniffer_bufsize

别名:ap-sniffer-bufsize

整数

嗅探器缓冲区大小

ap_sniffer_chan

别名:ap-sniffer-chan

整数

嗅探器运行的通道

ap_sniffer_chan_width

别名:ap-sniffer-chan-width

字符串

嗅探器的通道带宽。

选择

  • "320MHz"

  • "240MHz"

  • "160MHz"

  • "80MHz"

  • "40MHz"

  • "20MHz"

ap_sniffer_ctl

别名:ap-sniffer-ctl

字符串

启用/禁用 WiFi 控制帧上的嗅探器

选择

  • "disable"

  • "enable"

ap_sniffer_data

别名:ap-sniffer-data

字符串

启用/禁用 WiFi 数据帧上的嗅探器

选择

  • "disable"

  • "enable"

ap_sniffer_mgmt_beacon

别名:ap-sniffer-mgmt-beacon

字符串

启用/禁用 WiFi 管理 Beacon 帧上的嗅探器

选择

  • "disable"

  • "enable"

ap_sniffer_mgmt_other

别名:ap-sniffer-mgmt-other

字符串

启用/禁用 WiFi 管理其他帧上的嗅探器

选择

  • "disable"

  • "enable"

ap_sniffer_mgmt_probe

别名:ap-sniffer-mgmt-probe

字符串

启用/禁用 WiFi 管理探测帧上的嗅探器

选择

  • "disable"

  • "enable"

arrp_profile

别名:arrp-profile

字符串

分布式自动无线资源配置

auto_power_high

别名:auto-power-high

整数

自动发射功率上限,单位为 dBm

auto_power_level

别名:auto-power-level

字符串

启用/禁用自动功率级别调整,以防止同信道干扰

选择

  • "disable"

  • "enable"

auto_power_low

别名:auto-power-low

整数

自动传输功率下限,单位为 dBm

auto_power_target

别名:auto-power-target

字符串

自动发射功率调整的目标值,单位为 dBm。

band

字符串

Radio 2 运行的 WiFi 频段。

选择

  • "802.11b"

  • "802.11a"

  • "802.11g"

  • "802.11n"

  • "802.11ac"

  • "802.11n-5G"

  • "802.11g-only"

  • "802.11n-only"

  • "802.11n,g-only"

  • "802.11ac-only"

  • "802.11ac,n-only"

  • "802.11n-5G-only"

  • "802.11ax-5G"

  • "802.11ax"

  • "802.11ax-5G-only"

  • "802.11ax,ac-only"

  • "802.11ax,ac,n-only"

  • "802.11ax-only"

  • "802.11ax,n-only"

  • "802.11ax,n,g-only"

  • "802.11ac-2G"

  • "802.11ax-6G"

  • "802.11n-2G"

  • "802.11ac-5G"

  • "802.11ax-2G"

  • "802.11be-2G"

  • "802.11be-5G"

  • "802.11be-6G"

band_5g_type

别名:band-5g-type

字符串

WiFi 5G 频段类型。

选择

  • "5g-full"

  • "5g-high"

  • "5g-low"

bandwidth_admission_control

别名: bandwidth-admission-control

字符串

启用/禁用 WiFi 多媒体

选择

  • "disable"

  • "enable"

bandwidth_capacity

别名: bandwidth-capacity

整数

允许的最大带宽容量

beacon_interval

别名: beacon-interval

整数

信标间隔。

bss_color

别名: bss-color

整数

此 11ax 无线电的 BSS 颜色值

bss_color_mode

别名: bss-color-mode

字符串

此 11ax 无线电的 BSS 颜色模式

选择

  • "auto"

  • "static"

call_admission_control

别名: call-admission-control

字符串

启用/禁用 WiFi 多媒体

选择

  • "disable"

  • "enable"

call_capacity

别名: call-capacity

整数

最大 WLAN 语音数量

channel

任意

(列表) 选择的无线电频道列表。

channel_bonding

别名: channel-bonding

字符串

信道带宽

选择

  • "disable"

  • "enable"

  • "80MHz"

  • "40MHz"

  • "20MHz"

  • "160MHz"

  • "320MHz"

  • "240MHz"

channel_bonding_ext

别名: channel-bonding-ext

字符串

信道带宽扩展

选择

  • "320MHz-1"

  • "320MHz-2"

channel_utilization

别名: channel-utilization

字符串

启用/禁用测量信道利用率。

选择

  • "disable"

  • "enable"

coexistence

字符串

启用/禁用在同一无线电上允许 HT20 和 HT40

选择

  • "disable"

  • "enable"

d80211d

别名: 80211d

字符串

启用/禁用 802。

选择

  • "disable"

  • "enable"

d80211mc

别名: 80211mc

字符串

启用/禁用 802。

选择

  • "disable"

  • "enable"

darrp

字符串

启用/禁用分布式自动无线电资源配置

选择

  • "disable"

  • "enable"

drma

字符串

启用/禁用动态无线电模式分配

选择

  • "disable"

  • "enable"

drma_sensitivity

别名: drma-sensitivity

字符串

网络覆盖因子

选择

  • "low"

  • "medium"

  • "high"

dtim

整数

DTIM 间隔。

frag_threshold

别名: frag-threshold

整数

可以发送而不分段的最大数据包大小

frequency_handoff

别名: frequency-handoff

字符串

启用/禁用客户端到其他频道的频率切换

选择

  • "disable"

  • "enable"

iperf_protocol

别名: iperf-protocol

字符串

Iperf 测试协议

选择

  • "udp"

  • "tcp"

iperf_server_port

别名: iperf-server-port

整数

Iperf 服务端口号。

max_clients

别名: max-clients

整数

最大站点数

max_distance

别名: max-distance

整数

AP 和客户端之间的最大预期距离

mimo_mode

别名: mimo-mode

字符串

配置无线电 MIMO 模式

选择

  • "default"

  • "1x1"

  • "2x2"

  • "3x3"

  • "4x4"

  • "8x8"

mode

字符串

无线电 2 的模式。

选择

  • "disabled"

  • "ap"

  • "monitor"

  • "sniffer"

  • "sam"

optional_antenna

别名: optional-antenna

字符串

FAP 上使用的可选天线

选择

  • "none"

  • "FANT-04ABGN-0606-O-N"

  • "FANT-04ABGN-1414-P-N"

  • "FANT-04ABGN-8065-P-N"

  • "FANT-04ABGN-0606-O-R"

  • "FANT-04ABGN-0606-P-R"

  • "FANT-10ACAX-1213-D-N"

  • "FANT-08ABGN-1213-D-R"

  • "custom"

optional_antenna_gain

别名: optional-antenna-gain

字符串

可选天线增益,单位为 dBi

power_level

别名: power-level

整数

无线电功率级别,为最大发射功率的百分比

power_mode

别名: power-mode

字符串

设置无线电有效全向辐射功率

选择

  • "dBm"

  • "percentage"

power_value

别名: power-value

整数

无线电 EIRP 功率,单位为 dBm

powersave_optimize

别名: powersave-optimize

列表 / 元素=字符串

启用客户端省电功能,例如 TIM、AC VO 和 OBSS 等。

选择

  • "tim"

  • "ac-vo"

  • "no-obss-scan"

  • "no-11b-rate"

  • "client-rate-follow"

protection_mode

别名: protection-mode

字符串

启用/禁用 802。

选择

  • "rtscts"

  • "ctsonly"

  • "disable"

radio_id

别名: radio-id

整数

无线电 ID。

rts_threshold

别名: rts-threshold

整数

RTS 传输的最大数据包大小,指定 RTS/CTS 之前数据包的最大大小

sam_bssid

别名: sam-bssid

字符串

WiFi 网络的 BSSID。

sam_ca_certificate

别名: sam-ca-certificate

字符串

WPA2/WPA3-ENTERPRISE 的 CA 证书。

sam_captive_portal

别名: sam-captive-portal

字符串

启用/禁用强制门户身份验证

选择

  • "disable"

  • "enable"

sam_client_certificate

别名: sam-client-certificate

字符串

WPA2/WPA3-ENTERPRISE 的客户端证书。

sam_cwp_failure_string

别名: sam-cwp-failure-string

字符串

登录不正确后页面上的失败标识。

sam_cwp_match_string

别名: sam-cwp-match-string

字符串

来自强制门户登录表单的标识字符串。

sam_cwp_password

别名: sam-cwp-password

任意

(列表) 用于强制门户身份验证的密码。

sam_cwp_success_string

别名: sam-cwp-success-string

字符串

成功登录后页面上的成功标识。

sam_cwp_test_url

别名: sam-cwp-test-url

字符串

客户端尝试访问的网站。

sam_cwp_username

别名: sam-cwp-username

字符串

用于强制门户身份验证的用户名。

sam_eap_method

别名: sam-eap-method

字符串

选择 WPA2/WPA3-ENTERPRISE EAP 方法

选择

  • "tls"

  • "peap"

  • "both"

sam_password

别名: sam-password

任意

(列表) 用于 WiFi 网络连接的密码短语。

sam_private_key

别名: sam-private-key

字符串

用于 WPA2/WPA3-ENTERPRISE 的私钥。

sam_private_key_password

别名: sam-private-key-password

任意

(列表) 用于 WPA2/WPA3-ENTERPRISE 的私钥文件的密码。

sam_report_intv

别名: sam-report-intv

整数

SAM 报告间隔

sam_security_type

别名: sam-security-type

字符串

选择 WiFi 网络安全类型

选择

  • "open"

  • "wpa-personal"

  • "wpa-enterprise"

  • "owe"

  • "wpa3-sae"

sam_server

别名: sam-server

字符串

SAM 测试服务器 IP 地址或域名。

sam_server_fqdn

别名: sam-server-fqdn

字符串

SAM 测试服务器域名。

sam_server_ip

别名: sam-server-ip

字符串

SAM 测试服务器 IP 地址。

sam_server_type

别名: sam-server-type

字符串

选择 SAM 服务器类型

选择

  • "ip"

  • "fqdn"

sam_ssid

别名: sam-ssid

字符串

WiFi 网络的 SSID。

sam_test

别名: sam-test

字符串

选择 SAM 测试类型

选择

  • "ping"

  • "iperf"

sam_username

别名: sam-username

字符串

用于 WiFi 网络连接的用户名。

short_guard_interval

别名: short-guard-interval

字符串

使用短保护间隔

选择

  • "disable"

  • "enable"

spectrum_analysis

别名: spectrum-analysis

字符串

启用/禁用频谱分析以查找可能对无线性能产生负面影响的干扰。

选择

  • "disable"

  • "enable"

  • "scan-only"

transmit_optimize

别名: transmit-optimize

列表 / 元素=字符串

数据包传输优化选项,包括省电、聚合限制、重试限制等。

选择

  • "disable"

  • "power-save"

  • "aggr-limit"

  • "retry-limit"

  • "send-bar"

vap1

字符串

虚拟接入点

vap2

字符串

虚拟接入点

vap3

字符串

虚拟接入点

vap4

字符串

虚拟接入点

vap5

字符串

虚拟接入点

vap6

字符串

虚拟接入点

vap7

字符串

虚拟接入点

vap8

字符串

虚拟接入点

vap_all

别名: vap-all

字符串

启用/禁用所有虚拟接入点的自动继承

选择

  • "disable"

  • "enable"

  • "tunnel"

  • "bridge"

  • "manual"

vaps

任意

(列表或字符串) 手动选择的虚拟接入点列表

wids_profile

别名: wids-profile

字符串

无线入侵检测系统

zero_wait_dfs

别名: zero-wait-dfs

字符串

启用/禁用无线电上的零等待 DFS

选择

  • "disable"

  • "enable"

注意

注意

  • 从 2.4.0 版本开始,所有输入参数都使用下划线命名约定(snake_case)命名。请将参数(例如“var-name”)更改为“var_name”。旧的参数名称仍然可用,但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行,顶层参数 workspace_locking_adom 和 workspace_locking_timeout 可以帮助完成此工作。

  • 通常,当返回非零 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: Configuration options for radio 2.
      fortinet.fortimanager.fmgr_wtpprofile_radio2:
        # 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>
        wtp_profile: <your own value>
        wtpprofile_radio2:
          amsdu: <value in [disable, enable]>
          ap_handoff: <value in [disable, enable]>
          ap_sniffer_addr: <string>
          ap_sniffer_bufsize: <integer>
          ap_sniffer_chan: <integer>
          ap_sniffer_ctl: <value in [disable, enable]>
          ap_sniffer_data: <value in [disable, enable]>
          ap_sniffer_mgmt_beacon: <value in [disable, enable]>
          ap_sniffer_mgmt_other: <value in [disable, enable]>
          ap_sniffer_mgmt_probe: <value in [disable, enable]>
          auto_power_high: <integer>
          auto_power_level: <value in [disable, enable]>
          auto_power_low: <integer>
          band: <value in [802.11b, 802.11a, 802.11g, ...]>
          bandwidth_admission_control: <value in [disable, enable]>
          bandwidth_capacity: <integer>
          beacon_interval: <integer>
          call_admission_control: <value in [disable, enable]>
          call_capacity: <integer>
          channel: <list or string>
          channel_bonding: <value in [disable, enable, 80MHz, ...]>
          channel_utilization: <value in [disable, enable]>
          coexistence: <value in [disable, enable]>
          darrp: <value in [disable, enable]>
          dtim: <integer>
          frag_threshold: <integer>
          frequency_handoff: <value in [disable, enable]>
          max_clients: <integer>
          max_distance: <integer>
          mode: <value in [disabled, ap, monitor, ...]>
          power_level: <integer>
          powersave_optimize:
            - "tim"
            - "ac-vo"
            - "no-obss-scan"
            - "no-11b-rate"
            - "client-rate-follow"
          protection_mode: <value in [rtscts, ctsonly, disable]>
          radio_id: <integer>
          rts_threshold: <integer>
          short_guard_interval: <value in [disable, enable]>
          spectrum_analysis: <value in [disable, enable, scan-only]>
          transmit_optimize:
            - "disable"
            - "power-save"
            - "aggr-limit"
            - "retry-limit"
            - "send-bar"
          vap_all: <value in [disable, enable, tunnel, ...]>
          vaps: <list or string>
          wids_profile: <string>
          airtime_fairness: <value in [disable, enable]>
          band_5g_type: <value in [5g-full, 5g-high, 5g-low]>
          zero_wait_dfs: <value in [disable, enable]>
          vap1: <string>
          vap2: <string>
          vap3: <string>
          vap4: <string>
          vap5: <string>
          vap6: <string>
          vap7: <string>
          vap8: <string>
          bss_color: <integer>
          auto_power_target: <string>
          drma: <value in [disable, enable]>
          drma_sensitivity: <value in [low, medium, high]>
          iperf_protocol: <value in [udp, tcp]>
          iperf_server_port: <integer>
          power_mode: <value in [dBm, percentage]>
          power_value: <integer>
          sam_bssid: <string>
          sam_captive_portal: <value in [disable, enable]>
          sam_password: <list or string>
          sam_report_intv: <integer>
          sam_security_type: <value in [open, wpa-personal, wpa-enterprise, ...]>
          sam_server: <string>
          sam_ssid: <string>
          sam_test: <value in [ping, iperf]>
          sam_username: <string>
          arrp_profile: <string>
          bss_color_mode: <value in [auto, static]>
          sam_cwp_failure_string: <string>
          sam_cwp_match_string: <string>
          sam_cwp_password: <list or string>
          sam_cwp_success_string: <string>
          sam_cwp_test_url: <string>
          sam_cwp_username: <string>
          sam_server_fqdn: <string>
          sam_server_ip: <string>
          sam_server_type: <value in [ip, fqdn]>
          d80211d: <value in [disable, enable]>
          optional_antenna: <value in [none, FANT-04ABGN-0606-O-N, FANT-04ABGN-1414-P-N, ...]>
          mimo_mode: <value in [default, 1x1, 2x2, ...]>
          optional_antenna_gain: <string>
          sam_ca_certificate: <string>
          sam_client_certificate: <string>
          sam_eap_method: <value in [tls, peap, both]>
          sam_private_key: <string>
          sam_private_key_password: <list or string>
          channel_bonding_ext: <value in [320MHz-1, 320MHz-2]>
          d80211mc: <value in [disable, enable]>
          ap_sniffer_chan_width: <value in [320MHz, 240MHz, 160MHz, ...]>

返回值

通用返回值已在此处记录 此处,以下是此模块特有的字段

描述

meta

字典

请求的结果。

返回: 总是

request_url

字符串

请求的完整 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 总是

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 总是

response_message

字符串

API 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则会发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)