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

routeros.getIpRoutes

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 ipRoutes = routeros.getIpRoutes({});
    
    import pulumi
    import pulumi_routeros as routeros
    
    ip_routes = routeros.get_ip_routes()
    
    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.GetIpRoutes(ctx, &routeros.GetIpRoutesArgs{}, nil)
    		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 ipRoutes = Routeros.GetIpRoutes.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.routeros.RouterosFunctions;
    import com.pulumi.routeros.inputs.GetIpRoutesArgs;
    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) {
            final var ipRoutes = RouterosFunctions.getIpRoutes();
    
        }
    }
    
    variables:
      ipRoutes:
        fn::invoke:
          function: routeros:getIpRoutes
          arguments: {}
    

    Using getIpRoutes

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIpRoutes(args: GetIpRoutesArgs, opts?: InvokeOptions): Promise<GetIpRoutesResult>
    function getIpRoutesOutput(args: GetIpRoutesOutputArgs, opts?: InvokeOptions): Output<GetIpRoutesResult>
    def get_ip_routes(___id_: Optional[float] = None,
                      ___path_: Optional[str] = None,
                      filter: Optional[Mapping[str, str]] = None,
                      id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIpRoutesResult
    def get_ip_routes_output(___id_: Optional[pulumi.Input[float]] = None,
                      ___path_: Optional[pulumi.Input[str]] = None,
                      filter: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIpRoutesResult]
    func GetIpRoutes(ctx *Context, args *GetIpRoutesArgs, opts ...InvokeOption) (*GetIpRoutesResult, error)
    func GetIpRoutesOutput(ctx *Context, args *GetIpRoutesOutputArgs, opts ...InvokeOption) GetIpRoutesResultOutput

    > Note: This function is named GetIpRoutes in the Go SDK.

    public static class GetIpRoutes 
    {
        public static Task<GetIpRoutesResult> InvokeAsync(GetIpRoutesArgs args, InvokeOptions? opts = null)
        public static Output<GetIpRoutesResult> Invoke(GetIpRoutesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIpRoutesResult> getIpRoutes(GetIpRoutesArgs args, InvokeOptions options)
    public static Output<GetIpRoutesResult> getIpRoutes(GetIpRoutesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: routeros:index/getIpRoutes:getIpRoutes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filter Dictionary<string, string>
    Additional request filtering options.
    Id string
    The ID of this resource.
    ___id_ double
    ___path_ string
    Filter map[string]string
    Additional request filtering options.
    Id string
    The ID of this resource.
    ___id_ float64
    ___path_ string
    ___id_ Double
    ___path_ String
    filter Map<String,String>
    Additional request filtering options.
    id String
    The ID of this resource.
    ___id_ number
    ___path_ string
    filter {[key: string]: string}
    Additional request filtering options.
    id string
    The ID of this resource.
    ___id_ float
    ___path_ str
    filter Mapping[str, str]
    Additional request filtering options.
    id str
    The ID of this resource.
    ___id_ Number
    ___path_ String
    filter Map<String>
    Additional request filtering options.
    id String
    The ID of this resource.

    getIpRoutes Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Routes List<GetIpRoutesRoute>
    Filter Dictionary<string, string>
    Additional request filtering options.
    ___id_ double
    ___path_ string
    Id string
    The ID of this resource.
    Routes []GetIpRoutesRoute
    Filter map[string]string
    Additional request filtering options.
    ___id_ float64
    ___path_ string
    id String
    The ID of this resource.
    routes List<GetIpRoutesRoute>
    ___id_ Double
    ___path_ String
    filter Map<String,String>
    Additional request filtering options.
    id string
    The ID of this resource.
    routes GetIpRoutesRoute[]
    ___id_ number
    ___path_ string
    filter {[key: string]: string}
    Additional request filtering options.
    id str
    The ID of this resource.
    routes Sequence[GetIpRoutesRoute]
    ___id_ float
    ___path_ str
    filter Mapping[str, str]
    Additional request filtering options.
    id String
    The ID of this resource.
    routes List<Property Map>
    ___id_ Number
    ___path_ String
    filter Map<String>
    Additional request filtering options.

    Supporting Types

    GetIpRoutesRoute

    Active bool
    Blackhole bool
    Comment string
    Connect bool
    Dhcp bool
    Disabled bool
    Distance double
    DstAddress string
    Dynamic bool
    Ecmp bool
    Gateway string
    HwOffloaded bool
    Id string
    ImmediateGw string
    Inactive bool
    LocalAddress string
    PrefSrc string
    RoutingTable string
    Scope double
    Static bool
    SuppressHwOffload bool
    TargetScope double
    VrfInterface string
    Active bool
    Blackhole bool
    Comment string
    Connect bool
    Dhcp bool
    Disabled bool
    Distance float64
    DstAddress string
    Dynamic bool
    Ecmp bool
    Gateway string
    HwOffloaded bool
    Id string
    ImmediateGw string
    Inactive bool
    LocalAddress string
    PrefSrc string
    RoutingTable string
    Scope float64
    Static bool
    SuppressHwOffload bool
    TargetScope float64
    VrfInterface string
    active Boolean
    blackhole Boolean
    comment String
    connect Boolean
    dhcp Boolean
    disabled Boolean
    distance Double
    dstAddress String
    dynamic Boolean
    ecmp Boolean
    gateway String
    hwOffloaded Boolean
    id String
    immediateGw String
    inactive Boolean
    localAddress String
    prefSrc String
    routingTable String
    scope Double
    static_ Boolean
    suppressHwOffload Boolean
    targetScope Double
    vrfInterface String
    active boolean
    blackhole boolean
    comment string
    connect boolean
    dhcp boolean
    disabled boolean
    distance number
    dstAddress string
    dynamic boolean
    ecmp boolean
    gateway string
    hwOffloaded boolean
    id string
    immediateGw string
    inactive boolean
    localAddress string
    prefSrc string
    routingTable string
    scope number
    static boolean
    suppressHwOffload boolean
    targetScope number
    vrfInterface string
    active Boolean
    blackhole Boolean
    comment String
    connect Boolean
    dhcp Boolean
    disabled Boolean
    distance Number
    dstAddress String
    dynamic Boolean
    ecmp Boolean
    gateway String
    hwOffloaded Boolean
    id String
    immediateGw String
    inactive Boolean
    localAddress String
    prefSrc String
    routingTable String
    scope Number
    static Boolean
    suppressHwOffload Boolean
    targetScope Number
    vrfInterface String

    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