1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getBgpRouteMapList
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
scm logo
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

    Retrieves a listing of config items.

    Using getBgpRouteMapList

    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 getBgpRouteMapList(args: GetBgpRouteMapListArgs, opts?: InvokeOptions): Promise<GetBgpRouteMapListResult>
    function getBgpRouteMapListOutput(args: GetBgpRouteMapListOutputArgs, opts?: InvokeOptions): Output<GetBgpRouteMapListResult>
    def get_bgp_route_map_list(device: Optional[str] = None,
                               folder: Optional[str] = None,
                               limit: Optional[int] = None,
                               name: Optional[str] = None,
                               offset: Optional[int] = None,
                               snippet: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetBgpRouteMapListResult
    def get_bgp_route_map_list_output(device: Optional[pulumi.Input[str]] = None,
                               folder: Optional[pulumi.Input[str]] = None,
                               limit: Optional[pulumi.Input[int]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               offset: Optional[pulumi.Input[int]] = None,
                               snippet: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetBgpRouteMapListResult]
    func GetBgpRouteMapList(ctx *Context, args *GetBgpRouteMapListArgs, opts ...InvokeOption) (*GetBgpRouteMapListResult, error)
    func GetBgpRouteMapListOutput(ctx *Context, args *GetBgpRouteMapListOutputArgs, opts ...InvokeOption) GetBgpRouteMapListResultOutput

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

    public static class GetBgpRouteMapList 
    {
        public static Task<GetBgpRouteMapListResult> InvokeAsync(GetBgpRouteMapListArgs args, InvokeOptions? opts = null)
        public static Output<GetBgpRouteMapListResult> Invoke(GetBgpRouteMapListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBgpRouteMapListResult> getBgpRouteMapList(GetBgpRouteMapListArgs args, InvokeOptions options)
    public static Output<GetBgpRouteMapListResult> getBgpRouteMapList(GetBgpRouteMapListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getBgpRouteMapList:getBgpRouteMapList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    getBgpRouteMapList Result

    The following output properties are available:

    Datas List<GetBgpRouteMapListData>
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Datas []GetBgpRouteMapListData
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    datas List<GetBgpRouteMapListData>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    total Integer
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    datas GetBgpRouteMapListData[]
    The data.
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    total number
    The total number of items.
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    datas Sequence[GetBgpRouteMapListData]
    The data.
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    total int
    The total number of items.
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    datas List<Property Map>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    total Number
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    Supporting Types

    GetBgpRouteMapListData

    Description string
    Description
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    Name string
    Name
    RouteMaps List<GetBgpRouteMapListDataRouteMap>
    Route map
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    Description string
    Description
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the resource
    Name string
    Name
    RouteMaps []GetBgpRouteMapListDataRouteMap
    Route map
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    description String
    Description
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    name String
    Name
    routeMaps List<GetBgpRouteMapListDataRouteMap>
    Route map
    snippet String
    The snippet in which the resource is defined
    tfid String
    description string
    Description
    device string
    The device in which the resource is defined
    folder string
    The folder in which the resource is defined
    id string
    UUID of the resource
    name string
    Name
    routeMaps GetBgpRouteMapListDataRouteMap[]
    Route map
    snippet string
    The snippet in which the resource is defined
    tfid string
    description str
    Description
    device str
    The device in which the resource is defined
    folder str
    The folder in which the resource is defined
    id str
    UUID of the resource
    name str
    Name
    route_maps Sequence[GetBgpRouteMapListDataRouteMap]
    Route map
    snippet str
    The snippet in which the resource is defined
    tfid str
    description String
    Description
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    id String
    UUID of the resource
    name String
    Name
    routeMaps List<Property Map>
    Route map
    snippet String
    The snippet in which the resource is defined
    tfid String

    GetBgpRouteMapListDataRouteMap

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

    GetBgpRouteMapListDataRouteMapMatch

    AsPathAccessList string
    AS path access list
    ExtendedCommunity string
    Extended community
    Interface string
    Interface
    Ipv4 GetBgpRouteMapListDataRouteMapMatchIpv4
    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 GetBgpRouteMapListDataRouteMapMatchIpv4
    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 GetBgpRouteMapListDataRouteMapMatchIpv4
    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 GetBgpRouteMapListDataRouteMapMatchIpv4
    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 GetBgpRouteMapListDataRouteMapMatchIpv4
    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

    GetBgpRouteMapListDataRouteMapMatchIpv4

    GetBgpRouteMapListDataRouteMapMatchIpv4Address

    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

    GetBgpRouteMapListDataRouteMapMatchIpv4NextHop

    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

    GetBgpRouteMapListDataRouteMapMatchIpv4RouteSource

    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

    GetBgpRouteMapListDataRouteMapSet

    Aggregator GetBgpRouteMapListDataRouteMapSetAggregator
    bgp-route-maps aggregator
    AspathExcludes List<int>
    Aspath exclude
    AspathPrepends List<int>
    Aspath prepend
    AtomicAggregate bool
    Enable BGP atomic aggregate?
    Ipv4 GetBgpRouteMapListDataRouteMapSetIpv4
    Ipv4
    LargeCommunities List<string>
    Large community
    LocalPreference int
    Local preference
    Metric GetBgpRouteMapListDataRouteMapSetMetric
    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 GetBgpRouteMapListDataRouteMapSetAggregator
    bgp-route-maps aggregator
    AspathExcludes []int
    Aspath exclude
    AspathPrepends []int
    Aspath prepend
    AtomicAggregate bool
    Enable BGP atomic aggregate?
    Ipv4 GetBgpRouteMapListDataRouteMapSetIpv4
    Ipv4
    LargeCommunities []string
    Large community
    LocalPreference int
    Local preference
    Metric GetBgpRouteMapListDataRouteMapSetMetric
    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 GetBgpRouteMapListDataRouteMapSetAggregator
    bgp-route-maps aggregator
    aspathExcludes List<Integer>
    Aspath exclude
    aspathPrepends List<Integer>
    Aspath prepend
    atomicAggregate Boolean
    Enable BGP atomic aggregate?
    ipv4 GetBgpRouteMapListDataRouteMapSetIpv4
    Ipv4
    largeCommunities List<String>
    Large community
    localPreference Integer
    Local preference
    metric GetBgpRouteMapListDataRouteMapSetMetric
    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 GetBgpRouteMapListDataRouteMapSetAggregator
    bgp-route-maps aggregator
    aspathExcludes number[]
    Aspath exclude
    aspathPrepends number[]
    Aspath prepend
    atomicAggregate boolean
    Enable BGP atomic aggregate?
    ipv4 GetBgpRouteMapListDataRouteMapSetIpv4
    Ipv4
    largeCommunities string[]
    Large community
    localPreference number
    Local preference
    metric GetBgpRouteMapListDataRouteMapSetMetric
    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 GetBgpRouteMapListDataRouteMapSetAggregator
    bgp-route-maps aggregator
    aspath_excludes Sequence[int]
    Aspath exclude
    aspath_prepends Sequence[int]
    Aspath prepend
    atomic_aggregate bool
    Enable BGP atomic aggregate?
    ipv4 GetBgpRouteMapListDataRouteMapSetIpv4
    Ipv4
    large_communities Sequence[str]
    Large community
    local_preference int
    Local preference
    metric GetBgpRouteMapListDataRouteMapSetMetric
    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

    GetBgpRouteMapListDataRouteMapSetAggregator

    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

    GetBgpRouteMapListDataRouteMapSetIpv4

    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

    GetBgpRouteMapListDataRouteMapSetMetric

    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.
    scm logo
    Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate