HotSpot users is menu, where client user/password information is actually added, additional configuration options for HotSpot users are configured here as well.
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===
===Properties===
Line 17:
Line 17:
}}
}}
{{Mr-arg-table-end
{{Mr-arg-table
|arg=-
|arg=address
|type=IP
|default=0.0.0.0
|desc=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
}}
{{Mr-arg-table
|arg=comment
|type=string
|default=
|desc=descriptive information for HotSpot user, it might be used for scripts to change parameters for specific clients
}}
{{Mr-arg-table
|arg=email
|type=string
|default=
|desc=HotSpot client's e-mail, informational value for the HotSpot user
}}
{{Mr-arg-table
|arg=limit-bytes-in
|type=integer
|default=0
|desc=Maximal amount of bytes that can be received from the user. User is disconnected from HotSpot after the limit is reached.
}}
{{Mr-arg-table
|arg=limit-bytes-out
|type=integer
|default=0
|desc=Maximal amount of bytes that can be transmitted from the user. User is disconnected from HotSpot after the limit is reached.
}}
{{Mr-arg-table
|arg=limit-bytes-total
|type=integer
|default=0
|desc=(limit-bytes-in+limit-bytes-out). User is disconnected from HotSpot after the limit is reached.
}}
{{Mr-arg-table
|arg=limit-uptime
|type=time
|default=0
|desc=Uptime limit for the HotSpot client, user is disconnected from HotSpot as soon as uptime is reached.
}}
{{Mr-arg-table
|arg=mac-address
|type=MAC
|default=00:00:00:00:00:00
|desc=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.
}}
{{Mr-arg-table
|arg=name
|type=string
|default=
|desc=HotSpot login page username, when MAC-address authentication is used name is configured as client's MAC-address
}}
{{Mr-arg-table
|arg=password
|type=string
|default=
|desc=User password
}}
{{Mr-arg-table
|arg=profile
|type=string
|default=default
|desc=User profile configured in [[#User Profile | ''/ip hotspot user profile'']]
}}
{{Mr-arg-table
|arg=routes
|type=string
|type=string
|default=
|default=
|desc=
|desc=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'')
}}
{{Mr-arg-table-end
|arg=server
|type=string {{!}} all
|default=all
|desc=HotSpot server's name to which user is allowed login
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
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
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.
