Manual:IP/Hotspot/User

Applies to RouterOS: v3, v4, v5+

Users

Sub-menu: /ip hotspot user

This is the menu, where client's user/password information is actually added, additional configuration options for HotSpot users are configured here as well.

Properties

Property	Description
address (IP; Default: 0.0.0.0)	IP address, when specified client will get the address from the HotSpot one-to-one NAT translations. Address does not restrict HotSpot login only from this address
comment (string; Default: )	descriptive information for HotSpot user, it might be used for scripts to change parameters for specific clients
email (string; Default: )	HotSpot client's e-mail, informational value for the HotSpot user
limit-bytes-in (integer; Default: 0)	Maximal amount of bytes that can be received from the user. User is disconnected from HotSpot after the limit is reached.
limit-bytes-out (integer; Default: 0)	Maximal amount of bytes that can be transmitted from the user. User is disconnected from HotSpot after the limit is reached.
limit-bytes-total (integer; Default: 0)	(limit-bytes-in+limit-bytes-out). User is disconnected from HotSpot after the limit is reached.
limit-uptime (time; Default: 0)	Uptime limit for the HotSpot client, user is disconnected from HotSpot as soon as uptime is reached.
mac-address (MAC; Default: 00:00:00:00:00:00)	Client is allowed to login only from the specified MAC-address. If value is 00:00:00:00:00:00, any mac address is allowed.
name (string; Default: )	HotSpot login page username, when MAC-address authentication is used name is configured as client's MAC-address
password (string; Default: )	User password
profile (string; Default: default)	User profile configured in /ip hotspot user profile
routes (string; Default: )	Routes added to HotSpot gateway when client is connected. The route format dst-address gateway metric (for example, 192.168.1.0/24 192.168.0.1 1)
server (string | all; Default: all)	HotSpot server's name to which user is allowed login

Read-only proterties

Property	Description
bytes-in (integer)
bytes-out (integer)
packets-in (integer)
packets-out (integer)
uptime (time)

User Profile

Sub-menu: /ip hotspot user profile

User profile menu is used for common HotSpot client settings. Profiles are like User groups with the same set of settings, rate-limit, filter chain name, etc.

Properties

Property	Description
address-list (string; Default: )
address-pool (string; Default: )
advertise (string; Default: )
advertise-interval (string; Default: )
advertise-timeout (string; Default: )
advertise-url (string; Default: )
idle-timeout (string; Default: )
incoming-filter (string; Default: )
incoming-packet-mark (string; Default: )
keepalive-timeout (string; Default: )
name (string; Default: )	Descriptive name of the profile
on-login (string; Default: )
on-logout (string; Default: )
open-status-page (string; Default: )
outgoing-filter (string; Default: )
outgoing-packet-mark (string; Default: )
rate-limit (string; Default: )
session-timeout (string; Default: )
shared-users (string; Default: )
status-autorefresh (string; Default: )
transparent-proxy (string; Default: )

[ Top | Back to Content ]