1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getStaticRoute
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

iosxe.getStaticRoute

iosxe logo
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

    This data source can read the Static Route configuration.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Iosxe = Pulumi.Iosxe;

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetStaticRoute.Invoke(new()
    {
        Mask = "255.255.255.255",
        Prefix = "5.5.5.5",
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupStaticRoute(ctx, &iosxe.LookupStaticRouteArgs{
			Mask:   "255.255.255.255",
			Prefix: "5.5.5.5",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.IosxeFunctions;
import com.pulumi.iosxe.inputs.GetStaticRouteArgs;
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 example = IosxeFunctions.getStaticRoute(GetStaticRouteArgs.builder()
            .mask("255.255.255.255")
            .prefix("5.5.5.5")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as iosxe from "@pulumi/iosxe";

const example = iosxe.getStaticRoute({
    mask: "255.255.255.255",
    prefix: "5.5.5.5",
});

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_static_route(mask="255.255.255.255",
    prefix="5.5.5.5")

    variables:
  example:
    fn::invoke:
      Function: iosxe:getStaticRoute
      Arguments:
        mask: 255.255.255.255
        prefix: 5.5.5.5

    Using getStaticRoute

    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 getStaticRoute(args: GetStaticRouteArgs, opts?: InvokeOptions): Promise<GetStaticRouteResult>
function getStaticRouteOutput(args: GetStaticRouteOutputArgs, opts?: InvokeOptions): Output<GetStaticRouteResult>
    def get_static_route(device: Optional[str] = None,
                     mask: Optional[str] = None,
                     prefix: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetStaticRouteResult
def get_static_route_output(device: Optional[pulumi.Input[str]] = None,
                     mask: Optional[pulumi.Input[str]] = None,
                     prefix: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetStaticRouteResult]
    func LookupStaticRoute(ctx *Context, args *LookupStaticRouteArgs, opts ...InvokeOption) (*LookupStaticRouteResult, error)
func LookupStaticRouteOutput(ctx *Context, args *LookupStaticRouteOutputArgs, opts ...InvokeOption) LookupStaticRouteResultOutput

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

    public static class GetStaticRoute 
{
    public static Task<GetStaticRouteResult> InvokeAsync(GetStaticRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetStaticRouteResult> Invoke(GetStaticRouteInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStaticRouteResult> getStaticRoute(GetStaticRouteArgs args, InvokeOptions options)
public static Output<GetStaticRouteResult> getStaticRoute(GetStaticRouteArgs args, InvokeOptions options)

    fn::invoke:
  function: iosxe:index/getStaticRoute:getStaticRoute
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Mask string
    Prefix string
    Device string
    A device name from the provider configuration.
    Mask string
    Prefix string
    Device string
    A device name from the provider configuration.
    mask String
    prefix String
    device String
    A device name from the provider configuration.
    mask string
    prefix string
    device string
    A device name from the provider configuration.
    mask str
    prefix str
    device str
    A device name from the provider configuration.
    mask String
    prefix String
    device String
    A device name from the provider configuration.

    getStaticRoute Result

    The following output properties are available:

    Id string
    The path of the retrieved object.
    Mask string
    NextHops List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetStaticRouteNextHop>
    Prefix string
    Device string
    A device name from the provider configuration.
    Id string
    The path of the retrieved object.
    Mask string
    NextHops []GetStaticRouteNextHop
    Prefix string
    Device string
    A device name from the provider configuration.
    id String
    The path of the retrieved object.
    mask String
    nextHops List<GetStaticRouteNextHop>
    prefix String
    device String
    A device name from the provider configuration.
    id string
    The path of the retrieved object.
    mask string
    nextHops GetStaticRouteNextHop[]
    prefix string
    device string
    A device name from the provider configuration.
    id str
    The path of the retrieved object.
    mask str
    next_hops Sequence[GetStaticRouteNextHop]
    prefix str
    device str
    A device name from the provider configuration.
    id String
    The path of the retrieved object.
    mask String
    nextHops List<Property Map>
    prefix String
    device String
    A device name from the provider configuration.

    Supporting Types

    GetStaticRouteNextHop

    Global bool
    Next hop address is global
    Metric int
    Name string
    Specify name of the next hop
    NextHop string
    Permanent bool
    permanent route
    Tag int
    Set tag for this route
    Global bool
    Next hop address is global
    Metric int
    Name string
    Specify name of the next hop
    NextHop string
    Permanent bool
    permanent route
    Tag int
    Set tag for this route
    global Boolean
    Next hop address is global
    metric Integer
    name String
    Specify name of the next hop
    nextHop String
    permanent Boolean
    permanent route
    tag Integer
    Set tag for this route
    global boolean
    Next hop address is global
    metric number
    name string
    Specify name of the next hop
    nextHop string
    permanent boolean
    permanent route
    tag number
    Set tag for this route
    global_ bool
    Next hop address is global
    metric int
    name str
    Specify name of the next hop
    next_hop str
    permanent bool
    permanent route
    tag int
    Set tag for this route
    global Boolean
    Next hop address is global
    metric Number
    name String
    Specify name of the next hop
    nextHop String
    permanent Boolean
    permanent route
    tag Number
    Set tag for this route

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Viewing docs for Cisco IOS XE v0.0.1
    published on Friday, Sep 22, 2023 by lbrlabs
    Schema (JSON)
    lbrlabs/pulumi-iosxe
      Try Pulumi Cloud free. Your team will thank you.