Skip to main content
Version: 7.26

user


ip/hotspot/user​

Type: Directory

The /ip/hotspot/user menu lists the users that the HotSpot authenticates from the router itself, with their limits and counters. See the HotSpot guide.

FlagNameDescription
*defaultThe default entry, default-trial. It holds the counters and limits of trial users.
XdisabledThe user is disabled.
DdynamicThe user is dynamic, for example a trial user.
ArgumentTypeDescription
serverenum (all) { all:0 }HotSpot server on which the user can log in. Default: all.
name ( mandatory )stringUser name. For the mac login method, the MAC address of the device.
passwordstringPassword of the user.
otp-secretstringSecret for the time-based one-time passwords of the user.
addressipAddrIP address that the device of the user gets through the HotSpot address translation. The user can still log in from any address.
mac-addressmacAddrMAC address from which the user can log in. 00:00:00:00:00:00 - any MAC address.
profileenumUser profile from /ip/hotspot/user/profile. Default: default.
routesstringRoutes that are added while the user is logged in, in the form dst-address gateway metric, for example 192.168.1.0/24 192.168.0.1 1.
emailstringE-mail address of the user. Informational.
limit-uptimetimeTotal time for which the user can be logged in, over all sessions. When it is reached, the user is logged out and cannot log in. 0s - no limit.
limit-bytes-innumNumber of bytes that the user can send, over all sessions. When it is reached, the user is logged out and cannot log in. 0 - no limit.
limit-bytes-outnumNumber of bytes that the user can receive, over all sessions. When it is reached, the user is logged out and cannot log in. 0 - no limit.
limit-bytes-totalnumNumber of bytes that the user can send and receive together, over all sessions. When it is reached, the user is logged out and cannot log in. 0 - no limit.
Read-only ArgumentTypeDescription
uptimetimeTime for which the user has been logged in, over all sessions.
bytes-innumBytes received from the user, over all sessions.
bytes-outnumBytes sent to the user, over all sessions.
packets-innumPackets received from the user, over all sessions.
packets-outnumPackets sent to the user, over all sessions.