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

routeros.ToolBandwidthServer

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 test = new routeros.ToolBandwidthServer("test", {
    allocateUdpPortsFrom: 2000,
    authenticate: false,
    enabled: true,
    maxSessions: 100,
});

    import pulumi
import pulumi_routeros as routeros

test = routeros.ToolBandwidthServer("test",
    allocate_udp_ports_from=2000,
    authenticate=False,
    enabled=True,
    max_sessions=100)

    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.NewToolBandwidthServer(ctx, "test", &routeros.ToolBandwidthServerArgs{
			AllocateUdpPortsFrom: pulumi.Float64(2000),
			Authenticate:         pulumi.Bool(false),
			Enabled:              pulumi.Bool(true),
			MaxSessions:          pulumi.Float64(100),
		})
		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.ToolBandwidthServer("test", new()
    {
        AllocateUdpPortsFrom = 2000,
        Authenticate = false,
        Enabled = true,
        MaxSessions = 100,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.ToolBandwidthServer;
import com.pulumi.routeros.ToolBandwidthServerArgs;
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 ToolBandwidthServer("test", ToolBandwidthServerArgs.builder()
            .allocateUdpPortsFrom(2000)
            .authenticate(false)
            .enabled(true)
            .maxSessions(100)
            .build());

    }
}

    resources:
  test:
    type: routeros:ToolBandwidthServer
    properties:
      allocateUdpPortsFrom: 2000
      authenticate: false
      enabled: true
      maxSessions: 100

    Create ToolBandwidthServer Resource

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

    Constructor syntax

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

@overload
def ToolBandwidthServer(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        ___id_: Optional[float] = None,
                        ___path_: Optional[str] = None,
                        allocate_udp_ports_from: Optional[float] = None,
                        allowed_addresses4s: Optional[Sequence[str]] = None,
                        allowed_addresses6s: Optional[Sequence[str]] = None,
                        authenticate: Optional[bool] = None,
                        enabled: Optional[bool] = None,
                        max_sessions: Optional[float] = None,
                        tool_bandwidth_server_id: Optional[str] = None)
    func NewToolBandwidthServer(ctx *Context, name string, args *ToolBandwidthServerArgs, opts ...ResourceOption) (*ToolBandwidthServer, error)
    public ToolBandwidthServer(string name, ToolBandwidthServerArgs? args = null, CustomResourceOptions? opts = null)
    public ToolBandwidthServer(String name, ToolBandwidthServerArgs args)
public ToolBandwidthServer(String name, ToolBandwidthServerArgs args, CustomResourceOptions options)

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

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

    AllocateUdpPortsFrom double
    Beginning of UDP port range.
    AllowedAddresses4s List<string>
    IPv4 allowed networks.
    AllowedAddresses6s List<string>
    Ipv6 allowed networks.
    Authenticate bool
    Communicate only with authenticated clients.
    Enabled bool
    Defines whether bandwidth server is enabled or not.
    MaxSessions double
    Maximal simultaneous test count.
    ToolBandwidthServerId string
    The ID of this resource.
    ___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.
    AllocateUdpPortsFrom float64
    Beginning of UDP port range.
    AllowedAddresses4s []string
    IPv4 allowed networks.
    AllowedAddresses6s []string
    Ipv6 allowed networks.
    Authenticate bool
    Communicate only with authenticated clients.
    Enabled bool
    Defines whether bandwidth server is enabled or not.
    MaxSessions float64
    Maximal simultaneous test count.
    ToolBandwidthServerId string
    The ID of this resource.
    ___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.
    allocateUdpPortsFrom Double
    Beginning of UDP port range.
    allowedAddresses4s List<String>
    IPv4 allowed networks.
    allowedAddresses6s List<String>
    Ipv6 allowed networks.
    authenticate Boolean
    Communicate only with authenticated clients.
    enabled Boolean
    Defines whether bandwidth server is enabled or not.
    maxSessions Double
    Maximal simultaneous test count.
    toolBandwidthServerId String
    The ID of this resource.
    ___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.
    allocateUdpPortsFrom number
    Beginning of UDP port range.
    allowedAddresses4s string[]
    IPv4 allowed networks.
    allowedAddresses6s string[]
    Ipv6 allowed networks.
    authenticate boolean
    Communicate only with authenticated clients.
    enabled boolean
    Defines whether bandwidth server is enabled or not.
    maxSessions number
    Maximal simultaneous test count.
    toolBandwidthServerId string
    The ID of this resource.
    ___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.
    allocate_udp_ports_from float
    Beginning of UDP port range.
    allowed_addresses4s Sequence[str]
    IPv4 allowed networks.
    allowed_addresses6s Sequence[str]
    Ipv6 allowed networks.
    authenticate bool
    Communicate only with authenticated clients.
    enabled bool
    Defines whether bandwidth server is enabled or not.
    max_sessions float
    Maximal simultaneous test count.
    tool_bandwidth_server_id str
    The ID of this resource.
    ___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.
    allocateUdpPortsFrom Number
    Beginning of UDP port range.
    allowedAddresses4s List<String>
    IPv4 allowed networks.
    allowedAddresses6s List<String>
    Ipv6 allowed networks.
    authenticate Boolean
    Communicate only with authenticated clients.
    enabled Boolean
    Defines whether bandwidth server is enabled or not.
    maxSessions Number
    Maximal simultaneous test count.
    toolBandwidthServerId String
    The ID of this resource.

    Outputs

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

    Get an existing ToolBandwidthServer 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?: ToolBandwidthServerState, opts?: CustomResourceOptions): ToolBandwidthServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        allocate_udp_ports_from: Optional[float] = None,
        allowed_addresses4s: Optional[Sequence[str]] = None,
        allowed_addresses6s: Optional[Sequence[str]] = None,
        authenticate: Optional[bool] = None,
        enabled: Optional[bool] = None,
        max_sessions: Optional[float] = None,
        tool_bandwidth_server_id: Optional[str] = None) -> ToolBandwidthServer
    func GetToolBandwidthServer(ctx *Context, name string, id IDInput, state *ToolBandwidthServerState, opts ...ResourceOption) (*ToolBandwidthServer, error)
    public static ToolBandwidthServer Get(string name, Input<string> id, ToolBandwidthServerState? state, CustomResourceOptions? opts = null)
    public static ToolBandwidthServer get(String name, Output<String> id, ToolBandwidthServerState state, CustomResourceOptions options)
    resources:  _:    type: routeros:ToolBandwidthServer    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:
    AllocateUdpPortsFrom double
    Beginning of UDP port range.
    AllowedAddresses4s List<string>
    IPv4 allowed networks.
    AllowedAddresses6s List<string>
    Ipv6 allowed networks.
    Authenticate bool
    Communicate only with authenticated clients.
    Enabled bool
    Defines whether bandwidth server is enabled or not.
    MaxSessions double
    Maximal simultaneous test count.
    ToolBandwidthServerId string
    The ID of this resource.
    ___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.
    AllocateUdpPortsFrom float64
    Beginning of UDP port range.
    AllowedAddresses4s []string
    IPv4 allowed networks.
    AllowedAddresses6s []string
    Ipv6 allowed networks.
    Authenticate bool
    Communicate only with authenticated clients.
    Enabled bool
    Defines whether bandwidth server is enabled or not.
    MaxSessions float64
    Maximal simultaneous test count.
    ToolBandwidthServerId string
    The ID of this resource.
    ___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.
    allocateUdpPortsFrom Double
    Beginning of UDP port range.
    allowedAddresses4s List<String>
    IPv4 allowed networks.
    allowedAddresses6s List<String>
    Ipv6 allowed networks.
    authenticate Boolean
    Communicate only with authenticated clients.
    enabled Boolean
    Defines whether bandwidth server is enabled or not.
    maxSessions Double
    Maximal simultaneous test count.
    toolBandwidthServerId String
    The ID of this resource.
    ___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.
    allocateUdpPortsFrom number
    Beginning of UDP port range.
    allowedAddresses4s string[]
    IPv4 allowed networks.
    allowedAddresses6s string[]
    Ipv6 allowed networks.
    authenticate boolean
    Communicate only with authenticated clients.
    enabled boolean
    Defines whether bandwidth server is enabled or not.
    maxSessions number
    Maximal simultaneous test count.
    toolBandwidthServerId string
    The ID of this resource.
    ___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.
    allocate_udp_ports_from float
    Beginning of UDP port range.
    allowed_addresses4s Sequence[str]
    IPv4 allowed networks.
    allowed_addresses6s Sequence[str]
    Ipv6 allowed networks.
    authenticate bool
    Communicate only with authenticated clients.
    enabled bool
    Defines whether bandwidth server is enabled or not.
    max_sessions float
    Maximal simultaneous test count.
    tool_bandwidth_server_id str
    The ID of this resource.
    ___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.
    allocateUdpPortsFrom Number
    Beginning of UDP port range.
    allowedAddresses4s List<String>
    IPv4 allowed networks.
    allowedAddresses6s List<String>
    Ipv6 allowed networks.
    authenticate Boolean
    Communicate only with authenticated clients.
    enabled Boolean
    Defines whether bandwidth server is enabled or not.
    maxSessions Number
    Maximal simultaneous test count.
    toolBandwidthServerId String
    The ID of this resource.

    Import

    $ pulumi import routeros:index/toolBandwidthServer:ToolBandwidthServer test .

    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