routeros.IpHotspot
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as routeros from "@pulumi/routeros";
const test = new routeros.IpHotspot("test", {"interface": "ether2"});
import pulumi
import pulumi_routeros as routeros
test = routeros.IpHotspot("test", interface="ether2")
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.NewIpHotspot(ctx, "test", &routeros.IpHotspotArgs{
Interface: pulumi.String("ether2"),
})
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.IpHotspot("test", new()
{
Interface = "ether2",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.IpHotspot;
import com.pulumi.routeros.IpHotspotArgs;
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 IpHotspot("test", IpHotspotArgs.builder()
.interface_("ether2")
.build());
}
}
resources:
test:
type: routeros:IpHotspot
properties:
interface: ether2
Create IpHotspot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IpHotspot(name: string, args: IpHotspotArgs, opts?: CustomResourceOptions);
@overload
def IpHotspot(resource_name: str,
args: IpHotspotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IpHotspot(resource_name: str,
opts: Optional[ResourceOptions] = None,
interface: Optional[str] = None,
idle_timeout: Optional[str] = None,
___skip_: Optional[str] = None,
address_pool: Optional[str] = None,
addresses_per_mac: Optional[str] = None,
disabled: Optional[bool] = None,
___id_: Optional[float] = None,
___path_: Optional[str] = None,
ip_hotspot_id: Optional[str] = None,
keepalive_timeout: Optional[str] = None,
login_timeout: Optional[str] = None,
name: Optional[str] = None,
profile: Optional[str] = None)
func NewIpHotspot(ctx *Context, name string, args IpHotspotArgs, opts ...ResourceOption) (*IpHotspot, error)
public IpHotspot(string name, IpHotspotArgs args, CustomResourceOptions? opts = null)
public IpHotspot(String name, IpHotspotArgs args)
public IpHotspot(String name, IpHotspotArgs args, CustomResourceOptions options)
type: routeros:IpHotspot
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 IpHotspotArgs
- 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 IpHotspotArgs
- 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 IpHotspotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IpHotspotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IpHotspotArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
IpHotspot 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 IpHotspot resource accepts the following input properties:
- Interface string
- Interface to run HotSpot on.
- Address
Pool string - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- Addresses
Per stringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- Disabled bool
- Idle
Timeout string - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- Ip
Hotspot stringId - The ID of this resource.
- Keepalive
Timeout string - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- Login
Timeout string - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- Name string
- HotSpot server's name or identifier.
- Profile string
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- Interface string
- Interface to run HotSpot on.
- Address
Pool string - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- Addresses
Per stringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- Disabled bool
- Idle
Timeout string - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- Ip
Hotspot stringId - The ID of this resource.
- Keepalive
Timeout string - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- Login
Timeout string - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- Name string
- HotSpot server's name or identifier.
- Profile string
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- interface_ String
- Interface to run HotSpot on.
- ___
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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address
Pool String - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses
Per StringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled Boolean
- idle
Timeout String - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- ip
Hotspot StringId - The ID of this resource.
- keepalive
Timeout String - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login
Timeout String - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name String
- HotSpot server's name or identifier.
- profile String
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/profile
.
- interface string
- Interface to run HotSpot on.
- ___
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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address
Pool string - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses
Per stringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled boolean
- idle
Timeout string - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- ip
Hotspot stringId - The ID of this resource.
- keepalive
Timeout string - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login
Timeout string - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name string
- HotSpot server's name or identifier.
- profile string
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/profile
.
- interface str
- Interface to run HotSpot on.
- ___
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.
- ___
skip_ str - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address_
pool str - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses_
per_ strmac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled bool
- idle_
timeout str - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- ip_
hotspot_ strid - The ID of this resource.
- keepalive_
timeout str - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login_
timeout str - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name str
- HotSpot server's name or identifier.
- profile str
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/profile
.
- interface String
- Interface to run HotSpot on.
- ___
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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address
Pool String - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses
Per StringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled Boolean
- idle
Timeout String - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- ip
Hotspot StringId - The ID of this resource.
- keepalive
Timeout String - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login
Timeout String - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name String
- HotSpot server's name or identifier.
- profile String
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/profile
.
Outputs
All input properties are implicitly available as output properties. Additionally, the IpHotspot resource produces the following output properties:
Look up Existing IpHotspot Resource
Get an existing IpHotspot 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?: IpHotspotState, opts?: CustomResourceOptions): IpHotspot
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
___id_: Optional[float] = None,
___path_: Optional[str] = None,
___skip_: Optional[str] = None,
address_pool: Optional[str] = None,
addresses_per_mac: Optional[str] = None,
disabled: Optional[bool] = None,
idle_timeout: Optional[str] = None,
interface: Optional[str] = None,
invalid: Optional[bool] = None,
ip_hotspot_id: Optional[str] = None,
keepalive_timeout: Optional[str] = None,
login_timeout: Optional[str] = None,
name: Optional[str] = None,
profile: Optional[str] = None) -> IpHotspot
func GetIpHotspot(ctx *Context, name string, id IDInput, state *IpHotspotState, opts ...ResourceOption) (*IpHotspot, error)
public static IpHotspot Get(string name, Input<string> id, IpHotspotState? state, CustomResourceOptions? opts = null)
public static IpHotspot get(String name, Output<String> id, IpHotspotState state, CustomResourceOptions options)
resources: _: type: routeros:IpHotspot 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.
- Address
Pool string - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- Addresses
Per stringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- Disabled bool
- Idle
Timeout string - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- Interface string
- Interface to run HotSpot on.
- Invalid bool
- Ip
Hotspot stringId - The ID of this resource.
- Keepalive
Timeout string - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- Login
Timeout string - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- Name string
- HotSpot server's name or identifier.
- Profile string
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- Address
Pool string - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- Addresses
Per stringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- Disabled bool
- Idle
Timeout string - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- Interface string
- Interface to run HotSpot on.
- Invalid bool
- Ip
Hotspot stringId - The ID of this resource.
- Keepalive
Timeout string - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- Login
Timeout string - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- Name string
- HotSpot server's name or identifier.
- Profile string
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/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.
- ___
skip_ string - A set of transformations for field names. 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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address
Pool String - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses
Per StringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled Boolean
- idle
Timeout String - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- interface_ String
- Interface to run HotSpot on.
- invalid Boolean
- ip
Hotspot StringId - The ID of this resource.
- keepalive
Timeout String - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login
Timeout String - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name String
- HotSpot server's name or identifier.
- profile String
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/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.
- ___
skip_ string - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address
Pool string - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses
Per stringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled boolean
- idle
Timeout string - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- interface string
- Interface to run HotSpot on.
- invalid boolean
- ip
Hotspot stringId - The ID of this resource.
- keepalive
Timeout string - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login
Timeout string - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name string
- HotSpot server's name or identifier.
- profile string
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/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.
- ___
skip_ str - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address_
pool str - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses_
per_ strmac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled bool
- idle_
timeout str - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- interface str
- Interface to run HotSpot on.
- invalid bool
- ip_
hotspot_ strid - The ID of this resource.
- keepalive_
timeout str - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login_
timeout str - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name str
- HotSpot server's name or identifier.
- profile str
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/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.
- ___
skip_ String - A set of transformations for field names. This is an internal service field, setting a value is not required.
- address
Pool String - Address space used to change HotSpot client any IP address to a valid address. Useful for providing public network access to mobile clients that are not willing to change their networking settings.
- addresses
Per StringMac - Number of IP addresses allowed to be bind with the MAC address, when multiple HotSpot clients connected with one MAC-address.
- disabled Boolean
- idle
Timeout String - Period of inactivity for unauthorized clients. When there is no traffic from this client (literally client computer should be switched off), once the timeout is reached, a user is dropped from the HotSpot host list, its used address becomes available.
- interface String
- Interface to run HotSpot on.
- invalid Boolean
- ip
Hotspot StringId - The ID of this resource.
- keepalive
Timeout String - The exact value of the keepalive-timeout, that is applied to the user. Value shows how long the host can stay out of reach to be removed from the HotSpot.
- login
Timeout String - Period of time after which if a host hasn't been authorized itself with a system the host entry gets deleted from host table. Loop repeats until the host logs in the system. Enable if there are situations where a host cannot log in after being too long in the host table unauthorized.
- name String
- HotSpot server's name or identifier.
- profile String
- HotSpot server default HotSpot profile, which is located in
/ip/hotspot/profile
.
Import
#The ID can be found via API or the terminal
#The command for the terminal is -> :put [/ip/hotspot get [print show-ids]]
$ pulumi import routeros:index/ipHotspot:IpHotspot 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.