Docs Packages
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getRouteMap
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.getRouteMap

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

    This data source can read the Route Map configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Iosxe.GetRouteMap.Invoke(new()
    {
        Name = "RM1",
    });

});

    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.LookupRouteMap(ctx, &iosxe.LookupRouteMapArgs{
			Name: "RM1",
		}, 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.GetRouteMapArgs;
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.getRouteMap(GetRouteMapArgs.builder()
            .name("RM1")
            .build());

    }
}

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_route_map(name="RM1")

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

const example = iosxe.getRouteMap({
    name: "RM1",
});

    variables:
  example:
    fn::invoke:
      Function: iosxe:getRouteMap
      Arguments:
        name: RM1

    Using getRouteMap

    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 getRouteMap(args: GetRouteMapArgs, opts?: InvokeOptions): Promise<GetRouteMapResult>
function getRouteMapOutput(args: GetRouteMapOutputArgs, opts?: InvokeOptions): Output<GetRouteMapResult>
    def get_route_map(device: Optional[str] = None,
                  name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRouteMapResult
def get_route_map_output(device: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRouteMapResult]
    func LookupRouteMap(ctx *Context, args *LookupRouteMapArgs, opts ...InvokeOption) (*LookupRouteMapResult, error)
func LookupRouteMapOutput(ctx *Context, args *LookupRouteMapOutputArgs, opts ...InvokeOption) LookupRouteMapResultOutput

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

    public static class GetRouteMap 
{
    public static Task<GetRouteMapResult> InvokeAsync(GetRouteMapArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteMapResult> Invoke(GetRouteMapInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRouteMapResult> getRouteMap(GetRouteMapArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Name string
    WORD;;Route map tag
    Device string
    A device name from the provider configuration.
    Name string
    WORD;;Route map tag
    Device string
    A device name from the provider configuration.
    name String
    WORD;;Route map tag
    device String
    A device name from the provider configuration.
    name string
    WORD;;Route map tag
    device string
    A device name from the provider configuration.
    name str
    WORD;;Route map tag
    device str
    A device name from the provider configuration.
    name String
    WORD;;Route map tag
    device String
    A device name from the provider configuration.

    getRouteMap Result

    The following output properties are available:

    Entries List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetRouteMapEntry>
    Id string
    The path of the retrieved object.
    Name string
    WORD;;Route map tag
    Device string
    A device name from the provider configuration.
    Entries []GetRouteMapEntry
    Id string
    The path of the retrieved object.
    Name string
    WORD;;Route map tag
    Device string
    A device name from the provider configuration.
    entries List<GetRouteMapEntry>
    id String
    The path of the retrieved object.
    name String
    WORD;;Route map tag
    device String
    A device name from the provider configuration.
    entries GetRouteMapEntry[]
    id string
    The path of the retrieved object.
    name string
    WORD;;Route map tag
    device string
    A device name from the provider configuration.
    entries Sequence[GetRouteMapEntry]
    id str
    The path of the retrieved object.
    name str
    WORD;;Route map tag
    device str
    A device name from the provider configuration.
    entries List<Property Map>
    id String
    The path of the retrieved object.
    name String
    WORD;;Route map tag
    device String
    A device name from the provider configuration.

    Supporting Types

    GetRouteMapEntry

    Continue bool
    Continue on a different entry within the route-map
    ContinueSequenceNumber int
    Route-map entry sequence number
    Description string
    Route-map comment
    MatchAsPaths List<int>
    AS path access-list
    MatchAsPathsLegacies List<int>
    AS path access-list (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    MatchCommunityListExactMatch bool
    Do exact matching of communities
    MatchCommunityLists List<string>
    Named Access List
    MatchCommunityListsLegacies List<string>
    Named Access List (DEPRECATED- please use community-list in Cisco-IOS-XE-bgp.yang)
    MatchExtcommunityLists List<string>
    Named Access List
    MatchExtcommunityListsLegacies List<string>
    Named Access List (DEPRECATED- please use extcommunity-list in Cisco-IOS-XE-bgp.yang)
    MatchInterfaces List<string>
    MatchIpAddressAccessLists List<string>
    MatchIpAddressPrefixLists List<string>
    Match entries of prefix-lists
    MatchIpNextHopAccessLists List<string>
    MatchIpNextHopPrefixLists List<string>
    Match entries of prefix-lists
    MatchIpv6AddressAccessLists string
    MatchIpv6AddressPrefixLists string
    IPv6 prefix-list
    MatchIpv6NextHopAccessLists string
    MatchIpv6NextHopPrefixLists string
    IPv6 prefix-list
    MatchLocalPreferences List<int>
    MatchLocalPreferencesLegacies List<int>
    MatchRouteTypeExternal bool
    external route (BGP, EIGRP and OSPF type 1/2)
    MatchRouteTypeExternalType1 bool
    OSPF external type 1 route
    MatchRouteTypeExternalType2 bool
    OSPF external type 2 route
    MatchRouteTypeInternal bool
    internal route (including OSPF intra/inter area)
    MatchRouteTypeLevel1 bool
    IS-IS level-1 route
    MatchRouteTypeLevel2 bool
    IS-IS level-2 route
    MatchRouteTypeLocal bool
    locally generated route (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    MatchSourceProtocolBgps List<string>
    Border Gateway Protocol (BGP)
    MatchSourceProtocolConnected bool
    Connected
    MatchSourceProtocolEigrps List<string>
    Border Gateway Protocol (BGP)
    MatchSourceProtocolIsis bool
    ISO IS-IS
    MatchSourceProtocolLisp bool
    Locator ID Separation Protocol (LISP)
    MatchSourceProtocolOspfs List<string>
    Open Shortest Path First (OSPF)
    MatchSourceProtocolOspfv3s List<string>
    OSPFv3
    MatchSourceProtocolRip bool
    Routing Information Protocol (RIP)
    MatchSourceProtocolStatic bool
    Static routes
    MatchTags List<int>
    Tag value
    MatchTrack int
    tracking object
    Operation string
    Seq int
    SetAsPathPrependAs string
    \n\n;;AS number
    SetAsPathPrependAsLegacy string
    \n\n;;AS number (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetAsPathPrependLastAs int
    SetAsPathPrependLastAsLegacy int
    SetAsPathTag bool
    Set the tag as an AS-path attribute
    SetAsPathTagLegacy bool
    Set the tag as an AS-path attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetCommunities List<string>
    SetCommunitiesAdditive bool
    SetCommunitiesAdditiveLegacy bool
    SetCommunitiesLegacies List<string>
    SetCommunityListDelete bool
    Delete matching communities
    SetCommunityListDeleteLegacy bool
    Delete matching communities (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetCommunityListExpanded int
    SetCommunityListExpandedLegacy int
    SetCommunityListName string
    SetCommunityListNameLegacy string
    SetCommunityListStandard int
    SetCommunityListStandardLegacy int
    SetCommunityNone bool
    No community attribute
    SetCommunityNoneLegacy bool
    No community attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetDefaultInterfaces List<string>
    SPAN source interface
    SetExtcomunityRtLegacies List<string>
    SetExtcomunityRts List<string>
    SetExtcomunitySoo string
    SetExtcomunitySooLegacy string
    SetExtcomunityVpnDistinguisher string
    VPN Distinguisher Extended Community
    SetExtcomunityVpnDistinguisherAdditive bool
    SetExtcomunityVpnDistinguisherLegacy string
    SetGlobal bool
    SetInterfaces List<string>
    Interface specific information
    SetIpAddress string
    Specify prefix-list
    SetIpDefaultGlobalNextHopAddresses List<string>
    SetIpDefaultNextHopAddresses List<string>
    SetIpGlobalNextHopAddresses List<string>
    SetIpNextHopAddresses List<string>
    SetIpNextHopSelf bool
    Use self address (for BGP only)
    SetIpQosGroup int
    SetIpv6Addresses List<string>
    IPv6 prefix-list
    SetIpv6DefaultGlobalNextHop string
    Next hop along path
    SetIpv6DefaultNextHops List<string>
    Default next hop IPv6 address
    SetIpv6NextHops List<string>
    Next hop IPv6 address
    SetLevel1 bool
    Import into a level-1 area
    SetLevel12 bool
    Import into level-1 and level-2
    SetLevel2 bool
    Import into level-2 sub-domain
    SetLocalPreference int
    Preference value
    SetLocalPreferenceLegacy int
    Preference value (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetMetricChange string
    +/-\n\n;;Add or subtract metric
    SetMetricDelay string
    EIGRP delay metric, in 10 microsecond units
    SetMetricLoading int
    EIGRP Effective bandwidth metric (Loading) where 255 is 100% loaded
    SetMetricMtu int
    EIGRP MTU of the path
    SetMetricReliability int
    EIGRP reliability metric where 255 is 100% reliable
    SetMetricType string
    Type of metric for destination routing protocol
    SetMetricValue int
    Metric value or Bandwidth in Kbits per second
    SetTag int
    Tag value
    SetVrf string
    VPN Routing/Forwarding instance name
    SetWeight int
    BGP weight for routing table
    SetWeightLegacy int
    BGP weight for routing table (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    Continue bool
    Continue on a different entry within the route-map
    ContinueSequenceNumber int
    Route-map entry sequence number
    Description string
    Route-map comment
    MatchAsPaths []int
    AS path access-list
    MatchAsPathsLegacies []int
    AS path access-list (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    MatchCommunityListExactMatch bool
    Do exact matching of communities
    MatchCommunityLists []string
    Named Access List
    MatchCommunityListsLegacies []string
    Named Access List (DEPRECATED- please use community-list in Cisco-IOS-XE-bgp.yang)
    MatchExtcommunityLists []string
    Named Access List
    MatchExtcommunityListsLegacies []string
    Named Access List (DEPRECATED- please use extcommunity-list in Cisco-IOS-XE-bgp.yang)
    MatchInterfaces []string
    MatchIpAddressAccessLists []string
    MatchIpAddressPrefixLists []string
    Match entries of prefix-lists
    MatchIpNextHopAccessLists []string
    MatchIpNextHopPrefixLists []string
    Match entries of prefix-lists
    MatchIpv6AddressAccessLists string
    MatchIpv6AddressPrefixLists string
    IPv6 prefix-list
    MatchIpv6NextHopAccessLists string
    MatchIpv6NextHopPrefixLists string
    IPv6 prefix-list
    MatchLocalPreferences []int
    MatchLocalPreferencesLegacies []int
    MatchRouteTypeExternal bool
    external route (BGP, EIGRP and OSPF type 1/2)
    MatchRouteTypeExternalType1 bool
    OSPF external type 1 route
    MatchRouteTypeExternalType2 bool
    OSPF external type 2 route
    MatchRouteTypeInternal bool
    internal route (including OSPF intra/inter area)
    MatchRouteTypeLevel1 bool
    IS-IS level-1 route
    MatchRouteTypeLevel2 bool
    IS-IS level-2 route
    MatchRouteTypeLocal bool
    locally generated route (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    MatchSourceProtocolBgps []string
    Border Gateway Protocol (BGP)
    MatchSourceProtocolConnected bool
    Connected
    MatchSourceProtocolEigrps []string
    Border Gateway Protocol (BGP)
    MatchSourceProtocolIsis bool
    ISO IS-IS
    MatchSourceProtocolLisp bool
    Locator ID Separation Protocol (LISP)
    MatchSourceProtocolOspfs []string
    Open Shortest Path First (OSPF)
    MatchSourceProtocolOspfv3s []string
    OSPFv3
    MatchSourceProtocolRip bool
    Routing Information Protocol (RIP)
    MatchSourceProtocolStatic bool
    Static routes
    MatchTags []int
    Tag value
    MatchTrack int
    tracking object
    Operation string
    Seq int
    SetAsPathPrependAs string
    \n\n;;AS number
    SetAsPathPrependAsLegacy string
    \n\n;;AS number (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetAsPathPrependLastAs int
    SetAsPathPrependLastAsLegacy int
    SetAsPathTag bool
    Set the tag as an AS-path attribute
    SetAsPathTagLegacy bool
    Set the tag as an AS-path attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetCommunities []string
    SetCommunitiesAdditive bool
    SetCommunitiesAdditiveLegacy bool
    SetCommunitiesLegacies []string
    SetCommunityListDelete bool
    Delete matching communities
    SetCommunityListDeleteLegacy bool
    Delete matching communities (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetCommunityListExpanded int
    SetCommunityListExpandedLegacy int
    SetCommunityListName string
    SetCommunityListNameLegacy string
    SetCommunityListStandard int
    SetCommunityListStandardLegacy int
    SetCommunityNone bool
    No community attribute
    SetCommunityNoneLegacy bool
    No community attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetDefaultInterfaces []string
    SPAN source interface
    SetExtcomunityRtLegacies []string
    SetExtcomunityRts []string
    SetExtcomunitySoo string
    SetExtcomunitySooLegacy string
    SetExtcomunityVpnDistinguisher string
    VPN Distinguisher Extended Community
    SetExtcomunityVpnDistinguisherAdditive bool
    SetExtcomunityVpnDistinguisherLegacy string
    SetGlobal bool
    SetInterfaces []string
    Interface specific information
    SetIpAddress string
    Specify prefix-list
    SetIpDefaultGlobalNextHopAddresses []string
    SetIpDefaultNextHopAddresses []string
    SetIpGlobalNextHopAddresses []string
    SetIpNextHopAddresses []string
    SetIpNextHopSelf bool
    Use self address (for BGP only)
    SetIpQosGroup int
    SetIpv6Addresses []string
    IPv6 prefix-list
    SetIpv6DefaultGlobalNextHop string
    Next hop along path
    SetIpv6DefaultNextHops []string
    Default next hop IPv6 address
    SetIpv6NextHops []string
    Next hop IPv6 address
    SetLevel1 bool
    Import into a level-1 area
    SetLevel12 bool
    Import into level-1 and level-2
    SetLevel2 bool
    Import into level-2 sub-domain
    SetLocalPreference int
    Preference value
    SetLocalPreferenceLegacy int
    Preference value (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    SetMetricChange string
    +/-\n\n;;Add or subtract metric
    SetMetricDelay string
    EIGRP delay metric, in 10 microsecond units
    SetMetricLoading int
    EIGRP Effective bandwidth metric (Loading) where 255 is 100% loaded
    SetMetricMtu int
    EIGRP MTU of the path
    SetMetricReliability int
    EIGRP reliability metric where 255 is 100% reliable
    SetMetricType string
    Type of metric for destination routing protocol
    SetMetricValue int
    Metric value or Bandwidth in Kbits per second
    SetTag int
    Tag value
    SetVrf string
    VPN Routing/Forwarding instance name
    SetWeight int
    BGP weight for routing table
    SetWeightLegacy int
    BGP weight for routing table (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    continueSequenceNumber Integer
    Route-map entry sequence number
    continue_ Boolean
    Continue on a different entry within the route-map
    description String
    Route-map comment
    matchAsPaths List<Integer>
    AS path access-list
    matchAsPathsLegacies List<Integer>
    AS path access-list (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    matchCommunityListExactMatch Boolean
    Do exact matching of communities
    matchCommunityLists List<String>
    Named Access List
    matchCommunityListsLegacies List<String>
    Named Access List (DEPRECATED- please use community-list in Cisco-IOS-XE-bgp.yang)
    matchExtcommunityLists List<String>
    Named Access List
    matchExtcommunityListsLegacies List<String>
    Named Access List (DEPRECATED- please use extcommunity-list in Cisco-IOS-XE-bgp.yang)
    matchInterfaces List<String>
    matchIpAddressAccessLists List<String>
    matchIpAddressPrefixLists List<String>
    Match entries of prefix-lists
    matchIpNextHopAccessLists List<String>
    matchIpNextHopPrefixLists List<String>
    Match entries of prefix-lists
    matchIpv6AddressAccessLists String
    matchIpv6AddressPrefixLists String
    IPv6 prefix-list
    matchIpv6NextHopAccessLists String
    matchIpv6NextHopPrefixLists String
    IPv6 prefix-list
    matchLocalPreferences List<Integer>
    matchLocalPreferencesLegacies List<Integer>
    matchRouteTypeExternal Boolean
    external route (BGP, EIGRP and OSPF type 1/2)
    matchRouteTypeExternalType1 Boolean
    OSPF external type 1 route
    matchRouteTypeExternalType2 Boolean
    OSPF external type 2 route
    matchRouteTypeInternal Boolean
    internal route (including OSPF intra/inter area)
    matchRouteTypeLevel1 Boolean
    IS-IS level-1 route
    matchRouteTypeLevel2 Boolean
    IS-IS level-2 route
    matchRouteTypeLocal Boolean
    locally generated route (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    matchSourceProtocolBgps List<String>
    Border Gateway Protocol (BGP)
    matchSourceProtocolConnected Boolean
    Connected
    matchSourceProtocolEigrps List<String>
    Border Gateway Protocol (BGP)
    matchSourceProtocolIsis Boolean
    ISO IS-IS
    matchSourceProtocolLisp Boolean
    Locator ID Separation Protocol (LISP)
    matchSourceProtocolOspfs List<String>
    Open Shortest Path First (OSPF)
    matchSourceProtocolOspfv3s List<String>
    OSPFv3
    matchSourceProtocolRip Boolean
    Routing Information Protocol (RIP)
    matchSourceProtocolStatic Boolean
    Static routes
    matchTags List<Integer>
    Tag value
    matchTrack Integer
    tracking object
    operation String
    seq Integer
    setAsPathPrependAs String
    \n\n;;AS number
    setAsPathPrependAsLegacy String
    \n\n;;AS number (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setAsPathPrependLastAs Integer
    setAsPathPrependLastAsLegacy Integer
    setAsPathTag Boolean
    Set the tag as an AS-path attribute
    setAsPathTagLegacy Boolean
    Set the tag as an AS-path attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setCommunities List<String>
    setCommunitiesAdditive Boolean
    setCommunitiesAdditiveLegacy Boolean
    setCommunitiesLegacies List<String>
    setCommunityListDelete Boolean
    Delete matching communities
    setCommunityListDeleteLegacy Boolean
    Delete matching communities (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setCommunityListExpanded Integer
    setCommunityListExpandedLegacy Integer
    setCommunityListName String
    setCommunityListNameLegacy String
    setCommunityListStandard Integer
    setCommunityListStandardLegacy Integer
    setCommunityNone Boolean
    No community attribute
    setCommunityNoneLegacy Boolean
    No community attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setDefaultInterfaces List<String>
    SPAN source interface
    setExtcomunityRtLegacies List<String>
    setExtcomunityRts List<String>
    setExtcomunitySoo String
    setExtcomunitySooLegacy String
    setExtcomunityVpnDistinguisher String
    VPN Distinguisher Extended Community
    setExtcomunityVpnDistinguisherAdditive Boolean
    setExtcomunityVpnDistinguisherLegacy String
    setGlobal Boolean
    setInterfaces List<String>
    Interface specific information
    setIpAddress String
    Specify prefix-list
    setIpDefaultGlobalNextHopAddresses List<String>
    setIpDefaultNextHopAddresses List<String>
    setIpGlobalNextHopAddresses List<String>
    setIpNextHopAddresses List<String>
    setIpNextHopSelf Boolean
    Use self address (for BGP only)
    setIpQosGroup Integer
    setIpv6Addresses List<String>
    IPv6 prefix-list
    setIpv6DefaultGlobalNextHop String
    Next hop along path
    setIpv6DefaultNextHops List<String>
    Default next hop IPv6 address
    setIpv6NextHops List<String>
    Next hop IPv6 address
    setLevel1 Boolean
    Import into a level-1 area
    setLevel12 Boolean
    Import into level-1 and level-2
    setLevel2 Boolean
    Import into level-2 sub-domain
    setLocalPreference Integer
    Preference value
    setLocalPreferenceLegacy Integer
    Preference value (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setMetricChange String
    +/-\n\n;;Add or subtract metric
    setMetricDelay String
    EIGRP delay metric, in 10 microsecond units
    setMetricLoading Integer
    EIGRP Effective bandwidth metric (Loading) where 255 is 100% loaded
    setMetricMtu Integer
    EIGRP MTU of the path
    setMetricReliability Integer
    EIGRP reliability metric where 255 is 100% reliable
    setMetricType String
    Type of metric for destination routing protocol
    setMetricValue Integer
    Metric value or Bandwidth in Kbits per second
    setTag Integer
    Tag value
    setVrf String
    VPN Routing/Forwarding instance name
    setWeight Integer
    BGP weight for routing table
    setWeightLegacy Integer
    BGP weight for routing table (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    continue boolean
    Continue on a different entry within the route-map
    continueSequenceNumber number
    Route-map entry sequence number
    description string
    Route-map comment
    matchAsPaths number[]
    AS path access-list
    matchAsPathsLegacies number[]
    AS path access-list (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    matchCommunityListExactMatch boolean
    Do exact matching of communities
    matchCommunityLists string[]
    Named Access List
    matchCommunityListsLegacies string[]
    Named Access List (DEPRECATED- please use community-list in Cisco-IOS-XE-bgp.yang)
    matchExtcommunityLists string[]
    Named Access List
    matchExtcommunityListsLegacies string[]
    Named Access List (DEPRECATED- please use extcommunity-list in Cisco-IOS-XE-bgp.yang)
    matchInterfaces string[]
    matchIpAddressAccessLists string[]
    matchIpAddressPrefixLists string[]
    Match entries of prefix-lists
    matchIpNextHopAccessLists string[]
    matchIpNextHopPrefixLists string[]
    Match entries of prefix-lists
    matchIpv6AddressAccessLists string
    matchIpv6AddressPrefixLists string
    IPv6 prefix-list
    matchIpv6NextHopAccessLists string
    matchIpv6NextHopPrefixLists string
    IPv6 prefix-list
    matchLocalPreferences number[]
    matchLocalPreferencesLegacies number[]
    matchRouteTypeExternal boolean
    external route (BGP, EIGRP and OSPF type 1/2)
    matchRouteTypeExternalType1 boolean
    OSPF external type 1 route
    matchRouteTypeExternalType2 boolean
    OSPF external type 2 route
    matchRouteTypeInternal boolean
    internal route (including OSPF intra/inter area)
    matchRouteTypeLevel1 boolean
    IS-IS level-1 route
    matchRouteTypeLevel2 boolean
    IS-IS level-2 route
    matchRouteTypeLocal boolean
    locally generated route (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    matchSourceProtocolBgps string[]
    Border Gateway Protocol (BGP)
    matchSourceProtocolConnected boolean
    Connected
    matchSourceProtocolEigrps string[]
    Border Gateway Protocol (BGP)
    matchSourceProtocolIsis boolean
    ISO IS-IS
    matchSourceProtocolLisp boolean
    Locator ID Separation Protocol (LISP)
    matchSourceProtocolOspfs string[]
    Open Shortest Path First (OSPF)
    matchSourceProtocolOspfv3s string[]
    OSPFv3
    matchSourceProtocolRip boolean
    Routing Information Protocol (RIP)
    matchSourceProtocolStatic boolean
    Static routes
    matchTags number[]
    Tag value
    matchTrack number
    tracking object
    operation string
    seq number
    setAsPathPrependAs string
    \n\n;;AS number
    setAsPathPrependAsLegacy string
    \n\n;;AS number (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setAsPathPrependLastAs number
    setAsPathPrependLastAsLegacy number
    setAsPathTag boolean
    Set the tag as an AS-path attribute
    setAsPathTagLegacy boolean
    Set the tag as an AS-path attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setCommunities string[]
    setCommunitiesAdditive boolean
    setCommunitiesAdditiveLegacy boolean
    setCommunitiesLegacies string[]
    setCommunityListDelete boolean
    Delete matching communities
    setCommunityListDeleteLegacy boolean
    Delete matching communities (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setCommunityListExpanded number
    setCommunityListExpandedLegacy number
    setCommunityListName string
    setCommunityListNameLegacy string
    setCommunityListStandard number
    setCommunityListStandardLegacy number
    setCommunityNone boolean
    No community attribute
    setCommunityNoneLegacy boolean
    No community attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setDefaultInterfaces string[]
    SPAN source interface
    setExtcomunityRtLegacies string[]
    setExtcomunityRts string[]
    setExtcomunitySoo string
    setExtcomunitySooLegacy string
    setExtcomunityVpnDistinguisher string
    VPN Distinguisher Extended Community
    setExtcomunityVpnDistinguisherAdditive boolean
    setExtcomunityVpnDistinguisherLegacy string
    setGlobal boolean
    setInterfaces string[]
    Interface specific information
    setIpAddress string
    Specify prefix-list
    setIpDefaultGlobalNextHopAddresses string[]
    setIpDefaultNextHopAddresses string[]
    setIpGlobalNextHopAddresses string[]
    setIpNextHopAddresses string[]
    setIpNextHopSelf boolean
    Use self address (for BGP only)
    setIpQosGroup number
    setIpv6Addresses string[]
    IPv6 prefix-list
    setIpv6DefaultGlobalNextHop string
    Next hop along path
    setIpv6DefaultNextHops string[]
    Default next hop IPv6 address
    setIpv6NextHops string[]
    Next hop IPv6 address
    setLevel1 boolean
    Import into a level-1 area
    setLevel12 boolean
    Import into level-1 and level-2
    setLevel2 boolean
    Import into level-2 sub-domain
    setLocalPreference number
    Preference value
    setLocalPreferenceLegacy number
    Preference value (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setMetricChange string
    +/-\n\n;;Add or subtract metric
    setMetricDelay string
    EIGRP delay metric, in 10 microsecond units
    setMetricLoading number
    EIGRP Effective bandwidth metric (Loading) where 255 is 100% loaded
    setMetricMtu number
    EIGRP MTU of the path
    setMetricReliability number
    EIGRP reliability metric where 255 is 100% reliable
    setMetricType string
    Type of metric for destination routing protocol
    setMetricValue number
    Metric value or Bandwidth in Kbits per second
    setTag number
    Tag value
    setVrf string
    VPN Routing/Forwarding instance name
    setWeight number
    BGP weight for routing table
    setWeightLegacy number
    BGP weight for routing table (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    continue_ bool
    Continue on a different entry within the route-map
    continue_sequence_number int
    Route-map entry sequence number
    description str
    Route-map comment
    match_as_paths Sequence[int]
    AS path access-list
    match_as_paths_legacies Sequence[int]
    AS path access-list (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    match_community_list_exact_match bool
    Do exact matching of communities
    match_community_lists Sequence[str]
    Named Access List
    match_community_lists_legacies Sequence[str]
    Named Access List (DEPRECATED- please use community-list in Cisco-IOS-XE-bgp.yang)
    match_extcommunity_lists Sequence[str]
    Named Access List
    match_extcommunity_lists_legacies Sequence[str]
    Named Access List (DEPRECATED- please use extcommunity-list in Cisco-IOS-XE-bgp.yang)
    match_interfaces Sequence[str]
    match_ip_address_access_lists Sequence[str]
    match_ip_address_prefix_lists Sequence[str]
    Match entries of prefix-lists
    match_ip_next_hop_access_lists Sequence[str]
    match_ip_next_hop_prefix_lists Sequence[str]
    Match entries of prefix-lists
    match_ipv6_address_access_lists str
    match_ipv6_address_prefix_lists str
    IPv6 prefix-list
    match_ipv6_next_hop_access_lists str
    match_ipv6_next_hop_prefix_lists str
    IPv6 prefix-list
    match_local_preferences Sequence[int]
    match_local_preferences_legacies Sequence[int]
    match_route_type_external bool
    external route (BGP, EIGRP and OSPF type 1/2)
    match_route_type_external_type1 bool
    OSPF external type 1 route
    match_route_type_external_type2 bool
    OSPF external type 2 route
    match_route_type_internal bool
    internal route (including OSPF intra/inter area)
    match_route_type_level1 bool
    IS-IS level-1 route
    match_route_type_level2 bool
    IS-IS level-2 route
    match_route_type_local bool
    locally generated route (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    match_source_protocol_bgps Sequence[str]
    Border Gateway Protocol (BGP)
    match_source_protocol_connected bool
    Connected
    match_source_protocol_eigrps Sequence[str]
    Border Gateway Protocol (BGP)
    match_source_protocol_isis bool
    ISO IS-IS
    match_source_protocol_lisp bool
    Locator ID Separation Protocol (LISP)
    match_source_protocol_ospfs Sequence[str]
    Open Shortest Path First (OSPF)
    match_source_protocol_ospfv3s Sequence[str]
    OSPFv3
    match_source_protocol_rip bool
    Routing Information Protocol (RIP)
    match_source_protocol_static bool
    Static routes
    match_tags Sequence[int]
    Tag value
    match_track int
    tracking object
    operation str
    seq int
    set_as_path_prepend_as str
    \n\n;;AS number
    set_as_path_prepend_as_legacy str
    \n\n;;AS number (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    set_as_path_prepend_last_as int
    set_as_path_prepend_last_as_legacy int
    set_as_path_tag bool
    Set the tag as an AS-path attribute
    set_as_path_tag_legacy bool
    Set the tag as an AS-path attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    set_communities Sequence[str]
    set_communities_additive bool
    set_communities_additive_legacy bool
    set_communities_legacies Sequence[str]
    set_community_list_delete bool
    Delete matching communities
    set_community_list_delete_legacy bool
    Delete matching communities (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    set_community_list_expanded int
    set_community_list_expanded_legacy int
    set_community_list_name str
    set_community_list_name_legacy str
    set_community_list_standard int
    set_community_list_standard_legacy int
    set_community_none bool
    No community attribute
    set_community_none_legacy bool
    No community attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    set_default_interfaces Sequence[str]
    SPAN source interface
    set_extcomunity_rt_legacies Sequence[str]
    set_extcomunity_rts Sequence[str]
    set_extcomunity_soo str
    set_extcomunity_soo_legacy str
    set_extcomunity_vpn_distinguisher str
    VPN Distinguisher Extended Community
    set_extcomunity_vpn_distinguisher_additive bool
    set_extcomunity_vpn_distinguisher_legacy str
    set_global bool
    set_interfaces Sequence[str]
    Interface specific information
    set_ip_address str
    Specify prefix-list
    set_ip_default_global_next_hop_addresses Sequence[str]
    set_ip_default_next_hop_addresses Sequence[str]
    set_ip_global_next_hop_addresses Sequence[str]
    set_ip_next_hop_addresses Sequence[str]
    set_ip_next_hop_self bool
    Use self address (for BGP only)
    set_ip_qos_group int
    set_ipv6_addresses Sequence[str]
    IPv6 prefix-list
    set_ipv6_default_global_next_hop str
    Next hop along path
    set_ipv6_default_next_hops Sequence[str]
    Default next hop IPv6 address
    set_ipv6_next_hops Sequence[str]
    Next hop IPv6 address
    set_level1 bool
    Import into a level-1 area
    set_level12 bool
    Import into level-1 and level-2
    set_level2 bool
    Import into level-2 sub-domain
    set_local_preference int
    Preference value
    set_local_preference_legacy int
    Preference value (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    set_metric_change str
    +/-\n\n;;Add or subtract metric
    set_metric_delay str
    EIGRP delay metric, in 10 microsecond units
    set_metric_loading int
    EIGRP Effective bandwidth metric (Loading) where 255 is 100% loaded
    set_metric_mtu int
    EIGRP MTU of the path
    set_metric_reliability int
    EIGRP reliability metric where 255 is 100% reliable
    set_metric_type str
    Type of metric for destination routing protocol
    set_metric_value int
    Metric value or Bandwidth in Kbits per second
    set_tag int
    Tag value
    set_vrf str
    VPN Routing/Forwarding instance name
    set_weight int
    BGP weight for routing table
    set_weight_legacy int
    BGP weight for routing table (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    continue Boolean
    Continue on a different entry within the route-map
    continueSequenceNumber Number
    Route-map entry sequence number
    description String
    Route-map comment
    matchAsPaths List<Number>
    AS path access-list
    matchAsPathsLegacies List<Number>
    AS path access-list (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    matchCommunityListExactMatch Boolean
    Do exact matching of communities
    matchCommunityLists List<String>
    Named Access List
    matchCommunityListsLegacies List<String>
    Named Access List (DEPRECATED- please use community-list in Cisco-IOS-XE-bgp.yang)
    matchExtcommunityLists List<String>
    Named Access List
    matchExtcommunityListsLegacies List<String>
    Named Access List (DEPRECATED- please use extcommunity-list in Cisco-IOS-XE-bgp.yang)
    matchInterfaces List<String>
    matchIpAddressAccessLists List<String>
    matchIpAddressPrefixLists List<String>
    Match entries of prefix-lists
    matchIpNextHopAccessLists List<String>
    matchIpNextHopPrefixLists List<String>
    Match entries of prefix-lists
    matchIpv6AddressAccessLists String
    matchIpv6AddressPrefixLists String
    IPv6 prefix-list
    matchIpv6NextHopAccessLists String
    matchIpv6NextHopPrefixLists String
    IPv6 prefix-list
    matchLocalPreferences List<Number>
    matchLocalPreferencesLegacies List<Number>
    matchRouteTypeExternal Boolean
    external route (BGP, EIGRP and OSPF type 1/2)
    matchRouteTypeExternalType1 Boolean
    OSPF external type 1 route
    matchRouteTypeExternalType2 Boolean
    OSPF external type 2 route
    matchRouteTypeInternal Boolean
    internal route (including OSPF intra/inter area)
    matchRouteTypeLevel1 Boolean
    IS-IS level-1 route
    matchRouteTypeLevel2 Boolean
    IS-IS level-2 route
    matchRouteTypeLocal Boolean
    locally generated route (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    matchSourceProtocolBgps List<String>
    Border Gateway Protocol (BGP)
    matchSourceProtocolConnected Boolean
    Connected
    matchSourceProtocolEigrps List<String>
    Border Gateway Protocol (BGP)
    matchSourceProtocolIsis Boolean
    ISO IS-IS
    matchSourceProtocolLisp Boolean
    Locator ID Separation Protocol (LISP)
    matchSourceProtocolOspfs List<String>
    Open Shortest Path First (OSPF)
    matchSourceProtocolOspfv3s List<String>
    OSPFv3
    matchSourceProtocolRip Boolean
    Routing Information Protocol (RIP)
    matchSourceProtocolStatic Boolean
    Static routes
    matchTags List<Number>
    Tag value
    matchTrack Number
    tracking object
    operation String
    seq Number
    setAsPathPrependAs String
    \n\n;;AS number
    setAsPathPrependAsLegacy String
    \n\n;;AS number (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setAsPathPrependLastAs Number
    setAsPathPrependLastAsLegacy Number
    setAsPathTag Boolean
    Set the tag as an AS-path attribute
    setAsPathTagLegacy Boolean
    Set the tag as an AS-path attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setCommunities List<String>
    setCommunitiesAdditive Boolean
    setCommunitiesAdditiveLegacy Boolean
    setCommunitiesLegacies List<String>
    setCommunityListDelete Boolean
    Delete matching communities
    setCommunityListDeleteLegacy Boolean
    Delete matching communities (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setCommunityListExpanded Number
    setCommunityListExpandedLegacy Number
    setCommunityListName String
    setCommunityListNameLegacy String
    setCommunityListStandard Number
    setCommunityListStandardLegacy Number
    setCommunityNone Boolean
    No community attribute
    setCommunityNoneLegacy Boolean
    No community attribute (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setDefaultInterfaces List<String>
    SPAN source interface
    setExtcomunityRtLegacies List<String>
    setExtcomunityRts List<String>
    setExtcomunitySoo String
    setExtcomunitySooLegacy String
    setExtcomunityVpnDistinguisher String
    VPN Distinguisher Extended Community
    setExtcomunityVpnDistinguisherAdditive Boolean
    setExtcomunityVpnDistinguisherLegacy String
    setGlobal Boolean
    setInterfaces List<String>
    Interface specific information
    setIpAddress String
    Specify prefix-list
    setIpDefaultGlobalNextHopAddresses List<String>
    setIpDefaultNextHopAddresses List<String>
    setIpGlobalNextHopAddresses List<String>
    setIpNextHopAddresses List<String>
    setIpNextHopSelf Boolean
    Use self address (for BGP only)
    setIpQosGroup Number
    setIpv6Addresses List<String>
    IPv6 prefix-list
    setIpv6DefaultGlobalNextHop String
    Next hop along path
    setIpv6DefaultNextHops List<String>
    Default next hop IPv6 address
    setIpv6NextHops List<String>
    Next hop IPv6 address
    setLevel1 Boolean
    Import into a level-1 area
    setLevel12 Boolean
    Import into level-1 and level-2
    setLevel2 Boolean
    Import into level-2 sub-domain
    setLocalPreference Number
    Preference value
    setLocalPreferenceLegacy Number
    Preference value (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)
    setMetricChange String
    +/-\n\n;;Add or subtract metric
    setMetricDelay String
    EIGRP delay metric, in 10 microsecond units
    setMetricLoading Number
    EIGRP Effective bandwidth metric (Loading) where 255 is 100% loaded
    setMetricMtu Number
    EIGRP MTU of the path
    setMetricReliability Number
    EIGRP reliability metric where 255 is 100% reliable
    setMetricType String
    Type of metric for destination routing protocol
    setMetricValue Number
    Metric value or Bandwidth in Kbits per second
    setTag Number
    Tag value
    setVrf String
    VPN Routing/Forwarding instance name
    setWeight Number
    BGP weight for routing table
    setWeightLegacy Number
    BGP weight for routing table (DEPRECATED - please use route-map configuration in Cisco-IOS-XE-bgp.yang)

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
    lbrlabs/pulumi-iosxe