Fortinet white logo
Fortinet white logo

CLI Reference

config vap

config vap

Description: Configure WiFi virtual access point.

config wifi
  config vap
    edit <WiFi Access Point Name>
      set ssid <string>
      set broadcast-ssid [enable | disable]
      set dtim {integer}
      set rts-threshold {integer}
      set max-clients {integer}
      set target-wake-time [enable | disable]
      set bss-color-partial [enable | disable]
      set mu-mimo [enable | disable]
      set wlan-bridge [yes |no ]
      set wlan-members
      config ap-security
        set security-mode <encryption mode>
      end
    next
  end
end
Sample command:
config wifi
  config vap
    edit fbs-home-2g-1
      set ssid fbs-home-2g-1
      set broadcast-ssid enable
      set dtim 1
      set rts-threshold 2347
      set max-clients 9
      set target-wake-time enable
      set bss-color-partial enable
      set mu-mimo enable
      set wlan-bridge no
      set wlan-members
      config ap-security
        set security-mode WPA2-Enterprise
        set auth-server-addr 192.168.11.99
        set auth-server-port 1812
        set auth-server-secret ******
        set pmf optional
      end
    next
    edit fbs-home-5g-1
      set ssid fbs-home-5g-1
      set broadcast-ssid enable
      set dtim 1
      set rts-threshold 2347
      set max-clients 9
      set target-wake-time enable
      set bss-color-partial enable
      set mu-mimo enable
      set wlan-bridge yes
      set wlan-members
      config ap-security
          set security-mode WPA2-Personal
          set pmf required
          set passphrase ******
      end
    next
  end
end
Parameter Description Type Size Default
ssid IEEE 802.11 service set identifier (SSID) for the wireless interface. Users who wish to use the wireless network must configure their computers to access this SSID name. string -
broadcast-ssid Enable/disable broadcasting the SSID option -

Option Description
enable Enable broadcasting the SSID.
disable Disable broadcasting the SSID.

dtim

Wi-Fi Delivery Traffic Indication Map (DTIM) integer 1-255

rts-threshold

Maximum packet size for RTS transmissions. integer 256-2347
max-clients Maximum number of clients that can connect simultaneously to the VAP. integer 0-512
target-wake-time Enable/disable 802.11ax target wake time. option

Option Description
enable Enable 802.11ax target wake time.
disable Disable 802.11ax target wake time.
bss-color-partial Enable/disable 802.11ax partial BSS color. option

Option Description
enable Enable 802.11ax partial BSS color.
disable Disable 802.11ax partial BSS color.
mu-mimo Enable/disable Multi-user MIMO. option

Option Description
enable Enable Multi-user MIMO.
disable Disable Multi-user MIMO.
wlan-bridge Select if you want the SSID to act as a bridge between wireless and wired networks, integrating wireless devices into the same network. option

Option Description
yes Allow the SSID to act as a WLAN bridge.
no Do not allow the SSID to act as a WLAN bridge.

wlan-members

When WLAN Bridge is enabled, you can add WLAN members to the SSID configuration.

config vap

config vap

Description: Configure WiFi virtual access point.

config wifi
  config vap
    edit <WiFi Access Point Name>
      set ssid <string>
      set broadcast-ssid [enable | disable]
      set dtim {integer}
      set rts-threshold {integer}
      set max-clients {integer}
      set target-wake-time [enable | disable]
      set bss-color-partial [enable | disable]
      set mu-mimo [enable | disable]
      set wlan-bridge [yes |no ]
      set wlan-members
      config ap-security
        set security-mode <encryption mode>
      end
    next
  end
end
Sample command:
config wifi
  config vap
    edit fbs-home-2g-1
      set ssid fbs-home-2g-1
      set broadcast-ssid enable
      set dtim 1
      set rts-threshold 2347
      set max-clients 9
      set target-wake-time enable
      set bss-color-partial enable
      set mu-mimo enable
      set wlan-bridge no
      set wlan-members
      config ap-security
        set security-mode WPA2-Enterprise
        set auth-server-addr 192.168.11.99
        set auth-server-port 1812
        set auth-server-secret ******
        set pmf optional
      end
    next
    edit fbs-home-5g-1
      set ssid fbs-home-5g-1
      set broadcast-ssid enable
      set dtim 1
      set rts-threshold 2347
      set max-clients 9
      set target-wake-time enable
      set bss-color-partial enable
      set mu-mimo enable
      set wlan-bridge yes
      set wlan-members
      config ap-security
          set security-mode WPA2-Personal
          set pmf required
          set passphrase ******
      end
    next
  end
end
Parameter Description Type Size Default
ssid IEEE 802.11 service set identifier (SSID) for the wireless interface. Users who wish to use the wireless network must configure their computers to access this SSID name. string -
broadcast-ssid Enable/disable broadcasting the SSID option -

Option Description
enable Enable broadcasting the SSID.
disable Disable broadcasting the SSID.

dtim

Wi-Fi Delivery Traffic Indication Map (DTIM) integer 1-255

rts-threshold

Maximum packet size for RTS transmissions. integer 256-2347
max-clients Maximum number of clients that can connect simultaneously to the VAP. integer 0-512
target-wake-time Enable/disable 802.11ax target wake time. option

Option Description
enable Enable 802.11ax target wake time.
disable Disable 802.11ax target wake time.
bss-color-partial Enable/disable 802.11ax partial BSS color. option

Option Description
enable Enable 802.11ax partial BSS color.
disable Disable 802.11ax partial BSS color.
mu-mimo Enable/disable Multi-user MIMO. option

Option Description
enable Enable Multi-user MIMO.
disable Disable Multi-user MIMO.
wlan-bridge Select if you want the SSID to act as a bridge between wireless and wired networks, integrating wireless devices into the same network. option

Option Description
yes Allow the SSID to act as a WLAN bridge.
no Do not allow the SSID to act as a WLAN bridge.

wlan-members

When WLAN Bridge is enabled, you can add WLAN members to the SSID configuration.