Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.2.1
Copy Link

Configure hotspot profile.

  config wireless-controller hotspot20 hs-profile
      Description: Configure hotspot profile.
      edit <name>
          set access-network-type [private-network|private-network-with-guest-access|...]
          set access-network-internet [enable|disable]
          set access-network-asra [enable|disable]
          set access-network-esr [enable|disable]
          set access-network-uesa [enable|disable]
          set venue-group [unspecified|assembly|...]
          set venue-type [unspecified|arena|...]
          set hessid {mac-address}
          set proxy-arp [enable|disable]
          set l2tif [enable|disable]
          set pame-bi [disable|enable]
          set anqp-domain-id {integer}
          set domain-name {string}
          set osu-ssid {string}
          set gas-comeback-delay {integer}
          set gas-fragmentation-limit {integer}
          set dgaf [enable|disable]
          set deauth-request-timeout {integer}
          set wnm-sleep-mode [enable|disable]
          set bss-transition [enable|disable]
          set venue-name {string}
          set roaming-consortium {string}
          set nai-realm {string}
          set oper-friendly-name {string}
          set osu-provider <name1>, <name2>, ...
          set wan-metrics {string}
          set network-auth {string}
          set 3gpp-plmn {string}
          set conn-cap {string}
          set qos-map {string}
          set ip-addr-type {string}
      next
  end

config wireless-controller hotspot20 hs-profile

Parameter Name Description Type Size
access-network-type Access network type.
private-network: Private network.
private-network-with-guest-access: Private network with guest access.
chargeable-public-network: Chargeable public network.
free-public-network: Free public network.
personal-device-network: Personal devices network.
emergency-services-only-network: Emergency services only network.
test-or-experimental: Test or experimental.
wildcard: Wildcard.
option -
access-network-internet Enable/disable connectivity to the Internet.
enable: Enable connectivity to the Internet.
disable: Disable connectivity to the Internet.
option -
access-network-asra Enable/disable additional step required for access (ASRA).
enable: Enable additional step required for access (ASRA).
disable: Disable additional step required for access (ASRA).
option -
access-network-esr Enable/disable emergency services reachable (ESR).
enable: Enable emergency services reachable (ESR).
disable: Disable emergency services reachable (ESR).
option -
access-network-uesa Enable/disable unauthenticated emergency service accessible (UESA).
enable: Enable unauthenticated emergency service accessible (UESA).
disable: Disable unauthenticated emergency service accessible (UESA).
option -
venue-group Venue group.
unspecified: Unspecified.
assembly: Assembly.
business: Business.
educational: Educational.
factory: Factory and industrial.
institutional: Institutional.
mercantile: Mercantile.
residential: Residential.
storage: Storage.
utility: Utility and miscellaneous.
vehicular: Vehicular.
outdoor: Outdoor.
option -
venue-type Venue type.
unspecified: Unspecified.
arena: Arena.
stadium: Stadium.
passenger-terminal: Passenger terminal.
amphitheater: Amphitheater.
amusement-park: Amusement park.
place-of-worship: Place of worship.
convention-center: Convention center.
library: Library.
museum: Museum.
restaurant: Restaurant.
theater: Theater.
bar: Bar.
coffee-shop: Coffee shop.
zoo-or-aquarium: Zoo or aquarium.
emergency-center: Emergency coordination center.
doctor-office: Doctor or dentist office.
bank: Bank.
fire-station: Fire station.
police-station: Police station.
post-office: Post office.
professional-office: Professional office.
research-facility: Research and development facility.
attorney-office: Attorney office.
primary-school: Primary school.
secondary-school: Secondary school.
university-or-college: University or college.
factory: Factory.
hospital: Hospital.
long-term-care-facility: Long term care facility.
rehab-center: Alcohol and drug rehabilitation center.
group-home: Group home.
prison-or-jail: Prison or jail.
retail-store: Retail store.
grocery-market: Grocery market.
auto-service-station: Auto service station.
shopping-mall: Shopping mall.
gas-station: Gas station.
private: Private residence.
hotel-or-motel: Hotel or motel.
dormitory: Dormitory.
boarding-house: Boarding house.
automobile: Automobile or truck.
airplane: Airplane.
bus: Bus.
ferry: Ferry.
ship-or-boat: Ship or boat.
train: Train.
motor-bike: Motor bike.
muni-mesh-network: Muni mesh network.
city-park: City park.
rest-area: Rest area.
traffic-control: Traffic control.
bus-stop: Bus stop.
kiosk: Kiosk.
option -
hessid Homogeneous extended service set identifier (HESSID). mac-address Not Specified
proxy-arp Enable/disable Proxy ARP.
enable: Enable Proxy ARP.
disable: Disable Proxy ARP.
option -
l2tif Enable/disable Layer 2 traffic inspection and filtering.
enable: Enable Layer 2 traffic inspection and filtering.
disable: Disable Layer 2 traffic inspection and filtering.
option -
pame-bi Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).
disable: Disable Pre-Association Message Exchange BSSID Independent (PAME-BI).
enable: Enable Pre-Association Message Exchange BSSID Independent (PAME-BI).
option -
anqp-domain-id ANQP Domain ID (0-65535). integer Minimum value: 0 Maximum value: 65535
domain-name Domain name. string Maximum length: 255
osu-ssid Online sign up (OSU) SSID. string Maximum length: 255
gas-comeback-delay GAS comeback delay (0 or 100 - 4000 milliseconds, default = 500). integer Minimum value: 100 Maximum value: 4000
gas-fragmentation-limit GAS fragmentation limit (512 - 4096, default = 1024). integer Minimum value: 512 Maximum value: 4096
dgaf Enable/disable downstream group-addressed forwarding (DGAF).
enable: Enable downstream group-addressed forwarding (DGAF).
disable: Disable downstream group-addressed forwarding (DGAF).
option -
deauth-request-timeout Deauthentication request timeout (in seconds). integer Minimum value: 30 Maximum value: 120
wnm-sleep-mode Enable/disable wireless network management (WNM) sleep mode.
enable: Enable wireless network management (WNM) sleep mode.
disable: Disable wireless network management (WNM) sleep mode.
option -
bss-transition Enable/disable basic service set (BSS) transition Support.
enable: Enable basic service set (BSS) transition support.
disable: Disable basic service set (BSS) transition support.
option -
venue-name Venue name. string Maximum length: 35
roaming-consortium Roaming consortium list name. string Maximum length: 35
nai-realm NAI realm list name. string Maximum length: 35
oper-friendly-name Operator friendly name. string Maximum length: 35
osu-provider <name> Manually selected list of OSU provider(s).
OSU provider name.
string Maximum length: 35
wan-metrics WAN metric name. string Maximum length: 35
network-auth Network authentication name. string Maximum length: 35
3gpp-plmn 3GPP PLMN name. string Maximum length: 35
conn-cap Connection capability name. string Maximum length: 35
qos-map QoS MAP set ID. string Maximum length: 35
ip-addr-type IP address type name. string Maximum length: 35

Configure hotspot profile.

  config wireless-controller hotspot20 hs-profile
      Description: Configure hotspot profile.
      edit <name>
          set access-network-type [private-network|private-network-with-guest-access|...]
          set access-network-internet [enable|disable]
          set access-network-asra [enable|disable]
          set access-network-esr [enable|disable]
          set access-network-uesa [enable|disable]
          set venue-group [unspecified|assembly|...]
          set venue-type [unspecified|arena|...]
          set hessid {mac-address}
          set proxy-arp [enable|disable]
          set l2tif [enable|disable]
          set pame-bi [disable|enable]
          set anqp-domain-id {integer}
          set domain-name {string}
          set osu-ssid {string}
          set gas-comeback-delay {integer}
          set gas-fragmentation-limit {integer}
          set dgaf [enable|disable]
          set deauth-request-timeout {integer}
          set wnm-sleep-mode [enable|disable]
          set bss-transition [enable|disable]
          set venue-name {string}
          set roaming-consortium {string}
          set nai-realm {string}
          set oper-friendly-name {string}
          set osu-provider <name1>, <name2>, ...
          set wan-metrics {string}
          set network-auth {string}
          set 3gpp-plmn {string}
          set conn-cap {string}
          set qos-map {string}
          set ip-addr-type {string}
      next
  end

config wireless-controller hotspot20 hs-profile

Parameter Name Description Type Size
access-network-type Access network type.
private-network: Private network.
private-network-with-guest-access: Private network with guest access.
chargeable-public-network: Chargeable public network.
free-public-network: Free public network.
personal-device-network: Personal devices network.
emergency-services-only-network: Emergency services only network.
test-or-experimental: Test or experimental.
wildcard: Wildcard.
option -
access-network-internet Enable/disable connectivity to the Internet.
enable: Enable connectivity to the Internet.
disable: Disable connectivity to the Internet.
option -
access-network-asra Enable/disable additional step required for access (ASRA).
enable: Enable additional step required for access (ASRA).
disable: Disable additional step required for access (ASRA).
option -
access-network-esr Enable/disable emergency services reachable (ESR).
enable: Enable emergency services reachable (ESR).
disable: Disable emergency services reachable (ESR).
option -
access-network-uesa Enable/disable unauthenticated emergency service accessible (UESA).
enable: Enable unauthenticated emergency service accessible (UESA).
disable: Disable unauthenticated emergency service accessible (UESA).
option -
venue-group Venue group.
unspecified: Unspecified.
assembly: Assembly.
business: Business.
educational: Educational.
factory: Factory and industrial.
institutional: Institutional.
mercantile: Mercantile.
residential: Residential.
storage: Storage.
utility: Utility and miscellaneous.
vehicular: Vehicular.
outdoor: Outdoor.
option -
venue-type Venue type.
unspecified: Unspecified.
arena: Arena.
stadium: Stadium.
passenger-terminal: Passenger terminal.
amphitheater: Amphitheater.
amusement-park: Amusement park.
place-of-worship: Place of worship.
convention-center: Convention center.
library: Library.
museum: Museum.
restaurant: Restaurant.
theater: Theater.
bar: Bar.
coffee-shop: Coffee shop.
zoo-or-aquarium: Zoo or aquarium.
emergency-center: Emergency coordination center.
doctor-office: Doctor or dentist office.
bank: Bank.
fire-station: Fire station.
police-station: Police station.
post-office: Post office.
professional-office: Professional office.
research-facility: Research and development facility.
attorney-office: Attorney office.
primary-school: Primary school.
secondary-school: Secondary school.
university-or-college: University or college.
factory: Factory.
hospital: Hospital.
long-term-care-facility: Long term care facility.
rehab-center: Alcohol and drug rehabilitation center.
group-home: Group home.
prison-or-jail: Prison or jail.
retail-store: Retail store.
grocery-market: Grocery market.
auto-service-station: Auto service station.
shopping-mall: Shopping mall.
gas-station: Gas station.
private: Private residence.
hotel-or-motel: Hotel or motel.
dormitory: Dormitory.
boarding-house: Boarding house.
automobile: Automobile or truck.
airplane: Airplane.
bus: Bus.
ferry: Ferry.
ship-or-boat: Ship or boat.
train: Train.
motor-bike: Motor bike.
muni-mesh-network: Muni mesh network.
city-park: City park.
rest-area: Rest area.
traffic-control: Traffic control.
bus-stop: Bus stop.
kiosk: Kiosk.
option -
hessid Homogeneous extended service set identifier (HESSID). mac-address Not Specified
proxy-arp Enable/disable Proxy ARP.
enable: Enable Proxy ARP.
disable: Disable Proxy ARP.
option -
l2tif Enable/disable Layer 2 traffic inspection and filtering.
enable: Enable Layer 2 traffic inspection and filtering.
disable: Disable Layer 2 traffic inspection and filtering.
option -
pame-bi Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).
disable: Disable Pre-Association Message Exchange BSSID Independent (PAME-BI).
enable: Enable Pre-Association Message Exchange BSSID Independent (PAME-BI).
option -
anqp-domain-id ANQP Domain ID (0-65535). integer Minimum value: 0 Maximum value: 65535
domain-name Domain name. string Maximum length: 255
osu-ssid Online sign up (OSU) SSID. string Maximum length: 255
gas-comeback-delay GAS comeback delay (0 or 100 - 4000 milliseconds, default = 500). integer Minimum value: 100 Maximum value: 4000
gas-fragmentation-limit GAS fragmentation limit (512 - 4096, default = 1024). integer Minimum value: 512 Maximum value: 4096
dgaf Enable/disable downstream group-addressed forwarding (DGAF).
enable: Enable downstream group-addressed forwarding (DGAF).
disable: Disable downstream group-addressed forwarding (DGAF).
option -
deauth-request-timeout Deauthentication request timeout (in seconds). integer Minimum value: 30 Maximum value: 120
wnm-sleep-mode Enable/disable wireless network management (WNM) sleep mode.
enable: Enable wireless network management (WNM) sleep mode.
disable: Disable wireless network management (WNM) sleep mode.
option -
bss-transition Enable/disable basic service set (BSS) transition Support.
enable: Enable basic service set (BSS) transition support.
disable: Disable basic service set (BSS) transition support.
option -
venue-name Venue name. string Maximum length: 35
roaming-consortium Roaming consortium list name. string Maximum length: 35
nai-realm NAI realm list name. string Maximum length: 35
oper-friendly-name Operator friendly name. string Maximum length: 35
osu-provider <name> Manually selected list of OSU provider(s).
OSU provider name.
string Maximum length: 35
wan-metrics WAN metric name. string Maximum length: 35
network-auth Network authentication name. string Maximum length: 35
3gpp-plmn 3GPP PLMN name. string Maximum length: 35
conn-cap Connection capability name. string Maximum length: 35
qos-map QoS MAP set ID. string Maximum length: 35
ip-addr-type IP address type name. string Maximum length: 35