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

routeros.RoutingFilterRule

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.RoutingFilterRule("test", {
        chain: "testChain",
        comment: "comment",
        disabled: true,
        rule: "if (dst in 192.168.1.0/24 && dst-len>24) {set distance +1; accept} else {set distance -1; accept}",
    });
    
    import pulumi
    import pulumi_routeros as routeros
    
    test = routeros.RoutingFilterRule("test",
        chain="testChain",
        comment="comment",
        disabled=True,
        rule="if (dst in 192.168.1.0/24 && dst-len>24) {set distance +1; accept} else {set distance -1; accept}")
    
    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.NewRoutingFilterRule(ctx, "test", &routeros.RoutingFilterRuleArgs{
    			Chain:    pulumi.String("testChain"),
    			Comment:  pulumi.String("comment"),
    			Disabled: pulumi.Bool(true),
    			Rule:     pulumi.String("if (dst in 192.168.1.0/24 && dst-len>24) {set distance +1; accept} else {set distance -1; accept}"),
    		})
    		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.RoutingFilterRule("test", new()
        {
            Chain = "testChain",
            Comment = "comment",
            Disabled = true,
            Rule = "if (dst in 192.168.1.0/24 && dst-len>24) {set distance +1; accept} else {set distance -1; accept}",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.RoutingFilterRule;
    import com.pulumi.routeros.RoutingFilterRuleArgs;
    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 RoutingFilterRule("test", RoutingFilterRuleArgs.builder()
                .chain("testChain")
                .comment("comment")
                .disabled(true)
                .rule("if (dst in 192.168.1.0/24 && dst-len>24) {set distance +1; accept} else {set distance -1; accept}")
                .build());
    
        }
    }
    
    resources:
      test:
        type: routeros:RoutingFilterRule
        properties:
          chain: testChain
          comment: comment
          disabled: true
          rule: if (dst in 192.168.1.0/24 && dst-len>24) {set distance +1; accept} else {set distance -1; accept}
    

    Create RoutingFilterRule Resource

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

    Constructor syntax

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

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

    Chain string
    Chain name.
    Rule string
    Filter rule.
    Comment string
    Disabled bool
    RoutingFilterRuleId 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.
    Chain string
    Chain name.
    Rule string
    Filter rule.
    Comment string
    Disabled bool
    RoutingFilterRuleId 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.
    chain String
    Chain name.
    rule String
    Filter rule.
    ___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.
    comment String
    disabled Boolean
    routingFilterRuleId String
    The ID of this resource.
    chain string
    Chain name.
    rule string
    Filter rule.
    ___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.
    comment string
    disabled boolean
    routingFilterRuleId string
    The ID of this resource.
    chain str
    Chain name.
    rule str
    Filter rule.
    ___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.
    comment str
    disabled bool
    routing_filter_rule_id str
    The ID of this resource.
    chain String
    Chain name.
    rule String
    Filter rule.
    ___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.
    comment String
    disabled Boolean
    routingFilterRuleId String
    The ID of this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Inactive bool
    Id string
    The provider-assigned unique ID for this managed resource.
    Inactive bool
    id String
    The provider-assigned unique ID for this managed resource.
    inactive Boolean
    id string
    The provider-assigned unique ID for this managed resource.
    inactive boolean
    id str
    The provider-assigned unique ID for this managed resource.
    inactive bool
    id String
    The provider-assigned unique ID for this managed resource.
    inactive Boolean

    Look up Existing RoutingFilterRule Resource

    Get an existing RoutingFilterRule 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?: RoutingFilterRuleState, opts?: CustomResourceOptions): RoutingFilterRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ___id_: Optional[float] = None,
            ___path_: Optional[str] = None,
            chain: Optional[str] = None,
            comment: Optional[str] = None,
            disabled: Optional[bool] = None,
            inactive: Optional[bool] = None,
            routing_filter_rule_id: Optional[str] = None,
            rule: Optional[str] = None) -> RoutingFilterRule
    func GetRoutingFilterRule(ctx *Context, name string, id IDInput, state *RoutingFilterRuleState, opts ...ResourceOption) (*RoutingFilterRule, error)
    public static RoutingFilterRule Get(string name, Input<string> id, RoutingFilterRuleState? state, CustomResourceOptions? opts = null)
    public static RoutingFilterRule get(String name, Output<String> id, RoutingFilterRuleState state, CustomResourceOptions options)
    resources:  _:    type: routeros:RoutingFilterRule    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:
    Chain string
    Chain name.
    Comment string
    Disabled bool
    Inactive bool
    RoutingFilterRuleId string
    The ID of this resource.
    Rule string
    Filter rule.
    ___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.
    Chain string
    Chain name.
    Comment string
    Disabled bool
    Inactive bool
    RoutingFilterRuleId string
    The ID of this resource.
    Rule string
    Filter rule.
    ___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.
    chain String
    Chain name.
    comment String
    disabled Boolean
    inactive Boolean
    routingFilterRuleId String
    The ID of this resource.
    rule String
    Filter rule.
    ___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.
    chain string
    Chain name.
    comment string
    disabled boolean
    inactive boolean
    routingFilterRuleId string
    The ID of this resource.
    rule string
    Filter rule.
    ___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.
    chain str
    Chain name.
    comment str
    disabled bool
    inactive bool
    routing_filter_rule_id str
    The ID of this resource.
    rule str
    Filter rule.
    ___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.
    chain String
    Chain name.
    comment String
    disabled Boolean
    inactive Boolean
    routingFilterRuleId String
    The ID of this resource.
    rule String
    Filter rule.

    Import

    #The ID can be found via API or the terminal

    #The command for the terminal is -> /routing/filter/rule/print show-ids

    $ pulumi import routeros:index/routingFilterRule:RoutingFilterRule test "*0"
    

    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