profile
ip/hotspot/user/profile
Type: Directory
The /ip/hotspot/user/profile menu lists the user profiles. A profile holds the settings that users share: the rate limit, the timeouts, the number of devices, the address list, and the login and logout scripts. See the HotSpot guide.
| Flag | Name | Description |
|---|---|---|
| * | default | The default profile. It cannot be removed. |
| Argument | Type | Description |
|---|---|---|
| name | string | Name of the profile. |
| address-pool | enum (none) { none:0 } | IP pool from which the users of the profile get their address through the HotSpot address translation. Default: none. |
| session-timeout | time | Time after which a user is logged out. The user can log in again. 0s - no limit. |
| idle-timeout | super { idle-timeout: alt { symbolic-names: enum (none) { none:0 } , time-interval: time } } | Time without traffic from a logged-in user after which the user is logged out. Default: none. |
| keepalive-timeout | super { keepalive-timeout: alt { symbolic-names: enum (none) { none:0 } , time-interval: time } } | Time for which the device of a logged-in user can be unreachable before the user is logged out. Default: 2m. |
| status-autorefresh | alt { symbolic-names: enum (none) { none:0 } , time-interval: time } | Refresh interval of the status page. Default: 1m. |
| shared-users | enum (unlimited) { unlimited:0 } | Number of devices that can be logged in with the same user name at the same time. Default: 1. |
| add-mac-cookie | bool | Whether to create a MAC cookie for the users of the profile, for the mac-cookie login method. Default: yes. |
| mac-cookie-timeout | time | Time for which a MAC cookie is valid. Default: 3d. |
| rate-limit | string | Rate limit in the form rx-rate[/tx-rate] [rx-burst-rate[/tx-burst-rate] [rx-burst-threshold[/tx-burst-threshold] [rx-burst-time[/tx-burst-time] [priority] [rx-rate-min[/tx-rate-min]]]]]. rx is what the router receives from the user (upload), tx is what it sends to the user (download). For example, 512k/2M limits upload to 512 kbps and download to 2 Mbps. The router creates a dynamic simple queue with this limit for each logged-in user. |
| insert-queue-before | super { queue: enum (bottom | first) { bottom:0xffffffff, first:0 } } | Position of the dynamic simple queue of a user in the queue list: first, bottom, or the name of a queue before which it is placed. |
| parent-queue | super { queue: enum (none) { none:0 } } | Parent of the dynamic simple queue of a user. Default: none. |
| queue-type | super { queue: enum } | Queue type of the dynamic simple queue of a user. |
| address-list | multi { address-list: string } | Firewall address lists to which the address of each logged-in user is added. |
| incoming-filter | string | Firewall filter chain for the packets from the users of the profile. Add a jump rule from the hotspot chain to this chain. |
| outgoing-filter | string | Firewall filter chain for the packets to the users of the profile. Add a jump rule from the hotspot chain to this chain. |
| incoming-packet-mark | string | Packet mark for the packets from the users of the profile. |
| outgoing-packet-mark | string | Packet mark for the packets to the users of the profile. |
| on-login | alt { script: string } | Script that runs when a user of the profile logs in. It can use the variables $user, $username, $address, $"mac-address", and $interface. |
| on-logout | alt { script: string } | Script that runs when a user of the profile logs out. In addition to the on-login variables it can use $cause, $"uptime-secs", $"bytes-in", $"bytes-out", $"bytes-total", $"packets-in", $"packets-out", and $"packets-total". |
| transparent-proxy | bool | Whether to send the HTTP requests of the logged-in users of the profile through the HotSpot proxy. Default: no. |
| open-status-page | enum (http-login | always) | When to open the status page after login: always - also after a mac login; http-login - only after a login on the login page. |
| advertise | bool | Whether to show advertisement pages to the users of the profile. Default: no. |
| advertise-url | multi { url: string } | URLs of the advertisement pages. After the last one, the list starts again. |
| advertise-interval | multi { time-interval: time } | Intervals between the advertisements. After the list ends, the last value is used. |
| advertise-timeout | alt { symbolic-names: enum (immediately | never) { immediately:0, never:0xffffffff } , time-interval: time } | Time to wait for the advertisement to be shown before the network access of the user is blocked: a time, immediately, or never. |