routeros 1.83.1, Apr 28 25

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

terraform-routeros/terraform-provider-routeros

routeros.IpRoute

Explore with Pulumi AI

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 aRoute = new routeros.IpRoute("aRoute", {
    dstAddress: "0.0.0.0/0",
    gateway: "10.0.0.1",
});

import pulumi
import pulumi_routeros as routeros

a_route = routeros.IpRoute("aRoute",
    dst_address="0.0.0.0/0",
    gateway="10.0.0.1")

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.NewIpRoute(ctx, "aRoute", &routeros.IpRouteArgs{
			DstAddress: pulumi.String("0.0.0.0/0"),
			Gateway:    pulumi.String("10.0.0.1"),
		})
		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 aRoute = new Routeros.IpRoute("aRoute", new()
    {
        DstAddress = "0.0.0.0/0",
        Gateway = "10.0.0.1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.routeros.IpRoute;
import com.pulumi.routeros.IpRouteArgs;
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 aRoute = new IpRoute("aRoute", IpRouteArgs.builder()
            .dstAddress("0.0.0.0/0")
            .gateway("10.0.0.1")
            .build());

    }
}

resources:
  aRoute:
    type: routeros:IpRoute
    properties:
      dstAddress: 0.0.0.0/0
      gateway: 10.0.0.1

Create IpRoute Resource

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

Constructor syntax

new IpRoute(name: string, args: IpRouteArgs, opts?: CustomResourceOptions);

@overload
def IpRoute(resource_name: str,
            args: IpRouteArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def IpRoute(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            gateway: Optional[str] = None,
            comment: Optional[str] = None,
            routing_table: Optional[str] = None,
            check_gateway: Optional[str] = None,
            ___id_: Optional[float] = None,
            disabled: Optional[bool] = None,
            distance: Optional[float] = None,
            blackhole: Optional[bool] = None,
            ip_route_id: Optional[str] = None,
            dst_address: Optional[str] = None,
            pref_src: Optional[str] = None,
            ___path_: Optional[str] = None,
            scope: Optional[float] = None,
            suppress_hw_offload: Optional[bool] = None,
            target_scope: Optional[float] = None,
            vrf_interface: Optional[str] = None)

func NewIpRoute(ctx *Context, name string, args IpRouteArgs, opts ...ResourceOption) (*IpRoute, error)

public IpRoute(string name, IpRouteArgs args, CustomResourceOptions? opts = null)

public IpRoute(String name, IpRouteArgs args)
public IpRoute(String name, IpRouteArgs args, CustomResourceOptions options)

type: routeros:IpRoute
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 IpRouteArgs: 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 IpRouteArgs: 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 IpRouteArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IpRouteArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IpRouteArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Gateway string: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
Blackhole bool: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
CheckGateway string: Currently used check-gateway option.
Comment string
Disabled bool
Distance double: Value used in route selection. Routes with smaller distance value are given preference.
DstAddress string: IP prefix of route, specifies destination addresses that this route can be used for.
IpRouteId string: The ID of this resource.
PrefSrc string: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
RoutingTable string: Routing table this route belongs to.
Scope double: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
SuppressHwOffload bool
TargetScope double: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
VrfInterface string: VRF interface name.
___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.

Gateway string: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
Blackhole bool: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
CheckGateway string: Currently used check-gateway option.
Comment string
Disabled bool
Distance float64: Value used in route selection. Routes with smaller distance value are given preference.
DstAddress string: IP prefix of route, specifies destination addresses that this route can be used for.
IpRouteId string: The ID of this resource.
PrefSrc string: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
RoutingTable string: Routing table this route belongs to.
Scope float64: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
SuppressHwOffload bool
TargetScope float64: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
VrfInterface string: VRF interface name.
___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.

gateway String: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
___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.
blackhole Boolean: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
checkGateway String: Currently used check-gateway option.
comment String
disabled Boolean
distance Double: Value used in route selection. Routes with smaller distance value are given preference.
dstAddress String: IP prefix of route, specifies destination addresses that this route can be used for.
ipRouteId String: The ID of this resource.
prefSrc String: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routingTable String: Routing table this route belongs to.
scope Double: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
suppressHwOffload Boolean
targetScope Double: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrfInterface String: VRF interface name.

gateway string: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
___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.
blackhole boolean: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
checkGateway string: Currently used check-gateway option.
comment string
disabled boolean
distance number: Value used in route selection. Routes with smaller distance value are given preference.
dstAddress string: IP prefix of route, specifies destination addresses that this route can be used for.
ipRouteId string: The ID of this resource.
prefSrc string: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routingTable string: Routing table this route belongs to.
scope number: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
suppressHwOffload boolean
targetScope number: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrfInterface string: VRF interface name.

gateway str: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
___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.
blackhole bool: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
check_gateway str: Currently used check-gateway option.
comment str
disabled bool
distance float: Value used in route selection. Routes with smaller distance value are given preference.
dst_address str: IP prefix of route, specifies destination addresses that this route can be used for.
ip_route_id str: The ID of this resource.
pref_src str: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routing_table str: Routing table this route belongs to.
scope float: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
suppress_hw_offload bool
target_scope float: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrf_interface str: VRF interface name.

gateway String: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
___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.
blackhole Boolean: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
checkGateway String: Currently used check-gateway option.
comment String
disabled Boolean
distance Number: Value used in route selection. Routes with smaller distance value are given preference.
dstAddress String: IP prefix of route, specifies destination addresses that this route can be used for.
ipRouteId String: The ID of this resource.
prefSrc String: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routingTable String: Routing table this route belongs to.
scope Number: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
suppressHwOffload Boolean
targetScope Number: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrfInterface String: VRF interface name.

Outputs

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

Active bool: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
Connect bool: The route is directly reachable.
Dhcp bool: A flag indicates whether the route was added by the DHCP service.
Dynamic bool: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
Ecmp bool: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
HwOffloaded bool: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
Id string: The provider-assigned unique ID for this managed resource.
ImmediateGw string: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
Inactive bool
LocalAddress string: Local IP address of the connected network.
Static bool

Active bool: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
Connect bool: The route is directly reachable.
Dhcp bool: A flag indicates whether the route was added by the DHCP service.
Dynamic bool: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
Ecmp bool: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
HwOffloaded bool: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
Id string: The provider-assigned unique ID for this managed resource.
ImmediateGw string: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
Inactive bool
LocalAddress string: Local IP address of the connected network.
Static bool

active Boolean: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
connect Boolean: The route is directly reachable.
dhcp Boolean: A flag indicates whether the route was added by the DHCP service.
dynamic Boolean: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp Boolean: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
hwOffloaded Boolean: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
id String: The provider-assigned unique ID for this managed resource.
immediateGw String: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive Boolean
localAddress String: Local IP address of the connected network.
static_ Boolean

active boolean: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
connect boolean: The route is directly reachable.
dhcp boolean: A flag indicates whether the route was added by the DHCP service.
dynamic boolean: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp boolean: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
hwOffloaded boolean: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
id string: The provider-assigned unique ID for this managed resource.
immediateGw string: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive boolean
localAddress string: Local IP address of the connected network.
static boolean

active bool: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
connect bool: The route is directly reachable.
dhcp bool: A flag indicates whether the route was added by the DHCP service.
dynamic bool: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp bool: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
hw_offloaded bool: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
id str: The provider-assigned unique ID for this managed resource.
immediate_gw str: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive bool
local_address str: Local IP address of the connected network.
static bool

active Boolean: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
connect Boolean: The route is directly reachable.
dhcp Boolean: A flag indicates whether the route was added by the DHCP service.
dynamic Boolean: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp Boolean: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
hwOffloaded Boolean: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
id String: The provider-assigned unique ID for this managed resource.
immediateGw String: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive Boolean
localAddress String: Local IP address of the connected network.
static Boolean

Look up Existing IpRoute Resource

Get an existing IpRoute 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?: IpRouteState, opts?: CustomResourceOptions): IpRoute

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        active: Optional[bool] = None,
        blackhole: Optional[bool] = None,
        check_gateway: Optional[str] = None,
        comment: Optional[str] = None,
        connect: Optional[bool] = None,
        dhcp: Optional[bool] = None,
        disabled: Optional[bool] = None,
        distance: Optional[float] = None,
        dst_address: Optional[str] = None,
        dynamic: Optional[bool] = None,
        ecmp: Optional[bool] = None,
        gateway: Optional[str] = None,
        hw_offloaded: Optional[bool] = None,
        immediate_gw: Optional[str] = None,
        inactive: Optional[bool] = None,
        ip_route_id: Optional[str] = None,
        local_address: Optional[str] = None,
        pref_src: Optional[str] = None,
        routing_table: Optional[str] = None,
        scope: Optional[float] = None,
        static: Optional[bool] = None,
        suppress_hw_offload: Optional[bool] = None,
        target_scope: Optional[float] = None,
        vrf_interface: Optional[str] = None) -> IpRoute

func GetIpRoute(ctx *Context, name string, id IDInput, state *IpRouteState, opts ...ResourceOption) (*IpRoute, error)

public static IpRoute Get(string name, Input<string> id, IpRouteState? state, CustomResourceOptions? opts = null)

public static IpRoute get(String name, Output<String> id, IpRouteState state, CustomResourceOptions options)

resources:  _:    type: routeros:IpRoute    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:

Active bool: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
Blackhole bool: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
CheckGateway string: Currently used check-gateway option.
Comment string
Connect bool: The route is directly reachable.
Dhcp bool: A flag indicates whether the route was added by the DHCP service.
Disabled bool
Distance double: Value used in route selection. Routes with smaller distance value are given preference.
DstAddress string: IP prefix of route, specifies destination addresses that this route can be used for.
Dynamic bool: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
Ecmp bool: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
Gateway string: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
HwOffloaded bool: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
ImmediateGw string: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
Inactive bool
IpRouteId string: The ID of this resource.
LocalAddress string: Local IP address of the connected network.
PrefSrc string: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
RoutingTable string: Routing table this route belongs to.
Scope double: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
Static bool
SuppressHwOffload bool
TargetScope double: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
VrfInterface string: VRF interface name.
___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.

Active bool: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
Blackhole bool: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
CheckGateway string: Currently used check-gateway option.
Comment string
Connect bool: The route is directly reachable.
Dhcp bool: A flag indicates whether the route was added by the DHCP service.
Disabled bool
Distance float64: Value used in route selection. Routes with smaller distance value are given preference.
DstAddress string: IP prefix of route, specifies destination addresses that this route can be used for.
Dynamic bool: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
Ecmp bool: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
Gateway string: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
HwOffloaded bool: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
ImmediateGw string: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
Inactive bool
IpRouteId string: The ID of this resource.
LocalAddress string: Local IP address of the connected network.
PrefSrc string: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
RoutingTable string: Routing table this route belongs to.
Scope float64: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
Static bool
SuppressHwOffload bool
TargetScope float64: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
VrfInterface string: VRF interface name.
___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.
active Boolean: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
blackhole Boolean: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
checkGateway String: Currently used check-gateway option.
comment String
connect Boolean: The route is directly reachable.
dhcp Boolean: A flag indicates whether the route was added by the DHCP service.
disabled Boolean
distance Double: Value used in route selection. Routes with smaller distance value are given preference.
dstAddress String: IP prefix of route, specifies destination addresses that this route can be used for.
dynamic Boolean: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp Boolean: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
gateway String: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
hwOffloaded Boolean: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
immediateGw String: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive Boolean
ipRouteId String: The ID of this resource.
localAddress String: Local IP address of the connected network.
prefSrc String: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routingTable String: Routing table this route belongs to.
scope Double: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
static_ Boolean
suppressHwOffload Boolean
targetScope Double: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrfInterface String: VRF interface name.

___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.
active boolean: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
blackhole boolean: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
checkGateway string: Currently used check-gateway option.
comment string
connect boolean: The route is directly reachable.
dhcp boolean: A flag indicates whether the route was added by the DHCP service.
disabled boolean
distance number: Value used in route selection. Routes with smaller distance value are given preference.
dstAddress string: IP prefix of route, specifies destination addresses that this route can be used for.
dynamic boolean: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp boolean: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
gateway string: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
hwOffloaded boolean: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
immediateGw string: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive boolean
ipRouteId string: The ID of this resource.
localAddress string: Local IP address of the connected network.
prefSrc string: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routingTable string: Routing table this route belongs to.
scope number: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
static boolean
suppressHwOffload boolean
targetScope number: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrfInterface string: VRF interface name.

___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.
active bool: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
blackhole bool: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
check_gateway str: Currently used check-gateway option.
comment str
connect bool: The route is directly reachable.
dhcp bool: A flag indicates whether the route was added by the DHCP service.
disabled bool
distance float: Value used in route selection. Routes with smaller distance value are given preference.
dst_address str: IP prefix of route, specifies destination addresses that this route can be used for.
dynamic bool: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp bool: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
gateway str: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
hw_offloaded bool: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
immediate_gw str: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive bool
ip_route_id str: The ID of this resource.
local_address str: Local IP address of the connected network.
pref_src str: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routing_table str: Routing table this route belongs to.
scope float: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
static bool
suppress_hw_offload bool
target_scope float: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrf_interface str: VRF interface name.

___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.
active Boolean: A flag indicates whether the route is elected as Active and eligible to be added to the FIB.
blackhole Boolean: It's a blackhole route. If you need to cancel route marking, then simply delete the parameter from the configuration of the TF. The value of the parameter (true or false) has no effect on the MT processing logic.
checkGateway String: Currently used check-gateway option.
comment String
connect Boolean: The route is directly reachable.
dhcp Boolean: A flag indicates whether the route was added by the DHCP service.
disabled Boolean
distance Number: Value used in route selection. Routes with smaller distance value are given preference.
dstAddress String: IP prefix of route, specifies destination addresses that this route can be used for.
dynamic Boolean: Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ecmp Boolean: A flag indicates whether the route is added as an Equal-Cost Multi-Path route in the FIB.
gateway String: Array of IP addresses or interface names. Specifies which host or interface packets should be sent to (IP | interface | IP%interface | IP@table[, IP | string, [..]]).
hwOffloaded Boolean: Indicates whether the route is eligible to be hardware offloaded on supported hardware.
immediateGw String: Shows actual (resolved) gateway and interface that will be used for packet forwarding.
inactive Boolean
ipRouteId String: The ID of this resource.
localAddress String: Local IP address of the connected network.
prefSrc String: Which of the local IP addresses to use for locally originated packets that are sent via this route. Value of this property has no effect on forwarded packets. If value of this property is set to IP address that is not local address of this router then the route will be inactive (in ROS v6, ROS v7 allows IP spoofing).
routingTable String: Routing table this route belongs to.
scope Number: Used in nexthop resolution. Route can resolve nexthop only through routes that have scope less than or equal to the target-scope of this route.
static Boolean
suppressHwOffload Boolean
targetScope Number: Used in nexthop resolution. This is the maximum value of scope for a route through which a nexthop of this route can be resolved.
vrfInterface String: VRF interface name.

Import

#The ID can be found via API or the terminal

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

$ pulumi import routeros:index/ipRoute:IpRoute a_route "*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 1.83.1 published on Monday, Apr 28, 2025 by terraform-routeros

terraform-routeros/terraform-provider-routeros

routeros.IpRoute

On this page

On this page

Example Usage

Create IpRoute Resource

Constructor syntax

Parameters

IpRoute Resource Properties

Inputs

Outputs

Look up Existing IpRoute Resource

Import

Package Details

On this page

On this page