routeros 1.83.1, Apr 28 25

routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

routeros.IpHotspotUserProfile

Explore with Pulumi AI

routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";

const test = new routeros.IpHotspotUserProfile("test", {
    addMacCookie: true,
    addressList: "list-1",
    advertise: true,
    idleTimeout: "none",
    keepaliveTimeout: "2m",
    macCookieTimeout: "3d",
    sharedUsers: 3,
    statusAutorefresh: "2m",
    transparentProxy: true,
});

import pulumi
import pulumi_routeros as routeros

test = routeros.IpHotspotUserProfile("test",
    add_mac_cookie=True,
    address_list="list-1",
    advertise=True,
    idle_timeout="none",
    keepalive_timeout="2m",
    mac_cookie_timeout="3d",
    shared_users=3,
    status_autorefresh="2m",
    transparent_proxy=True)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/routeros/routeros"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := routeros.NewIpHotspotUserProfile(ctx, "test", &routeros.IpHotspotUserProfileArgs{
			AddMacCookie:      pulumi.Bool(true),
			AddressList:       pulumi.String("list-1"),
			Advertise:         pulumi.Bool(true),
			IdleTimeout:       pulumi.String("none"),
			KeepaliveTimeout:  pulumi.String("2m"),
			MacCookieTimeout:  pulumi.String("3d"),
			SharedUsers:       pulumi.Float64(3),
			StatusAutorefresh: pulumi.String("2m"),
			TransparentProxy:  pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Routeros = Pulumi.Routeros;

return await Deployment.RunAsync(() => 
{
    var test = new Routeros.IpHotspotUserProfile("test", new()
    {
        AddMacCookie = true,
        AddressList = "list-1",
        Advertise = true,
        IdleTimeout = "none",
        KeepaliveTimeout = "2m",
        MacCookieTimeout = "3d",
        SharedUsers = 3,
        StatusAutorefresh = "2m",
        TransparentProxy = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.IpHotspotUserProfile;
import com.pulumi.routeros.IpHotspotUserProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new IpHotspotUserProfile("test", IpHotspotUserProfileArgs.builder()
            .addMacCookie(true)
            .addressList("list-1")
            .advertise(true)
            .idleTimeout("none")
            .keepaliveTimeout("2m")
            .macCookieTimeout("3d")
            .sharedUsers(3)
            .statusAutorefresh("2m")
            .transparentProxy(true)
            .build());

    }
}

resources:
  test:
    type: routeros:IpHotspotUserProfile
    properties:
      addMacCookie: true
      addressList: list-1
      advertise: true
      idleTimeout: none
      keepaliveTimeout: 2m
      macCookieTimeout: 3d
      sharedUsers: 3
      statusAutorefresh: 2m
      transparentProxy: true

Create IpHotspotUserProfile Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IpHotspotUserProfile(name: string, args?: IpHotspotUserProfileArgs, opts?: CustomResourceOptions);

@overload
def IpHotspotUserProfile(resource_name: str,
                         args: Optional[IpHotspotUserProfileArgs] = None,
                         opts: Optional[ResourceOptions] = None)

@overload
def IpHotspotUserProfile(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         ___id_: Optional[float] = None,
                         ___path_: Optional[str] = None,
                         ___unset_: Optional[str] = None,
                         add_mac_cookie: Optional[bool] = None,
                         address_list: Optional[str] = None,
                         address_pool: Optional[str] = None,
                         advertise: Optional[bool] = None,
                         advertise_intervals: Optional[Sequence[str]] = None,
                         advertise_timeout: Optional[str] = None,
                         advertise_url: Optional[str] = None,
                         idle_timeout: Optional[str] = None,
                         incoming_filter: Optional[str] = None,
                         incoming_packet_mark: Optional[str] = None,
                         insert_queue_before: Optional[str] = None,
                         ip_hotspot_user_profile_id: Optional[str] = None,
                         keepalive_timeout: Optional[str] = None,
                         mac_cookie_timeout: Optional[str] = None,
                         name: Optional[str] = None,
                         on_login: Optional[str] = None,
                         on_logout: Optional[str] = None,
                         open_status_page: Optional[str] = None,
                         outgoing_filter: Optional[str] = None,
                         outgoing_packet_mark: Optional[str] = None,
                         parent_queue: Optional[str] = None,
                         queue_type: Optional[str] = None,
                         rate_limit: Optional[str] = None,
                         session_timeout: Optional[str] = None,
                         shared_users: Optional[float] = None,
                         status_autorefresh: Optional[str] = None,
                         transparent_proxy: Optional[bool] = None)

func NewIpHotspotUserProfile(ctx *Context, name string, args *IpHotspotUserProfileArgs, opts ...ResourceOption) (*IpHotspotUserProfile, error)

public IpHotspotUserProfile(string name, IpHotspotUserProfileArgs? args = null, CustomResourceOptions? opts = null)

public IpHotspotUserProfile(String name, IpHotspotUserProfileArgs args)
public IpHotspotUserProfile(String name, IpHotspotUserProfileArgs args, CustomResourceOptions options)

type: routeros:IpHotspotUserProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args IpHotspotUserProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args IpHotspotUserProfileArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args IpHotspotUserProfileArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IpHotspotUserProfileArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IpHotspotUserProfileArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

IpHotspotUserProfile Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IpHotspotUserProfile resource accepts the following input properties:

AddMacCookie bool: Allows to add mac cookie for users.
AddressList string: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
AddressPool string: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
Advertise bool: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
AdvertiseIntervals List<string>: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
AdvertiseTimeout string: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
AdvertiseUrl string: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
IdleTimeout string: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
IncomingFilter string: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
IncomingPacketMark string: Packet mark put on incoming packets from every user of this profile.
InsertQueueBefore string
IpHotspotUserProfileId string: The ID of this resource.
KeepaliveTimeout string: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
MacCookieTimeout string: Selects mac-cookie timeout from last login or logout. Read more>>.
Name string: Descriptive name of the profile.
OnLogin string: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
OnLogout string: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
OpenStatusPage string: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
OutgoingFilter string: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
OutgoingPacketMark string: Packet mark put on outgoing packets from every user of this profile.
ParentQueue string
QueueType string
RateLimit string: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
SessionTimeout string: Allowed session time for client. After this time, the user is logged out unconditionally.
SharedUsers double: Allowed number of simultaneously logged in users with the same HotSpot username.
StatusAutorefresh string: HotSpot status page autorefresh interval.
TransparentProxy bool: Use transparent HTTP proxy for the authorized users of this profile.
___id_ double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.

AddMacCookie bool: Allows to add mac cookie for users.
AddressList string: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
AddressPool string: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
Advertise bool: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
AdvertiseIntervals []string: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
AdvertiseTimeout string: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
AdvertiseUrl string: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
IdleTimeout string: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
IncomingFilter string: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
IncomingPacketMark string: Packet mark put on incoming packets from every user of this profile.
InsertQueueBefore string
IpHotspotUserProfileId string: The ID of this resource.
KeepaliveTimeout string: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
MacCookieTimeout string: Selects mac-cookie timeout from last login or logout. Read more>>.
Name string: Descriptive name of the profile.
OnLogin string: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
OnLogout string: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
OpenStatusPage string: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
OutgoingFilter string: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
OutgoingPacketMark string: Packet mark put on outgoing packets from every user of this profile.
ParentQueue string
QueueType string
RateLimit string: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
SessionTimeout string: Allowed session time for client. After this time, the user is logged out unconditionally.
SharedUsers float64: Allowed number of simultaneously logged in users with the same HotSpot username.
StatusAutorefresh string: HotSpot status page autorefresh interval.
TransparentProxy bool: Use transparent HTTP proxy for the authorized users of this profile.
___id_ float64: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.

___id_ Double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
addMacCookie Boolean: Allows to add mac cookie for users.
addressList String: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
addressPool String: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise Boolean: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertiseIntervals List<String>: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertiseTimeout String: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertiseUrl String: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
idleTimeout String: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incomingFilter String: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incomingPacketMark String: Packet mark put on incoming packets from every user of this profile.
insertQueueBefore String
ipHotspotUserProfileId String: The ID of this resource.
keepaliveTimeout String: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
macCookieTimeout String: Selects mac-cookie timeout from last login or logout. Read more>>.
name String: Descriptive name of the profile.
onLogin String: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
onLogout String: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
openStatusPage String: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoingFilter String: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoingPacketMark String: Packet mark put on outgoing packets from every user of this profile.
parentQueue String
queueType String
rateLimit String: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
sessionTimeout String: Allowed session time for client. After this time, the user is logged out unconditionally.
sharedUsers Double: Allowed number of simultaneously logged in users with the same HotSpot username.
statusAutorefresh String: HotSpot status page autorefresh interval.
transparentProxy Boolean: Use transparent HTTP proxy for the authorized users of this profile.

___id_ number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
addMacCookie boolean: Allows to add mac cookie for users.
addressList string: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
addressPool string: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise boolean: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertiseIntervals string[]: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertiseTimeout string: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertiseUrl string: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
idleTimeout string: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incomingFilter string: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incomingPacketMark string: Packet mark put on incoming packets from every user of this profile.
insertQueueBefore string
ipHotspotUserProfileId string: The ID of this resource.
keepaliveTimeout string: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
macCookieTimeout string: Selects mac-cookie timeout from last login or logout. Read more>>.
name string: Descriptive name of the profile.
onLogin string: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
onLogout string: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
openStatusPage string: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoingFilter string: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoingPacketMark string: Packet mark put on outgoing packets from every user of this profile.
parentQueue string
queueType string
rateLimit string: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
sessionTimeout string: Allowed session time for client. After this time, the user is logged out unconditionally.
sharedUsers number: Allowed number of simultaneously logged in users with the same HotSpot username.
statusAutorefresh string: HotSpot status page autorefresh interval.
transparentProxy boolean: Use transparent HTTP proxy for the authorized users of this profile.

___id_ float: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ str: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
add_mac_cookie bool: Allows to add mac cookie for users.
address_list str: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
address_pool str: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise bool: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertise_intervals Sequence[str]: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertise_timeout str: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertise_url str: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
idle_timeout str: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incoming_filter str: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incoming_packet_mark str: Packet mark put on incoming packets from every user of this profile.
insert_queue_before str
ip_hotspot_user_profile_id str: The ID of this resource.
keepalive_timeout str: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
mac_cookie_timeout str: Selects mac-cookie timeout from last login or logout. Read more>>.
name str: Descriptive name of the profile.
on_login str: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
on_logout str: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
open_status_page str: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoing_filter str: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoing_packet_mark str: Packet mark put on outgoing packets from every user of this profile.
parent_queue str
queue_type str
rate_limit str: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
session_timeout str: Allowed session time for client. After this time, the user is logged out unconditionally.
shared_users float: Allowed number of simultaneously logged in users with the same HotSpot username.
status_autorefresh str: HotSpot status page autorefresh interval.
transparent_proxy bool: Use transparent HTTP proxy for the authorized users of this profile.

___id_ Number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
addMacCookie Boolean: Allows to add mac cookie for users.
addressList String: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
addressPool String: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise Boolean: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertiseIntervals List<String>: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertiseTimeout String: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertiseUrl String: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
idleTimeout String: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incomingFilter String: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incomingPacketMark String: Packet mark put on incoming packets from every user of this profile.
insertQueueBefore String
ipHotspotUserProfileId String: The ID of this resource.
keepaliveTimeout String: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
macCookieTimeout String: Selects mac-cookie timeout from last login or logout. Read more>>.
name String: Descriptive name of the profile.
onLogin String: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
onLogout String: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
openStatusPage String: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoingFilter String: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoingPacketMark String: Packet mark put on outgoing packets from every user of this profile.
parentQueue String
queueType String
rateLimit String: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
sessionTimeout String: Allowed session time for client. After this time, the user is logged out unconditionally.
sharedUsers Number: Allowed number of simultaneously logged in users with the same HotSpot username.
statusAutorefresh String: HotSpot status page autorefresh interval.
transparentProxy Boolean: Use transparent HTTP proxy for the authorized users of this profile.

Outputs

All input properties are implicitly available as output properties. Additionally, the IpHotspotUserProfile resource produces the following output properties:

Default bool: It's the default item.
Id string: The provider-assigned unique ID for this managed resource.

Default bool: It's the default item.
Id string: The provider-assigned unique ID for this managed resource.

default_ Boolean: It's the default item.
id String: The provider-assigned unique ID for this managed resource.

default boolean: It's the default item.
id string: The provider-assigned unique ID for this managed resource.

default bool: It's the default item.
id str: The provider-assigned unique ID for this managed resource.

default Boolean: It's the default item.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing IpHotspotUserProfile Resource

Get an existing IpHotspotUserProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IpHotspotUserProfileState, opts?: CustomResourceOptions): IpHotspotUserProfile

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        ___unset_: Optional[str] = None,
        add_mac_cookie: Optional[bool] = None,
        address_list: Optional[str] = None,
        address_pool: Optional[str] = None,
        advertise: Optional[bool] = None,
        advertise_intervals: Optional[Sequence[str]] = None,
        advertise_timeout: Optional[str] = None,
        advertise_url: Optional[str] = None,
        default: Optional[bool] = None,
        idle_timeout: Optional[str] = None,
        incoming_filter: Optional[str] = None,
        incoming_packet_mark: Optional[str] = None,
        insert_queue_before: Optional[str] = None,
        ip_hotspot_user_profile_id: Optional[str] = None,
        keepalive_timeout: Optional[str] = None,
        mac_cookie_timeout: Optional[str] = None,
        name: Optional[str] = None,
        on_login: Optional[str] = None,
        on_logout: Optional[str] = None,
        open_status_page: Optional[str] = None,
        outgoing_filter: Optional[str] = None,
        outgoing_packet_mark: Optional[str] = None,
        parent_queue: Optional[str] = None,
        queue_type: Optional[str] = None,
        rate_limit: Optional[str] = None,
        session_timeout: Optional[str] = None,
        shared_users: Optional[float] = None,
        status_autorefresh: Optional[str] = None,
        transparent_proxy: Optional[bool] = None) -> IpHotspotUserProfile

func GetIpHotspotUserProfile(ctx *Context, name string, id IDInput, state *IpHotspotUserProfileState, opts ...ResourceOption) (*IpHotspotUserProfile, error)

public static IpHotspotUserProfile Get(string name, Input<string> id, IpHotspotUserProfileState? state, CustomResourceOptions? opts = null)

public static IpHotspotUserProfile get(String name, Output<String> id, IpHotspotUserProfileState state, CustomResourceOptions options)

resources:  _:    type: routeros:IpHotspotUserProfile    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AddMacCookie bool: Allows to add mac cookie for users.
AddressList string: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
AddressPool string: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
Advertise bool: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
AdvertiseIntervals List<string>: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
AdvertiseTimeout string: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
AdvertiseUrl string: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
Default bool: It's the default item.
IdleTimeout string: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
IncomingFilter string: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
IncomingPacketMark string: Packet mark put on incoming packets from every user of this profile.
InsertQueueBefore string
IpHotspotUserProfileId string: The ID of this resource.
KeepaliveTimeout string: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
MacCookieTimeout string: Selects mac-cookie timeout from last login or logout. Read more>>.
Name string: Descriptive name of the profile.
OnLogin string: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
OnLogout string: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
OpenStatusPage string: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
OutgoingFilter string: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
OutgoingPacketMark string: Packet mark put on outgoing packets from every user of this profile.
ParentQueue string
QueueType string
RateLimit string: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
SessionTimeout string: Allowed session time for client. After this time, the user is logged out unconditionally.
SharedUsers double: Allowed number of simultaneously logged in users with the same HotSpot username.
StatusAutorefresh string: HotSpot status page autorefresh interval.
TransparentProxy bool: Use transparent HTTP proxy for the authorized users of this profile.
___id_ double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.

AddMacCookie bool: Allows to add mac cookie for users.
AddressList string: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
AddressPool string: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
Advertise bool: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
AdvertiseIntervals []string: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
AdvertiseTimeout string: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
AdvertiseUrl string: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
Default bool: It's the default item.
IdleTimeout string: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
IncomingFilter string: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
IncomingPacketMark string: Packet mark put on incoming packets from every user of this profile.
InsertQueueBefore string
IpHotspotUserProfileId string: The ID of this resource.
KeepaliveTimeout string: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
MacCookieTimeout string: Selects mac-cookie timeout from last login or logout. Read more>>.
Name string: Descriptive name of the profile.
OnLogin string: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
OnLogout string: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
OpenStatusPage string: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
OutgoingFilter string: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
OutgoingPacketMark string: Packet mark put on outgoing packets from every user of this profile.
ParentQueue string
QueueType string
RateLimit string: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
SessionTimeout string: Allowed session time for client. After this time, the user is logged out unconditionally.
SharedUsers float64: Allowed number of simultaneously logged in users with the same HotSpot username.
StatusAutorefresh string: HotSpot status page autorefresh interval.
TransparentProxy bool: Use transparent HTTP proxy for the authorized users of this profile.
___id_ float64: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.

___id_ Double: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
addMacCookie Boolean: Allows to add mac cookie for users.
addressList String: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
addressPool String: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise Boolean: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertiseIntervals List<String>: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertiseTimeout String: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertiseUrl String: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
default_ Boolean: It's the default item.
idleTimeout String: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incomingFilter String: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incomingPacketMark String: Packet mark put on incoming packets from every user of this profile.
insertQueueBefore String
ipHotspotUserProfileId String: The ID of this resource.
keepaliveTimeout String: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
macCookieTimeout String: Selects mac-cookie timeout from last login or logout. Read more>>.
name String: Descriptive name of the profile.
onLogin String: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
onLogout String: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
openStatusPage String: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoingFilter String: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoingPacketMark String: Packet mark put on outgoing packets from every user of this profile.
parentQueue String
queueType String
rateLimit String: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
sessionTimeout String: Allowed session time for client. After this time, the user is logged out unconditionally.
sharedUsers Double: Allowed number of simultaneously logged in users with the same HotSpot username.
statusAutorefresh String: HotSpot status page autorefresh interval.
transparentProxy Boolean: Use transparent HTTP proxy for the authorized users of this profile.

___id_ number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
addMacCookie boolean: Allows to add mac cookie for users.
addressList string: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
addressPool string: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise boolean: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertiseIntervals string[]: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertiseTimeout string: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertiseUrl string: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
default boolean: It's the default item.
idleTimeout string: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incomingFilter string: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incomingPacketMark string: Packet mark put on incoming packets from every user of this profile.
insertQueueBefore string
ipHotspotUserProfileId string: The ID of this resource.
keepaliveTimeout string: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
macCookieTimeout string: Selects mac-cookie timeout from last login or logout. Read more>>.
name string: Descriptive name of the profile.
onLogin string: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
onLogout string: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
openStatusPage string: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoingFilter string: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoingPacketMark string: Packet mark put on outgoing packets from every user of this profile.
parentQueue string
queueType string
rateLimit string: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
sessionTimeout string: Allowed session time for client. After this time, the user is logged out unconditionally.
sharedUsers number: Allowed number of simultaneously logged in users with the same HotSpot username.
statusAutorefresh string: HotSpot status page autorefresh interval.
transparentProxy boolean: Use transparent HTTP proxy for the authorized users of this profile.

___id_ float: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ str: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
add_mac_cookie bool: Allows to add mac cookie for users.
address_list str: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
address_pool str: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise bool: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertise_intervals Sequence[str]: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertise_timeout str: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertise_url str: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
default bool: It's the default item.
idle_timeout str: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incoming_filter str: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incoming_packet_mark str: Packet mark put on incoming packets from every user of this profile.
insert_queue_before str
ip_hotspot_user_profile_id str: The ID of this resource.
keepalive_timeout str: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
mac_cookie_timeout str: Selects mac-cookie timeout from last login or logout. Read more>>.
name str: Descriptive name of the profile.
on_login str: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
on_logout str: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
open_status_page str: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoing_filter str: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoing_packet_mark str: Packet mark put on outgoing packets from every user of this profile.
parent_queue str
queue_type str
rate_limit str: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
session_timeout str: Allowed session time for client. After this time, the user is logged out unconditionally.
shared_users float: Allowed number of simultaneously logged in users with the same HotSpot username.
status_autorefresh str: HotSpot status page autorefresh interval.
transparent_proxy bool: Use transparent HTTP proxy for the authorized users of this profile.

___id_ Number: Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String: Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String: A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
addMacCookie Boolean: Allows to add mac cookie for users.
addressList String: Name of the address list in which users IP address will be added. Useful to mark traffic per user groups for queue tree configurations.
addressPool String: IP pool name from which the user will get IP. When user has improper network settings configuration on the computer, HotSpot server makes translation and assigns correct IP address from the pool instead of incorrect one.
advertise Boolean: Enable forced advertisement popups. After certain interval specific web-page is being displayed for HotSpot users. Advertisement page might be blocked by browsers popup blockers.
advertiseIntervals List<String>: Set of intervals between advertisement popups. After the list is done, the last value is used for all further advertisements, 10 minutes.
advertiseTimeout String: How long advertisement is shown, before blocking network access for HotSpot client. Connection to Internet is not allowed, when advertisement is not shown.
advertiseUrl String: List of URLs that is show for advertisement popups. After the last URL is used, list starts from the begining.
default Boolean: It's the default item.
idleTimeout String: Maximal period of inactivity for authorized HotSpot clients. Timer is counting, when there is no traffic coming from that client and going through the router, for example computer is switched off. User is logged out, dropped of the host list, the address used by the user is freed, when timeout is reached.
incomingFilter String: Name of the firewall chain applied to incoming packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
incomingPacketMark String: Packet mark put on incoming packets from every user of this profile.
insertQueueBefore String
ipHotspotUserProfileId String: The ID of this resource.
keepaliveTimeout String: Keepalive timeout for authorized HotSpot clients. Used to detect, that the computer of the client is alive and reachable. User is logged out, when timeout value is reached.
macCookieTimeout String: Selects mac-cookie timeout from last login or logout. Read more>>.
name String: Descriptive name of the profile.
onLogin String: Script name to be executed, when user logs in to the HotSpot from the particular profile. It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall' is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface.
onLogout String: Script name to be executed, when user logs out from the HotSpot.It is possible to get username from internal user and interface variable. For example, :log info User $user logged in! . If hotspot is set on bridge interface, then interface variable will show bridge as actual interface unless use-ip-firewall is set in bridge settings. List of available variables: $user $username (alternative var name for $user) $address $mac-address $interface $cause Starting with v6.34rc11 some additional variables are available: $uptime-secs - final session time in seconds $bytes-in - bytes uploaded $bytes-out - bytes downloaded $bytes-total - bytes up + bytes down $packets-in - packets uploaded $packets-out - packets downloaded $packets-total - packets up + packets down.
openStatusPage String: Option to show status page for user authenticated with mac login method. For example to show advertisement on status page (alogin.html) http-login - open status page only for HTTP login (includes cookie and HTTPS) always - open HTTP status page in case of mac login as well.
outgoingFilter String: Name of the firewall chain applied to outgoing packets from the users of this profile, jump rule is required from built-in chain (input, forward, output) to chain=hotspot.
outgoingPacketMark String: Packet mark put on outgoing packets from every user of this profile.
parentQueue String
queueType String
rateLimit String: Simple dynamic queue is created for user, once it logs in to the HotSpot. Rate-limitation is configured in the following 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]]]]. For example, to set 1M download, 512k upload for the client, rate-limit=512k/1M.
sessionTimeout String: Allowed session time for client. After this time, the user is logged out unconditionally.
sharedUsers Number: Allowed number of simultaneously logged in users with the same HotSpot username.
statusAutorefresh String: HotSpot status page autorefresh interval.
transparentProxy Boolean: Use transparent HTTP proxy for the authorized users of this profile.

Import

#The ID can be found via API or the terminal

#The command for the terminal is -> :put [/ip/hotspot/user/profile get [print show-ids]]

$ pulumi import routeros:index/ipHotspotUserProfile:IpHotspotUserProfile test *3

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: routeros terraform-routeros/terraform-provider-routeros
License
Notes: This Pulumi package is based on the routeros Terraform Provider.

routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

routeros.IpHotspotUserProfile

On this page

On this page

Example Usage

Create IpHotspotUserProfile Resource

Constructor syntax

Parameters

IpHotspotUserProfile Resource Properties

Inputs

Outputs

Look up Existing IpHotspotUserProfile Resource

Import

Package Details

On this page

On this page