hotspot

---

ip/hotspot

Package: hotspot
Type: Directory

Flag	Name	Description
X	disabled	disabled
I	invalid	invalid
S	HTTPS	HTTPS

Argument	Type	Description
name	string
interface ( mandatory )	alt { iface_enum , iface_enum }
address-pool	enum (none)
profile	enum
idle-timeout	alt { enum (none) { none:0 } , time }
keepalive-timeout	alt { enum (none) { none:0 } , time }
login-timeout	alt { enum (none) { none:0 } , time }
addresses-per-mac	enum (unlimited)

Read-only Argument	Type	Description
ip-of-dns-name	ipAddr
proxy-status	string

ip/hotspot/active

Package: hotspot
Type: Directory

Flag	Name	Description
R	radius	radius
B	blocked	blocked

Read-only Argument	Type	Description
server	enum
user	string
domain	string
address	ipAddr
mac-address	macAddr
login-by	string
uptime	time
session-time-left	time
idle-time	time
idle-timeout	time
keepalive-timeout	time
bytes-in	num
bytes-out	num
packets-in	num
packets-out	num
limit-bytes-in	num
limit-bytes-out	num
limit-bytes-total	num
advertisement	enum (disabled | sleeping | pending | pending,block)

ip/hotspot/active/login

Package: hotspot
Type: Command

Argument	Type	Description
ip	ipAddr
mac-address	macAddr
user	string
password	string
domain	string

ip/hotspot/cookie

Package: hotspot
Type: Directory

Flag	Name	Description
M	mac-cookie	mac-cookie

Read-only Argument	Type	Description
user	string
domain	string
mac-address	macAddr
expires-in	time

ip/hotspot/host

Package: hotspot
Type: Directory

Flag	Name	Description
S	static	static
H	DHCP	DHCP
D	dynamic	dynamic
A	authorized	authorized
P	bypassed	bypassed

Read-only Argument	Type	Description
mac-address	macAddr
address	ipAddr
to-address	ipAddr
server	enum
uptime	time
idle-time	time
idle-timeout	time
keepalive-timeout	time
host-dead-time	time
bridge-port	iface_enum
vlan-id	num
http-proxy	composite { , }
bytes-in	num
bytes-out	num
packets-in	num
packets-out	num
found-by	string

ip/hotspot/host/make-binding

Package: hotspot
Type: Command

Argument	Type	Description
comment	string
type	enum (regular | bypassed | blocked)

ip/hotspot/ip-binding

Package: hotspot
Type: Directory

Flag	Name	Description
X	disabled	disabled
P	bypassed	bypassed
B	blocked	blocked

Argument	Type	Description
mac-address	macAddr
address	ipRange { }
to-address	ipAddr
server	enum (all)
type	enum (regular | bypassed | blocked)

ip/hotspot/profile

Package: hotspot
Type: Directory

Flag	Name	Description
*	default	default

Argument	Type	Description
name	string
hotspot-address	ipAddr
dns-name	string
html-directory	file { }
html-directory-override	file
install-hotspot-queue	bool
rate-limit	string { }
http-proxy	composite { , }
smtp-server	ipAddr
login-by	ubit (mac, cookie, http-chap, https, http-pap, trial, mac-cookie)
mac-auth-mode	enum (mac-as-username | mac-as-username-and-password)
mac-auth-password	string { , }
http-cookie-lifetime	time { }
ssl-certificate	enum (none)
split-user-domain	bool { }
trial-uptime-limit	time { }
trial-uptime-reset	time { }
trial-user-profile	enum ()
use-radius	bool
radius-accounting	bool { }
radius-interim-update	alt { , , enum (received) { received:0 } , time }
nas-port-type	enum (ethernet | cable | wireless-802.11)
radius-default-domain	string { }
radius-location-id	string { }
radius-location-name	string { }
radius-mac-format	enum (XX:XX:XX:XX:XX:XX | XXXX:XXXX:XXXX | XXXXXX:XXXXXX | XX-XX-XX-XX-XX-XX | XXXXXX-XXXXXX | XXXXXXXXXXXX | XX XX XX XX XX XX)

ip/hotspot/reset-html

Package: hotspot
Type: Command

ip/hotspot/service-port

Package: hotspot
Type: Directory

Flag	Name	Description
X	disabled	disabled

Argument	Type	Description
ports	multi { num [1 .. 65535] }

Read-only Argument	Type	Description
name	string

ip/hotspot/user

Package: hotspot
Type: Directory

Flag	Name	Description
*	default	default
X	disabled	disabled
D	dynamic	dynamic

Argument	Type	Description
server	enum (all)
name ( mandatory )	string
password	string
otp-secret	string
address	ipAddr
mac-address	macAddr
profile	enum
routes	string
email	string
limit-uptime	time
limit-bytes-in	num
limit-bytes-out	num
limit-bytes-total	num

Read-only Argument	Type	Description
uptime	time
bytes-in	num
bytes-out	num
packets-in	num
packets-out	num

ip/hotspot/user/profile

Package: hotspot
Type: Directory

Flag	Name	Description
*	default	default

Argument	Type	Description
name	string
address-pool	enum (none)
session-timeout	time
idle-timeout	super { alt { enum (none) { none:0 } , time } { enum (none) { none:0 } , time } }
keepalive-timeout	super { alt { enum (none) { none:0 } , time } { enum (none) { none:0 } , time } }
status-autorefresh	alt { enum (none) { none:0 } , time }
shared-users	enum (unlimited)
add-mac-cookie	bool
mac-cookie-timeout	time
rate-limit	string
insert-queue-before	super { enum (bottom | first) { bottom:0xffffffff, first:0 } }
parent-queue	super { enum (none) { none:0 } }
queue-type	super { enum }
address-list	multi { string }
incoming-filter	string
outgoing-filter	string
incoming-packet-mark	string
outgoing-packet-mark	string
on-login	alt { , string }
on-logout	alt { , string }
transparent-proxy	bool
open-status-page	bool { }
advertise	bool { }
advertise-url	multi { , string }
advertise-interval	multi { , time }
advertise-timeout	alt { , enum (immediately | never) { immediately:0, never:0xffffffff } , time }

ip/hotspot/user/reset-counters

Package: hotspot
Type: Command

ip/hotspot/walled-garden

Package: hotspot
Type: Directory

Flag	Name	Description
X	disabled	disabled
D	dynamic	dynamic

Argument	Type	Description
server	super { ! , enum }
src-address	super { ! , ipRange }
method	super { ! , enum (GET | HEAD | POST | PUT | CONNECT | OPTIONS | DELETE | TRACE) { GET, HEAD, POST, PUT, CONNECT, OPTIONS, DELETE, TRACE } }
dst-host	super { ! , string }
dst-port	super { ! , multi { , , range [ .. 65535] } { , , range [ .. 65535] } }
path	super { ! , string }
action	enum (allow | deny)

Read-only Argument	Type	Description
dst-address	super { ! , ipRange }
hits	num

ip/hotspot/walled-garden/ip

Package: hotspot
Type: Directory

Flag	Name	Description
X	disabled	disabled
I	invalid	invalid

Argument	Type	Description
server	super { ! , enum }
src-address	super { ! , ipRange }
dst-address	super { ! , ipRange }
dst-host	string
protocol	super { ! , enum () { } }
dst-port	super { ! , num [0 .. 65535] , -num [0 .. 65535] }
src-address-list	super { ! , enum }
dst-address-list	super { ! , enum }
action	enum (accept | drop | reject)

ip/hotspot/walled-garden/reset-counters

Package: hotspot
Type: Command

ip/hotspot/walled-garden/reset-counters-all

Package: hotspot
Type: Command