Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Routeros Provider
  3. API Docs
  4. IpPool
routeros 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros
terraform-routeros/terraform-provider-routeros

routeros.IpPool

Explore with Pulumi AI

routeros logo
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 pool = new routeros.IpPool("pool", {ranges: ["10.0.0.100-10.0.0.200"]});

    import pulumi
import pulumi_routeros as routeros

pool = routeros.IpPool("pool", ranges=["10.0.0.100-10.0.0.200"])

    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.NewIpPool(ctx, "pool", &routeros.IpPoolArgs{
			Ranges: pulumi.StringArray{
				pulumi.String("10.0.0.100-10.0.0.200"),
			},
		})
		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 pool = new Routeros.IpPool("pool", new()
    {
        Ranges = new[]
        {
            "10.0.0.100-10.0.0.200",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.IpPool;
import com.pulumi.routeros.IpPoolArgs;
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 pool = new IpPool("pool", IpPoolArgs.builder()
            .ranges("10.0.0.100-10.0.0.200")
            .build());

    }
}

    resources:
  pool:
    type: routeros:IpPool
    properties:
      ranges:
        - 10.0.0.100-10.0.0.200

    Create IpPool Resource

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

    Constructor syntax

    new IpPool(name: string, args: IpPoolArgs, opts?: CustomResourceOptions);
    @overload
def IpPool(resource_name: str,
           args: IpPoolArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def IpPool(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           ranges: Optional[Sequence[str]] = None,
           ___id_: Optional[float] = None,
           ___path_: Optional[str] = None,
           ___skip_: Optional[str] = None,
           comment: Optional[str] = None,
           ip_pool_id: Optional[str] = None,
           name: Optional[str] = None,
           next_pool: Optional[str] = None)
    func NewIpPool(ctx *Context, name string, args IpPoolArgs, opts ...ResourceOption) (*IpPool, error)
    public IpPool(string name, IpPoolArgs args, CustomResourceOptions? opts = null)
    public IpPool(String name, IpPoolArgs args)
public IpPool(String name, IpPoolArgs args, CustomResourceOptions options)

    type: routeros:IpPool
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 IpPoolArgs
    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 IpPoolArgs
    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 IpPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Ranges List<string>
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    Comment string
    IpPoolId string
    The ID of this resource.
    Name string
    NextPool string
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ___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.
    Ranges []string
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    Comment string
    IpPoolId string
    The ID of this resource.
    Name string
    NextPool string
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ___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.
    ranges List<String>
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment String
    ipPoolId String
    The ID of this resource.
    name String
    nextPool String
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ranges string[]
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment string
    ipPoolId string
    The ID of this resource.
    name string
    nextPool string
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ranges Sequence[str]
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment str
    ip_pool_id str
    The ID of this resource.
    name str
    next_pool str
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ranges List<String>
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment String
    ipPoolId String
    The ID of this resource.
    name String
    nextPool String
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.

    Outputs

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

    Get an existing IpPool 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?: IpPoolState, opts?: CustomResourceOptions): IpPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        ___skip_: Optional[str] = None,
        comment: Optional[str] = None,
        ip_pool_id: Optional[str] = None,
        name: Optional[str] = None,
        next_pool: Optional[str] = None,
        ranges: Optional[Sequence[str]] = None) -> IpPool
    func GetIpPool(ctx *Context, name string, id IDInput, state *IpPoolState, opts ...ResourceOption) (*IpPool, error)
    public static IpPool Get(string name, Input<string> id, IpPoolState? state, CustomResourceOptions? opts = null)
    public static IpPool get(String name, Output<String> id, IpPoolState state, CustomResourceOptions options)
    resources:  _:    type: routeros:IpPool    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:
    Comment string
    IpPoolId string
    The ID of this resource.
    Name string
    NextPool string
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    Ranges List<string>
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    Comment string
    IpPoolId string
    The ID of this resource.
    Name string
    NextPool string
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    Ranges []string
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment String
    ipPoolId String
    The ID of this resource.
    name String
    nextPool String
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ranges List<String>
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment string
    ipPoolId string
    The ID of this resource.
    name string
    nextPool string
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ranges string[]
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment str
    ip_pool_id str
    The ID of this resource.
    name str
    next_pool str
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ranges Sequence[str]
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]
    ___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.
    comment String
    ipPoolId String
    The ID of this resource.
    name String
    nextPool String
    When address is acquired from pool that has no free addresses, and next-pool property is set to another pool, then next IP address will be acquired from next-pool.
    ranges List<String>
    IP address list of non-overlapping IP address ranges in form of: ["from1-to1", "from2-to2", ..., "fromN-toN"]. For example, ["10.0.0.1-10.0.0.27", "10.0.0.32-10.0.0.47"]

    Import

    #The ID can be found via API or the terminal

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

    $ pulumi import routeros:index/ipPool:IpPool pool "*1"

    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
    terraform-routeros/terraform-provider-routeros