1. Packages
  2. Routeros Provider
  3. API Docs
  4. IpHotspotIpBinding
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

routeros.IpHotspotIpBinding

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as routeros from "@pulumi/routeros";
    
    const test = new routeros.IpHotspotIpBinding("test", {
        address: "0.0.0.1",
        comment: "comment",
        macAddress: "00:00:00:00:01:10",
        toAddress: "0.0.0.2",
    });
    
    import pulumi
    import pulumi_routeros as routeros
    
    test = routeros.IpHotspotIpBinding("test",
        address="0.0.0.1",
        comment="comment",
        mac_address="00:00:00:00:01:10",
        to_address="0.0.0.2")
    
    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.NewIpHotspotIpBinding(ctx, "test", &routeros.IpHotspotIpBindingArgs{
    			Address:    pulumi.String("0.0.0.1"),
    			Comment:    pulumi.String("comment"),
    			MacAddress: pulumi.String("00:00:00:00:01:10"),
    			ToAddress:  pulumi.String("0.0.0.2"),
    		})
    		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.IpHotspotIpBinding("test", new()
        {
            Address = "0.0.0.1",
            Comment = "comment",
            MacAddress = "00:00:00:00:01:10",
            ToAddress = "0.0.0.2",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.IpHotspotIpBinding;
    import com.pulumi.routeros.IpHotspotIpBindingArgs;
    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 IpHotspotIpBinding("test", IpHotspotIpBindingArgs.builder()
                .address("0.0.0.1")
                .comment("comment")
                .macAddress("00:00:00:00:01:10")
                .toAddress("0.0.0.2")
                .build());
    
        }
    }
    
    resources:
      test:
        type: routeros:IpHotspotIpBinding
        properties:
          address: 0.0.0.1
          comment: comment
          macAddress: 00:00:00:00:01:10
          toAddress: 0.0.0.2
    

    Create IpHotspotIpBinding Resource

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

    Constructor syntax

    new IpHotspotIpBinding(name: string, args?: IpHotspotIpBindingArgs, opts?: CustomResourceOptions);
    @overload
    def IpHotspotIpBinding(resource_name: str,
                           args: Optional[IpHotspotIpBindingArgs] = None,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def IpHotspotIpBinding(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           ___id_: Optional[float] = None,
                           ___path_: Optional[str] = None,
                           address: Optional[str] = None,
                           comment: Optional[str] = None,
                           disabled: Optional[bool] = None,
                           ip_hotspot_ip_binding_id: Optional[str] = None,
                           mac_address: Optional[str] = None,
                           server: Optional[str] = None,
                           to_address: Optional[str] = None,
                           type: Optional[str] = None)
    func NewIpHotspotIpBinding(ctx *Context, name string, args *IpHotspotIpBindingArgs, opts ...ResourceOption) (*IpHotspotIpBinding, error)
    public IpHotspotIpBinding(string name, IpHotspotIpBindingArgs? args = null, CustomResourceOptions? opts = null)
    public IpHotspotIpBinding(String name, IpHotspotIpBindingArgs args)
    public IpHotspotIpBinding(String name, IpHotspotIpBindingArgs args, CustomResourceOptions options)
    
    type: routeros:IpHotspotIpBinding
    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 IpHotspotIpBindingArgs
    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 IpHotspotIpBindingArgs
    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 IpHotspotIpBindingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpHotspotIpBindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpHotspotIpBindingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Address string
    The original IP address of the client.
    Comment string
    Disabled bool
    IpHotspotIpBindingId string
    MacAddress string
    MAC address of the client.
    Server string
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    ToAddress string
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    Type string
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    Address string
    The original IP address of the client.
    Comment string
    Disabled bool
    IpHotspotIpBindingId string
    MacAddress string
    MAC address of the client.
    Server string
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    ToAddress string
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    Type string
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address String
    The original IP address of the client.
    comment String
    disabled Boolean
    ipHotspotIpBindingId String
    macAddress String
    MAC address of the client.
    server String
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    toAddress String
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type String
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address string
    The original IP address of the client.
    comment string
    disabled boolean
    ipHotspotIpBindingId string
    macAddress string
    MAC address of the client.
    server string
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    toAddress string
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type string
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address str
    The original IP address of the client.
    comment str
    disabled bool
    ip_hotspot_ip_binding_id str
    mac_address str
    MAC address of the client.
    server str
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    to_address str
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type str
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address String
    The original IP address of the client.
    comment String
    disabled Boolean
    ipHotspotIpBindingId String
    macAddress String
    MAC address of the client.
    server String
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    toAddress String
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type String
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpHotspotIpBinding 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 IpHotspotIpBinding Resource

    Get an existing IpHotspotIpBinding 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?: IpHotspotIpBindingState, opts?: CustomResourceOptions): IpHotspotIpBinding
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            address: Optional[str] = None,
            comment: Optional[str] = None,
            disabled: Optional[bool] = None,
            ip_hotspot_ip_binding_id: Optional[str] = None,
            mac_address: Optional[str] = None,
            server: Optional[str] = None,
            to_address: Optional[str] = None,
            type: Optional[str] = None) -> IpHotspotIpBinding
    func GetIpHotspotIpBinding(ctx *Context, name string, id IDInput, state *IpHotspotIpBindingState, opts ...ResourceOption) (*IpHotspotIpBinding, error)
    public static IpHotspotIpBinding Get(string name, Input<string> id, IpHotspotIpBindingState? state, CustomResourceOptions? opts = null)
    public static IpHotspotIpBinding get(String name, Output<String> id, IpHotspotIpBindingState state, CustomResourceOptions options)
    resources:  _:    type: routeros:IpHotspotIpBinding    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:
    Address string
    The original IP address of the client.
    Comment string
    Disabled bool
    IpHotspotIpBindingId string
    MacAddress string
    MAC address of the client.
    Server string
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    ToAddress string
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    Type string
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    Address string
    The original IP address of the client.
    Comment string
    Disabled bool
    IpHotspotIpBindingId string
    MacAddress string
    MAC address of the client.
    Server string
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    ToAddress string
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    Type string
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address String
    The original IP address of the client.
    comment String
    disabled Boolean
    ipHotspotIpBindingId String
    macAddress String
    MAC address of the client.
    server String
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    toAddress String
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type String
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address string
    The original IP address of the client.
    comment string
    disabled boolean
    ipHotspotIpBindingId string
    macAddress string
    MAC address of the client.
    server string
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    toAddress string
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type string
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address str
    The original IP address of the client.
    comment str
    disabled bool
    ip_hotspot_ip_binding_id str
    mac_address str
    MAC address of the client.
    server str
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    to_address str
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type str
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.
    ___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.
    address String
    The original IP address of the client.
    comment String
    disabled Boolean
    ipHotspotIpBindingId String
    macAddress String
    MAC address of the client.
    server String
    Name of the HotSpot server. all - will be applied to all hotspot servers.
    toAddress String
    New IP address of the client, translation occurs on the router (client does not know anything about the translation).
    type String
    Type of the IP-binding action * regular - performs One-to-One NAT according to the rule, translates the address to to-address; * bypassed - performs the translation, but excludes client from login to the HotSpot; * blocked - translation is not performed and packets from a host are dropped.

    Import

    #The ID can be found via API or the terminal

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

    $ pulumi import routeros:index/ipHotspotIpBinding:IpHotspotIpBinding 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 logo
    routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros