Fortinet black logo

CLI Reference

config wireless-controller hotspot20 hs-profile

config wireless-controller hotspot20 hs-profile

Configure hotspot profile.

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

config wireless-controller hotspot20 hs-profile

Parameter

Description

Type

Size

3gpp-plmn

3GPP PLMN name.

string

Maximum length: 35

access-network-asra

Enable/disable additional step required for access (ASRA).

option

-

Option

Description

enable

Enable additional step required for access (ASRA).

disable

Disable additional step required for access (ASRA).

access-network-esr

Enable/disable emergency services reachable (ESR).

option

-

Option

Description

enable

Enable emergency services reachable (ESR).

disable

Disable emergency services reachable (ESR).

access-network-internet

Enable/disable connectivity to the Internet.

option

-

Option

Description

enable

Enable connectivity to the Internet.

disable

Disable connectivity to the Internet.

access-network-type

Access network type.

option

-

Option

Description

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.

access-network-uesa

Enable/disable unauthenticated emergency service accessible (UESA).

option

-

Option

Description

enable

Enable unauthenticated emergency service accessible (UESA).

disable

Disable unauthenticated emergency service accessible (UESA).

anqp-domain-id

ANQP Domain ID.

integer

Minimum value: 0 Maximum value: 65535

bss-transition

Enable/disable basic service set (BSS) transition Support.

option

-

Option

Description

enable

Enable basic service set (BSS) transition support.

disable

Disable basic service set (BSS) transition support.

conn-cap

Connection capability name.

string

Maximum length: 35

deauth-request-timeout

Deauthentication request timeout (in seconds).

integer

Minimum value: 30 Maximum value: 120

dgaf

Enable/disable downstream group-addressed forwarding (DGAF).

option

-

Option

Description

enable

Enable downstream group-addressed forwarding (DGAF).

disable

Disable downstream group-addressed forwarding (DGAF).

domain-name

Domain name.

string

Maximum length: 255

gas-comeback-delay

GAS comeback delay.

integer

Minimum value: 100 Maximum value: 4000

gas-fragmentation-limit

GAS fragmentation limit.

integer

Minimum value: 512 Maximum value: 4096

hessid

Homogeneous extended service set identifier (HESSID).

mac-address

Not Specified

ip-addr-type

IP address type name.

string

Maximum length: 35

l2tif

Enable/disable Layer 2 traffic inspection and filtering.

option

-

Option

Description

enable

Enable Layer 2 traffic inspection and filtering.

disable

Disable Layer 2 traffic inspection and filtering.

nai-realm

NAI realm list name.

string

Maximum length: 35

name

Hotspot profile name.

string

Maximum length: 35

network-auth

Network authentication 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

osu-ssid

Online sign up (OSU) SSID.

string

Maximum length: 255

pame-bi

Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).

option

-

Option

Description

disable

Disable Pre-Association Message Exchange BSSID Independent (PAME-BI).

enable

Enable Pre-Association Message Exchange BSSID Independent (PAME-BI).

proxy-arp

Enable/disable Proxy ARP.

option

-

Option

Description

enable

Enable Proxy ARP.

disable

Disable Proxy ARP.

qos-map

QoS MAP set ID.

string

Maximum length: 35

roaming-consortium

Roaming consortium list name.

string

Maximum length: 35

venue-group

Venue group.

option

-

Option

Description

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.

venue-name

Venue name.

string

Maximum length: 35

venue-type

Venue type.

option

-

Option

Description

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.

wan-metrics

WAN metric name.

string

Maximum length: 35

wnm-sleep-mode

Enable/disable wireless network management (WNM) sleep mode.

option

-

Option

Description

enable

Enable wireless network management (WNM) sleep mode.

disable

Disable wireless network management (WNM) sleep mode.

config wireless-controller hotspot20 hs-profile

Configure hotspot profile.

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

config wireless-controller hotspot20 hs-profile

Parameter

Description

Type

Size

3gpp-plmn

3GPP PLMN name.

string

Maximum length: 35

access-network-asra

Enable/disable additional step required for access (ASRA).

option

-

Option

Description

enable

Enable additional step required for access (ASRA).

disable

Disable additional step required for access (ASRA).

access-network-esr

Enable/disable emergency services reachable (ESR).

option

-

Option

Description

enable

Enable emergency services reachable (ESR).

disable

Disable emergency services reachable (ESR).

access-network-internet

Enable/disable connectivity to the Internet.

option

-

Option

Description

enable

Enable connectivity to the Internet.

disable

Disable connectivity to the Internet.

access-network-type

Access network type.

option

-

Option

Description

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.

access-network-uesa

Enable/disable unauthenticated emergency service accessible (UESA).

option

-

Option

Description

enable

Enable unauthenticated emergency service accessible (UESA).

disable

Disable unauthenticated emergency service accessible (UESA).

anqp-domain-id

ANQP Domain ID.

integer

Minimum value: 0 Maximum value: 65535

bss-transition

Enable/disable basic service set (BSS) transition Support.

option

-

Option

Description

enable

Enable basic service set (BSS) transition support.

disable

Disable basic service set (BSS) transition support.

conn-cap

Connection capability name.

string

Maximum length: 35

deauth-request-timeout

Deauthentication request timeout (in seconds).

integer

Minimum value: 30 Maximum value: 120

dgaf

Enable/disable downstream group-addressed forwarding (DGAF).

option

-

Option

Description

enable

Enable downstream group-addressed forwarding (DGAF).

disable

Disable downstream group-addressed forwarding (DGAF).

domain-name

Domain name.

string

Maximum length: 255

gas-comeback-delay

GAS comeback delay.

integer

Minimum value: 100 Maximum value: 4000

gas-fragmentation-limit

GAS fragmentation limit.

integer

Minimum value: 512 Maximum value: 4096

hessid

Homogeneous extended service set identifier (HESSID).

mac-address

Not Specified

ip-addr-type

IP address type name.

string

Maximum length: 35

l2tif

Enable/disable Layer 2 traffic inspection and filtering.

option

-

Option

Description

enable

Enable Layer 2 traffic inspection and filtering.

disable

Disable Layer 2 traffic inspection and filtering.

nai-realm

NAI realm list name.

string

Maximum length: 35

name

Hotspot profile name.

string

Maximum length: 35

network-auth

Network authentication 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

osu-ssid

Online sign up (OSU) SSID.

string

Maximum length: 255

pame-bi

Enable/disable Pre-Association Message Exchange BSSID Independent (PAME-BI).

option

-

Option

Description

disable

Disable Pre-Association Message Exchange BSSID Independent (PAME-BI).

enable

Enable Pre-Association Message Exchange BSSID Independent (PAME-BI).

proxy-arp

Enable/disable Proxy ARP.

option

-

Option

Description

enable

Enable Proxy ARP.

disable

Disable Proxy ARP.

qos-map

QoS MAP set ID.

string

Maximum length: 35

roaming-consortium

Roaming consortium list name.

string

Maximum length: 35

venue-group

Venue group.

option

-

Option

Description

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.

venue-name

Venue name.

string

Maximum length: 35

venue-type

Venue type.

option

-

Option

Description

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.

wan-metrics

WAN metric name.

string

Maximum length: 35

wnm-sleep-mode

Enable/disable wireless network management (WNM) sleep mode.

option

-

Option

Description

enable

Enable wireless network management (WNM) sleep mode.

disable

Disable wireless network management (WNM) sleep mode.