fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_wifi 模块 – 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_wifi。

fortinet.fortimanager 2.6.0 中的新增功能

概要

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

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ← （默认）

  • true

enable_log

布尔值

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

选项

  • false ← （默认）

  • true

extender-profile

字符串

已弃用，请使用“extender_profile”

extender_profile

字符串

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

extensioncontroller_extenderprofile_wifi

字典

顶层参数集。

country

字符串

此 FEX 将运行的国家/地区

选项

  • "AL"

  • "DZ"

  • "AR"

  • "AM"

  • "AU"

  • "AT"

  • "AZ"

  • "BH"

  • "BD"

  • "BY"

  • "BE"

  • "BZ"

  • "BO"

  • "BA"

  • "BR"

  • "BN"

  • "BG"

  • "CA"

  • "CL"

  • "CN"

  • "CO"

  • "CR"

  • "HR"

  • "CY"

  • "CZ"

  • "DK"

  • "DO"

  • "EC"

  • "EG"

  • "SV"

  • "EE"

  • "FI"

  • "FR"

  • "GE"

  • "DE"

  • "GR"

  • "GT"

  • "HN"

  • "HK"

  • "HU"

  • "IS"

  • "IN"

  • "ID"

  • "IE"

  • "IL"

  • "IT"

  • "JM"

  • "JP"

  • "JO"

  • "KZ"

  • "KE"

  • "KR"

  • "KW"

  • "LV"

  • "LB"

  • "LI"

  • "LT"

  • "LU"

  • "MO"

  • "MK"

  • "MY"

  • "MT"

  • "MX"

  • "MC"

  • "MA"

  • "NP"

  • "NL"

  • "AN"

  • "NZ"

  • "NO"

  • "OM"

  • "PK"

  • "PA"

  • "PG"

  • "PE"

  • "PH"

  • "PL"

  • "PT"

  • "PR"

  • "QA"

  • "RO"

  • "RU"

  • "SA"

  • "SG"

  • "SK"

  • "SI"

  • "ZA"

  • "ES"

  • "LK"

  • "SE"

  • "CH"

  • "TW"

  • "TH"

  • "TT"

  • "TN"

  • "TR"

  • "AE"

  • "UA"

  • "GB"

  • "US"

  • "PS"

  • "UY"

  • "UZ"

  • "VE"

  • "VN"

  • "YE"

  • "ZW"

  • "NA"

  • "BS"

  • "VC"

  • "KH"

  • "MV"

  • "AF"

  • "NG"

  • "TZ"

  • "ZM"

  • "SN"

  • "CI"

  • "GH"

  • "CM"

  • "MW"

  • "AO"

  • "GA"

  • "ML"

  • "BJ"

  • "MG"

  • "TD"

  • "BW"

  • "LY"

  • "RW"

  • "MZ"

  • "GM"

  • "LS"

  • "MU"

  • "CG"

  • "UG"

  • "BF"

  • "SL"

  • "SO"

  • "CD"

  • "NE"

  • "CF"

  • "SZ"

  • "TG"

  • "LR"

  • "MR"

  • "DJ"

  • "RE"

  • "RS"

  • "ME"

  • "IQ"

  • "MD"

  • "KY"

  • "BB"

  • "BM"

  • "TC"

  • "VI"

  • "PM"

  • "MF"

  • "GD"

  • "IM"

  • "FO"

  • "GI"

  • "GL"

  • "TM"

  • "MN"

  • "VU"

  • "FJ"

  • "LA"

  • "GU"

  • "WF"

  • "MH"

  • "BT"

  • "FM"

  • "PF"

  • "NI"

  • "PY"

  • "HT"

  • "GY"

  • "AW"

  • "KN"

  • "GF"

  • "AS"

  • "MP"

  • "PW"

  • "MM"

  • "LC"

  • "GP"

  • "ET"

  • "SR"

  • "CX"

  • "DM"

  • "MQ"

  • "YT"

  • "BL"

  • "--"

DFS

字符串

Wi-Fi 5G 频段 DFS 通道启用/禁用。

选项

  • "禁用"

  • "启用"

radio_1

别名：radio-1

字典

无线电 1。

band

字符串

Wi-Fi 频段选择 2。

选项

  • "2.4GHz"

bandwidth

字符串

Wi-Fi 通道带宽。

选项

  • "自动"

  • "20MHz"

  • "40MHz"

  • "80MHz"

beacon_interval

别名：beacon-interval

整数

Wi-Fi 信标间隔，单位为毫秒

bss_color

别名：bss-color

整数

Wi-Fi 802。

bss_color_mode

别名：bss-color-mode

字符串

Wi-Fi 802。

选项

  • "自动"

  • "静态"

channel

列表 / 元素=字符串

Wi-Fi 通道。

选项

  • "CH1"

  • "CH2"

  • "CH3"

  • "CH4"

  • "CH5"

  • "CH6"

  • "CH7"

  • "CH8"

  • "CH9"

  • "CH10"

  • "CH11"

d80211d

别名：80211d

字符串

启用/禁用 Wi-Fi 802。

选项

  • "禁用"

  • "启用"

extension_channel

别名：extension-channel

字符串

Wi-Fi 扩展通道。

选项

  • "自动"

  • "较高"

  • "较低"

guard_interval

别名：guard-interval

字符串

Wi-Fi 保护间隔。

选项

  • "自动"

  • "400ns"

  • "800ns"

lan_ext_vap

别名: lan-ext-vap

列表 / 元素=字符串

Wi-Fi LAN 扩展 VAP。

local_vaps

别名: local-vaps

列表 / 元素=字符串

Wi-Fi 本地 VAP。

max_clients

别名: max-clients

整数

Wi-Fi 无线电客户端的最大数量

mode

字符串

Wi-Fi 无线电模式 AP

选项

  • "AP"

  • "Client"

operating_standard

别名: operating-standard

字符串

Wi-Fi 工作标准。

选项

  • "自动"

  • "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

别名: power-level

整数

Wi-Fi 功率级别，以百分比表示

radio_id

别名: radio-id

整数

无线电 ID。

status

字符串

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

选项

  • "禁用"

  • "启用"

radio_2

别名: radio-2

字典

无线电 2。

band

字符串

Wi-Fi 频段选择 2。

选项

  • "5GHz"

bandwidth

字符串

Wi-Fi 通道带宽。

选项

  • "自动"

  • "20MHz"

  • "40MHz"

  • "80MHz"

beacon_interval

别名：beacon-interval

整数

Wi-Fi 信标间隔，单位为毫秒

bss_color

别名：bss-color

整数

Wi-Fi 802。

bss_color_mode

别名：bss-color-mode

字符串

Wi-Fi 802。

选项

  • "自动"

  • "静态"

channel

列表 / 元素=字符串

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"

d80211d

别名：80211d

字符串

启用/禁用 Wi-Fi 802。

选项

  • "禁用"

  • "启用"

extension_channel

别名：extension-channel

字符串

Wi-Fi 扩展通道。

选项

  • "自动"

  • "较高"

  • "较低"

guard_interval

别名：guard-interval

字符串

Wi-Fi 保护间隔。

选项

  • "自动"

  • "400ns"

  • "800ns"

lan_ext_vap

别名: lan-ext-vap

列表 / 元素=字符串

Wi-Fi LAN 扩展 VAP。

local_vaps

别名: local-vaps

列表 / 元素=字符串

Wi-Fi 本地 VAP。

max_clients

别名: max-clients

整数

Wi-Fi 无线电客户端的最大数量

mode

字符串

Wi-Fi 无线电模式 AP

选项

  • "AP"

  • "Client"

operating_standard

别名: operating-standard

字符串

Wi-Fi 工作标准。

选项

  • "自动"

  • "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

别名: power-level

整数

Wi-Fi 功率级别，以百分比表示

radio_id

别名: radio-id

整数

无线电 ID。

status

字符串

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

选项

  • "禁用"

  • "启用"

forticloud_access_token

字符串

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

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

workspace_locking_adom

字符串

在工作区模式下锁定的 FortiManager 的 ADOM，该值可以是全局的和其他的（包括 root）。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（以秒为单位）。

默认值: 300

注释

注意

  • 从 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: FortiExtender wifi configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_wifi:
        # 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>
        extender_profile: <your own value>
        extensioncontroller_extenderprofile_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]>

返回值

通用返回值记录在 此处，以下是此模块独有的字段

键

描述

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

列表 / 元素=字符串

如果当前 FortiManager 版本不支持剧本中使用的参数，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)