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.IpHotspotProfile

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.IpHotspotProfile("test", {
    loginBies: [
        "mac",
        "https",
        "trial",
    ],
    useRadius: true,
});

import pulumi
import pulumi_routeros as routeros

test = routeros.IpHotspotProfile("test",
    login_bies=[
        "mac",
        "https",
        "trial",
    ],
    use_radius=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.NewIpHotspotProfile(ctx, "test", &routeros.IpHotspotProfileArgs{
			LoginBies: pulumi.StringArray{
				pulumi.String("mac"),
				pulumi.String("https"),
				pulumi.String("trial"),
			},
			UseRadius: 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.IpHotspotProfile("test", new()
    {
        LoginBies = new[]
        {
            "mac",
            "https",
            "trial",
        },
        UseRadius = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.IpHotspotProfile;
import com.pulumi.routeros.IpHotspotProfileArgs;
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 IpHotspotProfile("test", IpHotspotProfileArgs.builder()
            .loginBies(            
                "mac",
                "https",
                "trial")
            .useRadius(true)
            .build());

    }
}

resources:
  test:
    type: routeros:IpHotspotProfile
    properties:
      loginBies:
        - mac
        - https
        - trial
      useRadius: true

Create IpHotspotProfile Resource

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

Constructor syntax

new IpHotspotProfile(name: string, args?: IpHotspotProfileArgs, opts?: CustomResourceOptions);

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

@overload
def IpHotspotProfile(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     ___id_: Optional[float] = None,
                     ___path_: Optional[str] = None,
                     dns_name: Optional[str] = None,
                     hotspot_address: Optional[str] = None,
                     html_directory: Optional[str] = None,
                     html_directory_override: Optional[str] = None,
                     http_cookie_lifetime: Optional[str] = None,
                     http_proxy: Optional[str] = None,
                     https_redirect: Optional[bool] = None,
                     ip_hotspot_profile_id: Optional[str] = None,
                     login_bies: Optional[Sequence[str]] = None,
                     mac_auth_mode: Optional[str] = None,
                     mac_auth_password: Optional[str] = None,
                     name: Optional[str] = None,
                     nas_port_type: Optional[str] = None,
                     radius_accounting: Optional[bool] = None,
                     radius_default_domain: Optional[str] = None,
                     radius_interim_update: Optional[str] = None,
                     radius_location_id: Optional[str] = None,
                     radius_location_name: Optional[str] = None,
                     radius_mac_format: Optional[str] = None,
                     rate_limit: Optional[str] = None,
                     smtp_server: Optional[str] = None,
                     split_user_domain: Optional[bool] = None,
                     ssl_certificate: Optional[str] = None,
                     trial_uptime_limit: Optional[str] = None,
                     trial_uptime_reset: Optional[str] = None,
                     trial_user_profile: Optional[str] = None,
                     use_radius: Optional[bool] = None)

func NewIpHotspotProfile(ctx *Context, name string, args *IpHotspotProfileArgs, opts ...ResourceOption) (*IpHotspotProfile, error)

public IpHotspotProfile(string name, IpHotspotProfileArgs? args = null, CustomResourceOptions? opts = null)

public IpHotspotProfile(String name, IpHotspotProfileArgs args)
public IpHotspotProfile(String name, IpHotspotProfileArgs args, CustomResourceOptions options)

type: routeros:IpHotspotProfile
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 IpHotspotProfileArgs: 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 IpHotspotProfileArgs: 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 IpHotspotProfileArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

IpHotspotProfile 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 IpHotspotProfile resource accepts the following input properties:

DnsName string: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
HotspotAddress string: IP address of HotSpot service.
HtmlDirectory string: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
HtmlDirectoryOverride string: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
HttpCookieLifetime string: HTTP cookie validity time, the option is related to cookie HotSpot login method.
HttpProxy string: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
HttpsRedirect bool: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
IpHotspotProfileId string
LoginBies List<string>: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
MacAuthMode string: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
MacAuthPassword string: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
Name string: Descriptive name of the profile.
NasPortType string: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
RadiusAccounting bool: Send RADIUS server accounting information for each user, when yes is used.
RadiusDefaultDomain string: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
RadiusInterimUpdate string: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
RadiusLocationId string: RADIUS-Location-Id property.
RadiusLocationName string: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
RadiusMacFormat string: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
RateLimit string: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
SmtpServer string: SMTP server address to be used to redirect HotSpot users SMTP requests.
SplitUserDomain bool: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
SslCertificate string: Name of the SSL certificate on the router to to use only for HTTPS authentication.
TrialUptimeLimit string: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
TrialUptimeReset string: Used only with trial authentication method.
TrialUserProfile string: Specifies hotspot user profile for trial users.
UseRadius bool: Use RADIUS to authenticate HotSpot users.
___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.

DnsName string: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
HotspotAddress string: IP address of HotSpot service.
HtmlDirectory string: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
HtmlDirectoryOverride string: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
HttpCookieLifetime string: HTTP cookie validity time, the option is related to cookie HotSpot login method.
HttpProxy string: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
HttpsRedirect bool: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
IpHotspotProfileId string
LoginBies []string: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
MacAuthMode string: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
MacAuthPassword string: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
Name string: Descriptive name of the profile.
NasPortType string: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
RadiusAccounting bool: Send RADIUS server accounting information for each user, when yes is used.
RadiusDefaultDomain string: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
RadiusInterimUpdate string: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
RadiusLocationId string: RADIUS-Location-Id property.
RadiusLocationName string: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
RadiusMacFormat string: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
RateLimit string: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
SmtpServer string: SMTP server address to be used to redirect HotSpot users SMTP requests.
SplitUserDomain bool: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
SslCertificate string: Name of the SSL certificate on the router to to use only for HTTPS authentication.
TrialUptimeLimit string: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
TrialUptimeReset string: Used only with trial authentication method.
TrialUserProfile string: Specifies hotspot user profile for trial users.
UseRadius bool: Use RADIUS to authenticate HotSpot users.
___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.

___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.
dnsName String: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspotAddress String: IP address of HotSpot service.
htmlDirectory String: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
htmlDirectoryOverride String: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
httpCookieLifetime String: HTTP cookie validity time, the option is related to cookie HotSpot login method.
httpProxy String: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
httpsRedirect Boolean: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ipHotspotProfileId String
loginBies List<String>: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
macAuthMode String: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
macAuthPassword String: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name String: Descriptive name of the profile.
nasPortType String: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radiusAccounting Boolean: Send RADIUS server accounting information for each user, when yes is used.
radiusDefaultDomain String: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radiusInterimUpdate String: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radiusLocationId String: RADIUS-Location-Id property.
radiusLocationName String: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radiusMacFormat String: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rateLimit String: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtpServer String: SMTP server address to be used to redirect HotSpot users SMTP requests.
splitUserDomain Boolean: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
sslCertificate String: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trialUptimeLimit String: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trialUptimeReset String: Used only with trial authentication method.
trialUserProfile String: Specifies hotspot user profile for trial users.
useRadius Boolean: Use RADIUS to authenticate HotSpot users.

___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.
dnsName string: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspotAddress string: IP address of HotSpot service.
htmlDirectory string: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
htmlDirectoryOverride string: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
httpCookieLifetime string: HTTP cookie validity time, the option is related to cookie HotSpot login method.
httpProxy string: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
httpsRedirect boolean: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ipHotspotProfileId string
loginBies string[]: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
macAuthMode string: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
macAuthPassword string: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name string: Descriptive name of the profile.
nasPortType string: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radiusAccounting boolean: Send RADIUS server accounting information for each user, when yes is used.
radiusDefaultDomain string: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radiusInterimUpdate string: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radiusLocationId string: RADIUS-Location-Id property.
radiusLocationName string: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radiusMacFormat string: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rateLimit string: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtpServer string: SMTP server address to be used to redirect HotSpot users SMTP requests.
splitUserDomain boolean: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
sslCertificate string: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trialUptimeLimit string: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trialUptimeReset string: Used only with trial authentication method.
trialUserProfile string: Specifies hotspot user profile for trial users.
useRadius boolean: Use RADIUS to authenticate HotSpot users.

___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.
dns_name str: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspot_address str: IP address of HotSpot service.
html_directory str: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
html_directory_override str: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
http_cookie_lifetime str: HTTP cookie validity time, the option is related to cookie HotSpot login method.
http_proxy str: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
https_redirect bool: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ip_hotspot_profile_id str
login_bies Sequence[str]: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
mac_auth_mode str: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
mac_auth_password str: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name str: Descriptive name of the profile.
nas_port_type str: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radius_accounting bool: Send RADIUS server accounting information for each user, when yes is used.
radius_default_domain str: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radius_interim_update str: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radius_location_id str: RADIUS-Location-Id property.
radius_location_name str: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radius_mac_format str: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rate_limit str: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtp_server str: SMTP server address to be used to redirect HotSpot users SMTP requests.
split_user_domain bool: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
ssl_certificate str: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trial_uptime_limit str: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trial_uptime_reset str: Used only with trial authentication method.
trial_user_profile str: Specifies hotspot user profile for trial users.
use_radius bool: Use RADIUS to authenticate HotSpot users.

___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.
dnsName String: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspotAddress String: IP address of HotSpot service.
htmlDirectory String: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
htmlDirectoryOverride String: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
httpCookieLifetime String: HTTP cookie validity time, the option is related to cookie HotSpot login method.
httpProxy String: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
httpsRedirect Boolean: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ipHotspotProfileId String
loginBies List<String>: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
macAuthMode String: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
macAuthPassword String: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name String: Descriptive name of the profile.
nasPortType String: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radiusAccounting Boolean: Send RADIUS server accounting information for each user, when yes is used.
radiusDefaultDomain String: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radiusInterimUpdate String: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radiusLocationId String: RADIUS-Location-Id property.
radiusLocationName String: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radiusMacFormat String: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rateLimit String: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtpServer String: SMTP server address to be used to redirect HotSpot users SMTP requests.
splitUserDomain Boolean: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
sslCertificate String: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trialUptimeLimit String: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trialUptimeReset String: Used only with trial authentication method.
trialUserProfile String: Specifies hotspot user profile for trial users.
useRadius Boolean: Use RADIUS to authenticate HotSpot users.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing IpHotspotProfile Resource

Get an existing IpHotspotProfile 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?: IpHotspotProfileState, opts?: CustomResourceOptions): IpHotspotProfile

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        dns_name: Optional[str] = None,
        hotspot_address: Optional[str] = None,
        html_directory: Optional[str] = None,
        html_directory_override: Optional[str] = None,
        http_cookie_lifetime: Optional[str] = None,
        http_proxy: Optional[str] = None,
        https_redirect: Optional[bool] = None,
        ip_hotspot_profile_id: Optional[str] = None,
        login_bies: Optional[Sequence[str]] = None,
        mac_auth_mode: Optional[str] = None,
        mac_auth_password: Optional[str] = None,
        name: Optional[str] = None,
        nas_port_type: Optional[str] = None,
        radius_accounting: Optional[bool] = None,
        radius_default_domain: Optional[str] = None,
        radius_interim_update: Optional[str] = None,
        radius_location_id: Optional[str] = None,
        radius_location_name: Optional[str] = None,
        radius_mac_format: Optional[str] = None,
        rate_limit: Optional[str] = None,
        smtp_server: Optional[str] = None,
        split_user_domain: Optional[bool] = None,
        ssl_certificate: Optional[str] = None,
        trial_uptime_limit: Optional[str] = None,
        trial_uptime_reset: Optional[str] = None,
        trial_user_profile: Optional[str] = None,
        use_radius: Optional[bool] = None) -> IpHotspotProfile

func GetIpHotspotProfile(ctx *Context, name string, id IDInput, state *IpHotspotProfileState, opts ...ResourceOption) (*IpHotspotProfile, error)

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

public static IpHotspotProfile get(String name, Output<String> id, IpHotspotProfileState state, CustomResourceOptions options)

resources:  _:    type: routeros:IpHotspotProfile    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:

DnsName string: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
HotspotAddress string: IP address of HotSpot service.
HtmlDirectory string: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
HtmlDirectoryOverride string: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
HttpCookieLifetime string: HTTP cookie validity time, the option is related to cookie HotSpot login method.
HttpProxy string: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
HttpsRedirect bool: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
IpHotspotProfileId string
LoginBies List<string>: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
MacAuthMode string: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
MacAuthPassword string: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
Name string: Descriptive name of the profile.
NasPortType string: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
RadiusAccounting bool: Send RADIUS server accounting information for each user, when yes is used.
RadiusDefaultDomain string: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
RadiusInterimUpdate string: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
RadiusLocationId string: RADIUS-Location-Id property.
RadiusLocationName string: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
RadiusMacFormat string: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
RateLimit string: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
SmtpServer string: SMTP server address to be used to redirect HotSpot users SMTP requests.
SplitUserDomain bool: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
SslCertificate string: Name of the SSL certificate on the router to to use only for HTTPS authentication.
TrialUptimeLimit string: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
TrialUptimeReset string: Used only with trial authentication method.
TrialUserProfile string: Specifies hotspot user profile for trial users.
UseRadius bool: Use RADIUS to authenticate HotSpot users.
___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.

DnsName string: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
HotspotAddress string: IP address of HotSpot service.
HtmlDirectory string: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
HtmlDirectoryOverride string: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
HttpCookieLifetime string: HTTP cookie validity time, the option is related to cookie HotSpot login method.
HttpProxy string: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
HttpsRedirect bool: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
IpHotspotProfileId string
LoginBies []string: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
MacAuthMode string: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
MacAuthPassword string: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
Name string: Descriptive name of the profile.
NasPortType string: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
RadiusAccounting bool: Send RADIUS server accounting information for each user, when yes is used.
RadiusDefaultDomain string: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
RadiusInterimUpdate string: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
RadiusLocationId string: RADIUS-Location-Id property.
RadiusLocationName string: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
RadiusMacFormat string: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
RateLimit string: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
SmtpServer string: SMTP server address to be used to redirect HotSpot users SMTP requests.
SplitUserDomain bool: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
SslCertificate string: Name of the SSL certificate on the router to to use only for HTTPS authentication.
TrialUptimeLimit string: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
TrialUptimeReset string: Used only with trial authentication method.
TrialUserProfile string: Specifies hotspot user profile for trial users.
UseRadius bool: Use RADIUS to authenticate HotSpot users.
___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.

___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.
dnsName String: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspotAddress String: IP address of HotSpot service.
htmlDirectory String: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
htmlDirectoryOverride String: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
httpCookieLifetime String: HTTP cookie validity time, the option is related to cookie HotSpot login method.
httpProxy String: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
httpsRedirect Boolean: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ipHotspotProfileId String
loginBies List<String>: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
macAuthMode String: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
macAuthPassword String: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name String: Descriptive name of the profile.
nasPortType String: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radiusAccounting Boolean: Send RADIUS server accounting information for each user, when yes is used.
radiusDefaultDomain String: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radiusInterimUpdate String: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radiusLocationId String: RADIUS-Location-Id property.
radiusLocationName String: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radiusMacFormat String: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rateLimit String: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtpServer String: SMTP server address to be used to redirect HotSpot users SMTP requests.
splitUserDomain Boolean: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
sslCertificate String: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trialUptimeLimit String: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trialUptimeReset String: Used only with trial authentication method.
trialUserProfile String: Specifies hotspot user profile for trial users.
useRadius Boolean: Use RADIUS to authenticate HotSpot users.

___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.
dnsName string: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspotAddress string: IP address of HotSpot service.
htmlDirectory string: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
htmlDirectoryOverride string: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
httpCookieLifetime string: HTTP cookie validity time, the option is related to cookie HotSpot login method.
httpProxy string: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
httpsRedirect boolean: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ipHotspotProfileId string
loginBies string[]: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
macAuthMode string: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
macAuthPassword string: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name string: Descriptive name of the profile.
nasPortType string: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radiusAccounting boolean: Send RADIUS server accounting information for each user, when yes is used.
radiusDefaultDomain string: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radiusInterimUpdate string: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radiusLocationId string: RADIUS-Location-Id property.
radiusLocationName string: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radiusMacFormat string: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rateLimit string: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtpServer string: SMTP server address to be used to redirect HotSpot users SMTP requests.
splitUserDomain boolean: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
sslCertificate string: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trialUptimeLimit string: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trialUptimeReset string: Used only with trial authentication method.
trialUserProfile string: Specifies hotspot user profile for trial users.
useRadius boolean: Use RADIUS to authenticate HotSpot users.

___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.
dns_name str: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspot_address str: IP address of HotSpot service.
html_directory str: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
html_directory_override str: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
http_cookie_lifetime str: HTTP cookie validity time, the option is related to cookie HotSpot login method.
http_proxy str: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
https_redirect bool: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ip_hotspot_profile_id str
login_bies Sequence[str]: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
mac_auth_mode str: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
mac_auth_password str: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name str: Descriptive name of the profile.
nas_port_type str: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radius_accounting bool: Send RADIUS server accounting information for each user, when yes is used.
radius_default_domain str: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radius_interim_update str: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radius_location_id str: RADIUS-Location-Id property.
radius_location_name str: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radius_mac_format str: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rate_limit str: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtp_server str: SMTP server address to be used to redirect HotSpot users SMTP requests.
split_user_domain bool: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
ssl_certificate str: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trial_uptime_limit str: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trial_uptime_reset str: Used only with trial authentication method.
trial_user_profile str: Specifies hotspot user profile for trial users.
use_radius bool: Use RADIUS to authenticate HotSpot users.

___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.
dnsName String: DNS name of the HotSpot server (it appears as the location of the login page). This name will automatically be added as a static DNS entry in the DNS cache. Name can affect if Hotspot is automatically detected by client device. For example, iOS devices may not detect Hotspot that has a name which includes .local.
hotspotAddress String: IP address of HotSpot service.
htmlDirectory String: Directory name in which HotSpot HTML pages are stored (by default hotspot directory). It is possible to specify different directory with modified HTML pages. To change HotSpot login page, connect to the router with FTP and download hotspot directory contents. v6.31 and older software builds: For devices where flash directory is present, hotspot html directory must be stored there and path must be typed in as follows: /(hotspot_dir). This must be done in this order as hotspot sees flash directory as root location. v6.32 and newer software builds: full path must be typed in html-directory field, including /flash/(hotspot_dir).
htmlDirectoryOverride String: Alternative path for hotspot html files. It should be used only if customized hotspot html files are stored on external storage(attached usb, hdd, etc). If configured then hotspot will switch to this html path as soon at it becomes available and switch back to html-directory path if override path becomes non-available for some reason.
httpCookieLifetime String: HTTP cookie validity time, the option is related to cookie HotSpot login method.
httpProxy String: Address and port of the proxy server for HotSpot service, when default value is used all request are resolved by the local /ip proxy.
httpsRedirect Boolean: Whether to redirect unauthenticated user to hotspot login page, if he is visiting a https:// url. Since certificate domain name will mismatch, often this leads to errors, so you can set this parameter to no and all https requests will simply be rejected and user will have to visit a http page.
ipHotspotProfileId String
loginBies List<String>: Used HotSpot authentication method * mac-cookie - enables login by mac cookie method. * cookie - may only be used with other HTTP authentication method. HTTP cookie is generated, when user authenticates in HotSpot for the first time. User is not asked for the login/password and authenticated automatically, until cookie-lifetime is active. * http-chap - login/password is required for the user to authenticate in HotSpot. CHAP challenge-response method with MD5 hashing algorithm is used for protecting passwords. * http-pap - login/password is required for user to authenticate in HotSpot. Username and password are sent over network in plain text. * https - login/password is required for user to authenticate in HotSpot. Client login/password exchange between client and server is encrypted with SSL tunnel. * mac - client is authenticated without asking login form. Client MAC-address is added to /ip hotspot user database, client is authenticated as soon as connected to the HotSpot * trial - client is allowed to use internet without HotSpot login for the specified amount of time.
macAuthMode String: Allows to control User-Name and User-Password RADIUS attributes when using MAC authentication.
macAuthPassword String: Used together with MAC authentication, field used to specify password for the users to be authenticated by their MAC addresses. The following option is required, when specific RADIUS server rejects authentication for the clients with blank password.
name String: Descriptive name of the profile.
nasPortType String: NAS-Port-Type value to be sent to RADIUS server, NAS-Port-Type values are described in the RADIUS RFC 2865. This optional value attribute indicates the type of the physical port of the HotSpot server.
radiusAccounting Boolean: Send RADIUS server accounting information for each user, when yes is used.
radiusDefaultDomain String: Default domain to use for RADIUS requests. Allows to use separate RADIUS server per /ip hotspot profile. If used, same domain name should be specified under /radius domain value.
radiusInterimUpdate String: How often to send accounting updates . When received is set, interim-time is used from RADIUS server. 0s is the same as received.
radiusLocationId String: RADIUS-Location-Id property.
radiusLocationName String: RADIUS-Location-Id to be sent to RADIUS server. Used to identify location of the HotSpot server during the communication with RADIUS server. Value is optional and used together with RADIUS server.
radiusMacFormat String: Controls how the MAC address of the client is encoded in the User-Name and User-Password attributes when using MAC authentication.
rateLimit String: Rate limitation in form of 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]] from the point of view of the router (so rx is client upload, and tx is client download). All rates should be numbers with optional 'k' (1,000s) or 'M' (1,000,000s). If tx-rate is not specified, rx-rate is as tx-rate too. Same goes for tx-burst-rate and tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate is used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. rx-rate-min and tx-rate min are the values of limit-at properties.
smtpServer String: SMTP server address to be used to redirect HotSpot users SMTP requests.
splitUserDomain Boolean: Split username from domain name when the username is given in user@domain or in domain\user format from RADIUS server.
sslCertificate String: Name of the SSL certificate on the router to to use only for HTTPS authentication.
trialUptimeLimit String: Used only with trial authentication method. Time value specifies, how long trial user identified by MAC address can use access to public networks without HotSpot authentication.
trialUptimeReset String: Used only with trial authentication method.
trialUserProfile String: Specifies hotspot user profile for trial users.
useRadius Boolean: Use RADIUS to authenticate HotSpot users.

Import

#The ID can be found via API or the terminal

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

$ pulumi import routeros:index/ipHotspotProfile:IpHotspotProfile 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.IpHotspotProfile

On this page

On this page

Example Usage

Create IpHotspotProfile Resource

Constructor syntax

Parameters

IpHotspotProfile Resource Properties

Inputs

Outputs

Look up Existing IpHotspotProfile Resource

Import

Package Details

On this page

On this page