getBgpRouteMap

Strata Cloud Manager v1.0.3, Jan 22 26

Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

// Look up bgp route map by its ID.
const scmBgpRouteMapDs = scm.getBgpRouteMap({
    id: "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
});
export const bgpRouteMapDataSourceResults = {
    id: scmBgpRouteMapDs.then(scmBgpRouteMapDs => scmBgpRouteMapDs.id),
    name: scmBgpRouteMapDs.then(scmBgpRouteMapDs => scmBgpRouteMapDs.name),
    routeMap: scmBgpRouteMapDs.then(scmBgpRouteMapDs => scmBgpRouteMapDs.routeMaps),
    folder: scmBgpRouteMapDs.then(scmBgpRouteMapDs => scmBgpRouteMapDs.folder),
};

import pulumi
import pulumi_scm as scm

# Look up bgp route map by its ID.
scm_bgp_route_map_ds = scm.get_bgp_route_map(id="f2ffd626-e92d-4de6-8ac1-37742fe80fb9")
pulumi.export("bgpRouteMapDataSourceResults", {
    "id": scm_bgp_route_map_ds.id,
    "name": scm_bgp_route_map_ds.name,
    "routeMap": scm_bgp_route_map_ds.route_maps,
    "folder": scm_bgp_route_map_ds.folder,
})

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Look up bgp route map by its ID.
		scmBgpRouteMapDs, err := scm.LookupBgpRouteMap(ctx, &scm.LookupBgpRouteMapArgs{
			Id: "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("bgpRouteMapDataSourceResults", pulumi.Map{
			"id":       scmBgpRouteMapDs.Id,
			"name":     scmBgpRouteMapDs.Name,
			"routeMap": scmBgpRouteMapDs.RouteMaps,
			"folder":   scmBgpRouteMapDs.Folder,
		})
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Look up bgp route map by its ID.
    var scmBgpRouteMapDs = Scm.GetBgpRouteMap.Invoke(new()
    {
        Id = "f2ffd626-e92d-4de6-8ac1-37742fe80fb9",
    });

    return new Dictionary<string, object?>
    {
        ["bgpRouteMapDataSourceResults"] = 
        {
            { "id", scmBgpRouteMapDs.Apply(getBgpRouteMapResult => getBgpRouteMapResult.Id) },
            { "name", scmBgpRouteMapDs.Apply(getBgpRouteMapResult => getBgpRouteMapResult.Name) },
            { "routeMap", scmBgpRouteMapDs.Apply(getBgpRouteMapResult => getBgpRouteMapResult.RouteMaps) },
            { "folder", scmBgpRouteMapDs.Apply(getBgpRouteMapResult => getBgpRouteMapResult.Folder) },
        },
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.ScmFunctions;
import com.pulumi.scm.inputs.GetBgpRouteMapArgs;
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) {
        // Look up bgp route map by its ID.
        final var scmBgpRouteMapDs = ScmFunctions.getBgpRouteMap(GetBgpRouteMapArgs.builder()
            .id("f2ffd626-e92d-4de6-8ac1-37742fe80fb9")
            .build());

        ctx.export("bgpRouteMapDataSourceResults", Map.ofEntries(
            Map.entry("id", scmBgpRouteMapDs.id()),
            Map.entry("name", scmBgpRouteMapDs.name()),
            Map.entry("routeMap", scmBgpRouteMapDs.routeMaps()),
            Map.entry("folder", scmBgpRouteMapDs.folder())
        ));
    }
}

variables:
  # Look up bgp route map by its ID.
  scmBgpRouteMapDs:
    fn::invoke:
      function: scm:getBgpRouteMap
      arguments:
        id: f2ffd626-e92d-4de6-8ac1-37742fe80fb9
outputs:
  # Output various attributes from the found bgp route maps to verify the lookups were successful.
  bgpRouteMapDataSourceResults:
    id: ${scmBgpRouteMapDs.id}
    name: ${scmBgpRouteMapDs.name}
    routeMap: ${scmBgpRouteMapDs.routeMaps}
    folder: ${scmBgpRouteMapDs.folder}

Using getBgpRouteMap

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 getBgpRouteMap(args: GetBgpRouteMapArgs, opts?: InvokeOptions): Promise<GetBgpRouteMapResult>
function getBgpRouteMapOutput(args: GetBgpRouteMapOutputArgs, opts?: InvokeOptions): Output<GetBgpRouteMapResult>

def get_bgp_route_map(device: Optional[str] = None,
                      folder: Optional[str] = None,
                      id: Optional[str] = None,
                      name: Optional[str] = None,
                      snippet: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBgpRouteMapResult
def get_bgp_route_map_output(device: Optional[pulumi.Input[str]] = None,
                      folder: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      snippet: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBgpRouteMapResult]

func LookupBgpRouteMap(ctx *Context, args *LookupBgpRouteMapArgs, opts ...InvokeOption) (*LookupBgpRouteMapResult, error)
func LookupBgpRouteMapOutput(ctx *Context, args *LookupBgpRouteMapOutputArgs, opts ...InvokeOption) LookupBgpRouteMapResultOutput

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

public static class GetBgpRouteMap 
{
    public static Task<GetBgpRouteMapResult> InvokeAsync(GetBgpRouteMapArgs args, InvokeOptions? opts = null)
    public static Output<GetBgpRouteMapResult> Invoke(GetBgpRouteMapInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBgpRouteMapResult> getBgpRouteMap(GetBgpRouteMapArgs args, InvokeOptions options)
public static Output<GetBgpRouteMapResult> getBgpRouteMap(GetBgpRouteMapArgs args, InvokeOptions options)

fn::invoke:
  function: scm:index/getBgpRouteMap:getBgpRouteMap
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: UUID of the resource
Device string: The device in which the resource is defined
Folder string
Name string
Snippet string

Id string: UUID of the resource
Device string: The device in which the resource is defined
Folder string
Name string
Snippet string

id String: UUID of the resource
device String: The device in which the resource is defined
folder String
name String
snippet String

id string: UUID of the resource
device string: The device in which the resource is defined
folder string
name string
snippet string

id str: UUID of the resource
device str: The device in which the resource is defined
folder str
name str
snippet str

id String: UUID of the resource
device String: The device in which the resource is defined
folder String
name String
snippet String

getBgpRouteMap Result

The following output properties are available:

Description string
Device string: The device in which the resource is defined
Folder string
Id string: UUID of the resource
Name string
RouteMaps List<GetBgpRouteMapRouteMap>
Snippet string
Tfid string

Description string
Device string: The device in which the resource is defined
Folder string
Id string: UUID of the resource
Name string
RouteMaps []GetBgpRouteMapRouteMap
Snippet string
Tfid string

description String
device String: The device in which the resource is defined
folder String
id String: UUID of the resource
name String
routeMaps List<GetBgpRouteMapRouteMap>
snippet String
tfid String

description string
device string: The device in which the resource is defined
folder string
id string: UUID of the resource
name string
routeMaps GetBgpRouteMapRouteMap[]
snippet string
tfid string

description str
device str: The device in which the resource is defined
folder str
id str: UUID of the resource
name str
route_maps Sequence[GetBgpRouteMapRouteMap]
snippet str
tfid str

description String
device String: The device in which the resource is defined
folder String
id String: UUID of the resource
name String
routeMaps List<Property Map>
snippet String
tfid String

Supporting Types

GetBgpRouteMapRouteMap

Action string: Action
Description string: Description
Match GetBgpRouteMapRouteMapMatch: Match
Name int: Sequence number
Set GetBgpRouteMapRouteMapSet: Set

Action string: Action
Description string: Description
Match GetBgpRouteMapRouteMapMatch: Match
Name int: Sequence number
Set GetBgpRouteMapRouteMapSet: Set

action String: Action
description String: Description
match GetBgpRouteMapRouteMapMatch: Match
name Integer: Sequence number
set GetBgpRouteMapRouteMapSet: Set

action string: Action
description string: Description
match GetBgpRouteMapRouteMapMatch: Match
name number: Sequence number
set GetBgpRouteMapRouteMapSet: Set

action str: Action
description str: Description
match GetBgpRouteMapRouteMapMatch: Match
name int: Sequence number
set GetBgpRouteMapRouteMapSet: Set

action String: Action
description String: Description
match Property Map: Match
name Number: Sequence number
set Property Map: Set

GetBgpRouteMapRouteMapMatch

AsPathAccessList string: AS path access list
ExtendedCommunity string: Extended community
Interface string: Interface
Ipv4 GetBgpRouteMapRouteMapMatchIpv4: bgp-route-maps ipv4 object
LargeCommunity string: Large community
LocalPreference int: Local preference
Metric int: Metric
Origin string: Origin
Peer string: Peer
RegularCommunity string: Regular community
Tag int: Tag

AsPathAccessList string: AS path access list
ExtendedCommunity string: Extended community
Interface string: Interface
Ipv4 GetBgpRouteMapRouteMapMatchIpv4: bgp-route-maps ipv4 object
LargeCommunity string: Large community
LocalPreference int: Local preference
Metric int: Metric
Origin string: Origin
Peer string: Peer
RegularCommunity string: Regular community
Tag int: Tag

asPathAccessList String: AS path access list
extendedCommunity String: Extended community
interface_ String: Interface
ipv4 GetBgpRouteMapRouteMapMatchIpv4: bgp-route-maps ipv4 object
largeCommunity String: Large community
localPreference Integer: Local preference
metric Integer: Metric
origin String: Origin
peer String: Peer
regularCommunity String: Regular community
tag Integer: Tag

asPathAccessList string: AS path access list
extendedCommunity string: Extended community
interface string: Interface
ipv4 GetBgpRouteMapRouteMapMatchIpv4: bgp-route-maps ipv4 object
largeCommunity string: Large community
localPreference number: Local preference
metric number: Metric
origin string: Origin
peer string: Peer
regularCommunity string: Regular community
tag number: Tag

as_path_access_list str: AS path access list
extended_community str: Extended community
interface str: Interface
ipv4 GetBgpRouteMapRouteMapMatchIpv4: bgp-route-maps ipv4 object
large_community str: Large community
local_preference int: Local preference
metric int: Metric
origin str: Origin
peer str: Peer
regular_community str: Regular community
tag int: Tag

asPathAccessList String: AS path access list
extendedCommunity String: Extended community
interface String: Interface
ipv4 Property Map: bgp-route-maps ipv4 object
largeCommunity String: Large community
localPreference Number: Local preference
metric Number: Metric
origin String: Origin
peer String: Peer
regularCommunity String: Regular community
tag Number: Tag

GetBgpRouteMapRouteMapMatchIpv4

Address GetBgpRouteMapRouteMapMatchIpv4Address: Address
NextHop GetBgpRouteMapRouteMapMatchIpv4NextHop: Next hop
RouteSource GetBgpRouteMapRouteMapMatchIpv4RouteSource: Route source

Address GetBgpRouteMapRouteMapMatchIpv4Address: Address
NextHop GetBgpRouteMapRouteMapMatchIpv4NextHop: Next hop
RouteSource GetBgpRouteMapRouteMapMatchIpv4RouteSource: Route source

address GetBgpRouteMapRouteMapMatchIpv4Address: Address
nextHop GetBgpRouteMapRouteMapMatchIpv4NextHop: Next hop
routeSource GetBgpRouteMapRouteMapMatchIpv4RouteSource: Route source

address GetBgpRouteMapRouteMapMatchIpv4Address: Address
nextHop GetBgpRouteMapRouteMapMatchIpv4NextHop: Next hop
routeSource GetBgpRouteMapRouteMapMatchIpv4RouteSource: Route source

address GetBgpRouteMapRouteMapMatchIpv4Address: Address
next_hop GetBgpRouteMapRouteMapMatchIpv4NextHop: Next hop
route_source GetBgpRouteMapRouteMapMatchIpv4RouteSource: Route source

address Property Map: Address
nextHop Property Map: Next hop
routeSource Property Map: Route source

GetBgpRouteMapRouteMapMatchIpv4Address

AccessList string: Access list
PrefixList string: Prefix list

AccessList string: Access list
PrefixList string: Prefix list

accessList String: Access list
prefixList String: Prefix list

accessList string: Access list
prefixList string: Prefix list

access_list str: Access list
prefix_list str: Prefix list

accessList String: Access list
prefixList String: Prefix list

GetBgpRouteMapRouteMapMatchIpv4NextHop

AccessList string: Access list
PrefixList string: Prefix list

AccessList string: Access list
PrefixList string: Prefix list

accessList String: Access list
prefixList String: Prefix list

accessList string: Access list
prefixList string: Prefix list

access_list str: Access list
prefix_list str: Prefix list

accessList String: Access list
prefixList String: Prefix list

GetBgpRouteMapRouteMapMatchIpv4RouteSource

AccessList string: Access list
PrefixList string: Prefix list

AccessList string: Access list
PrefixList string: Prefix list

accessList String: Access list
prefixList String: Prefix list

accessList string: Access list
prefixList string: Prefix list

access_list str: Access list
prefix_list str: Prefix list

accessList String: Access list
prefixList String: Prefix list

GetBgpRouteMapRouteMapSet

Aggregator GetBgpRouteMapRouteMapSetAggregator: bgp-route-maps aggregator
AspathExcludes List<int>: Aspath exclude
AspathPrepends List<int>: Aspath prepend
AtomicAggregate bool: Enable BGP atomic aggregate?
Ipv4 GetBgpRouteMapRouteMapSetIpv4: Ipv4
LargeCommunities List<string>: Large community
LocalPreference int: Local preference
Metric GetBgpRouteMapRouteMapSetMetric: Metric
Origin string: Origin
OriginatorId string: Originator ID
OverwriteLargeCommunity bool: Overwrite large community?
OverwriteRegularCommunity bool: Overwrite regular community?
RegularCommunities List<string>: Regular community
RemoveLargeCommunity string: Remove large community name
RemoveRegularCommunity string: Remove regular community name
Tag int: Tag
Weight int: Weight

Aggregator GetBgpRouteMapRouteMapSetAggregator: bgp-route-maps aggregator
AspathExcludes []int: Aspath exclude
AspathPrepends []int: Aspath prepend
AtomicAggregate bool: Enable BGP atomic aggregate?
Ipv4 GetBgpRouteMapRouteMapSetIpv4: Ipv4
LargeCommunities []string: Large community
LocalPreference int: Local preference
Metric GetBgpRouteMapRouteMapSetMetric: Metric
Origin string: Origin
OriginatorId string: Originator ID
OverwriteLargeCommunity bool: Overwrite large community?
OverwriteRegularCommunity bool: Overwrite regular community?
RegularCommunities []string: Regular community
RemoveLargeCommunity string: Remove large community name
RemoveRegularCommunity string: Remove regular community name
Tag int: Tag
Weight int: Weight

aggregator GetBgpRouteMapRouteMapSetAggregator: bgp-route-maps aggregator
aspathExcludes List<Integer>: Aspath exclude
aspathPrepends List<Integer>: Aspath prepend
atomicAggregate Boolean: Enable BGP atomic aggregate?
ipv4 GetBgpRouteMapRouteMapSetIpv4: Ipv4
largeCommunities List<String>: Large community
localPreference Integer: Local preference
metric GetBgpRouteMapRouteMapSetMetric: Metric
origin String: Origin
originatorId String: Originator ID
overwriteLargeCommunity Boolean: Overwrite large community?
overwriteRegularCommunity Boolean: Overwrite regular community?
regularCommunities List<String>: Regular community
removeLargeCommunity String: Remove large community name
removeRegularCommunity String: Remove regular community name
tag Integer: Tag
weight Integer: Weight

aggregator GetBgpRouteMapRouteMapSetAggregator: bgp-route-maps aggregator
aspathExcludes number[]: Aspath exclude
aspathPrepends number[]: Aspath prepend
atomicAggregate boolean: Enable BGP atomic aggregate?
ipv4 GetBgpRouteMapRouteMapSetIpv4: Ipv4
largeCommunities string[]: Large community
localPreference number: Local preference
metric GetBgpRouteMapRouteMapSetMetric: Metric
origin string: Origin
originatorId string: Originator ID
overwriteLargeCommunity boolean: Overwrite large community?
overwriteRegularCommunity boolean: Overwrite regular community?
regularCommunities string[]: Regular community
removeLargeCommunity string: Remove large community name
removeRegularCommunity string: Remove regular community name
tag number: Tag
weight number: Weight

aggregator GetBgpRouteMapRouteMapSetAggregator: bgp-route-maps aggregator
aspath_excludes Sequence[int]: Aspath exclude
aspath_prepends Sequence[int]: Aspath prepend
atomic_aggregate bool: Enable BGP atomic aggregate?
ipv4 GetBgpRouteMapRouteMapSetIpv4: Ipv4
large_communities Sequence[str]: Large community
local_preference int: Local preference
metric GetBgpRouteMapRouteMapSetMetric: Metric
origin str: Origin
originator_id str: Originator ID
overwrite_large_community bool: Overwrite large community?
overwrite_regular_community bool: Overwrite regular community?
regular_communities Sequence[str]: Regular community
remove_large_community str: Remove large community name
remove_regular_community str: Remove regular community name
tag int: Tag
weight int: Weight

aggregator Property Map: bgp-route-maps aggregator
aspathExcludes List<Number>: Aspath exclude
aspathPrepends List<Number>: Aspath prepend
atomicAggregate Boolean: Enable BGP atomic aggregate?
ipv4 Property Map: Ipv4
largeCommunities List<String>: Large community
localPreference Number: Local preference
metric Property Map: Metric
origin String: Origin
originatorId String: Originator ID
overwriteLargeCommunity Boolean: Overwrite large community?
overwriteRegularCommunity Boolean: Overwrite regular community?
regularCommunities List<String>: Regular community
removeLargeCommunity String: Remove large community name
removeRegularCommunity String: Remove regular community name
tag Number: Tag
weight Number: Weight

GetBgpRouteMapRouteMapSetAggregator

As int: Aggregator AS
RouterId string: Router ID

As int: Aggregator AS
RouterId string: Router ID

as Integer: Aggregator AS
routerId String: Router ID

as number: Aggregator AS
routerId string: Router ID

as_ int: Aggregator AS
router_id str: Router ID

as Number: Aggregator AS
routerId String: Router ID

GetBgpRouteMapRouteMapSetIpv4

NextHop string: Next hop
SourceAddress string: Source address

NextHop string: Next hop
SourceAddress string: Source address

nextHop String: Next hop
sourceAddress String: Source address

nextHop string: Next hop
sourceAddress string: Source address

next_hop str: Next hop
source_address str: Source address

nextHop String: Next hop
sourceAddress String: Source address

GetBgpRouteMapRouteMapSetMetric

Action string: Metric action
Value int: Metric value

Action string: Metric action
Value int: Metric value

action String: Metric action
value Integer: Metric value

action string: Metric action
value number: Metric value

action str: Metric action
value int: Metric value

action String: Metric action
value Number: Metric value

Package Details

Repository: scm pulumi/pulumi-scm
License: Apache-2.0
Notes: This Pulumi package is based on the scm Terraform Provider.

Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

scm.getBgpRouteMap

On this page

On this page

Example Usage

Using getBgpRouteMap

getBgpRouteMap Result

Supporting Types

GetBgpRouteMapRouteMap

GetBgpRouteMapRouteMapMatch

GetBgpRouteMapRouteMapMatchIpv4

GetBgpRouteMapRouteMapMatchIpv4Address

GetBgpRouteMapRouteMapMatchIpv4NextHop

GetBgpRouteMapRouteMapMatchIpv4RouteSource

GetBgpRouteMapRouteMapSet

GetBgpRouteMapRouteMapSetAggregator

GetBgpRouteMapRouteMapSetIpv4

GetBgpRouteMapRouteMapSetMetric

Package Details

On this page

On this page