1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiNetworkPeerRouteFilter
ibm 1.84.0 published on Monday, Oct 13, 2025 by ibm-cloud

ibm.getPiNetworkPeerRouteFilter

Deploy with Pulumi
ibm logo
ibm 1.84.0 published on Monday, Oct 13, 2025 by ibm-cloud

    Provides a read-only data source to retrieve information about a pi_network_peer_route_filter for on-prem locations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const piNetworkPeerRouteFilter = ibm.getPiNetworkPeerRouteFilter({
        piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        piNetworkPeerId: "8e047a5c-d24f-11ec-9655-526e74301ad0",
        piRouteFilterId: "a1f2b3c4-d5e6-7890-fghi-jklmno123456",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    pi_network_peer_route_filter = ibm.get_pi_network_peer_route_filter(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        pi_network_peer_id="8e047a5c-d24f-11ec-9655-526e74301ad0",
        pi_route_filter_id="a1f2b3c4-d5e6-7890-fghi-jklmno123456")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupPiNetworkPeerRouteFilter(ctx, &ibm.LookupPiNetworkPeerRouteFilterArgs{
    			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    			PiNetworkPeerId:   "8e047a5c-d24f-11ec-9655-526e74301ad0",
    			PiRouteFilterId:   "a1f2b3c4-d5e6-7890-fghi-jklmno123456",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var piNetworkPeerRouteFilter = Ibm.GetPiNetworkPeerRouteFilter.Invoke(new()
        {
            PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
            PiNetworkPeerId = "8e047a5c-d24f-11ec-9655-526e74301ad0",
            PiRouteFilterId = "a1f2b3c4-d5e6-7890-fghi-jklmno123456",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetPiNetworkPeerRouteFilterArgs;
    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 piNetworkPeerRouteFilter = IbmFunctions.getPiNetworkPeerRouteFilter(GetPiNetworkPeerRouteFilterArgs.builder()
                .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
                .piNetworkPeerId("8e047a5c-d24f-11ec-9655-526e74301ad0")
                .piRouteFilterId("a1f2b3c4-d5e6-7890-fghi-jklmno123456")
                .build());
    
        }
    }
    
    variables:
      piNetworkPeerRouteFilter:
        fn::invoke:
          function: ibm:getPiNetworkPeerRouteFilter
          arguments:
            piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
            piNetworkPeerId: 8e047a5c-d24f-11ec-9655-526e74301ad0
            piRouteFilterId: a1f2b3c4-d5e6-7890-fghi-jklmno123456
    

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    Using getPiNetworkPeerRouteFilter

    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 getPiNetworkPeerRouteFilter(args: GetPiNetworkPeerRouteFilterArgs, opts?: InvokeOptions): Promise<GetPiNetworkPeerRouteFilterResult>
    function getPiNetworkPeerRouteFilterOutput(args: GetPiNetworkPeerRouteFilterOutputArgs, opts?: InvokeOptions): Output<GetPiNetworkPeerRouteFilterResult>
    def get_pi_network_peer_route_filter(id: Optional[str] = None,
                                         pi_cloud_instance_id: Optional[str] = None,
                                         pi_network_peer_id: Optional[str] = None,
                                         pi_route_filter_id: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetPiNetworkPeerRouteFilterResult
    def get_pi_network_peer_route_filter_output(id: Optional[pulumi.Input[str]] = None,
                                         pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                                         pi_network_peer_id: Optional[pulumi.Input[str]] = None,
                                         pi_route_filter_id: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetPiNetworkPeerRouteFilterResult]
    func LookupPiNetworkPeerRouteFilter(ctx *Context, args *LookupPiNetworkPeerRouteFilterArgs, opts ...InvokeOption) (*LookupPiNetworkPeerRouteFilterResult, error)
    func LookupPiNetworkPeerRouteFilterOutput(ctx *Context, args *LookupPiNetworkPeerRouteFilterOutputArgs, opts ...InvokeOption) LookupPiNetworkPeerRouteFilterResultOutput

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

    public static class GetPiNetworkPeerRouteFilter 
    {
        public static Task<GetPiNetworkPeerRouteFilterResult> InvokeAsync(GetPiNetworkPeerRouteFilterArgs args, InvokeOptions? opts = null)
        public static Output<GetPiNetworkPeerRouteFilterResult> Invoke(GetPiNetworkPeerRouteFilterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiNetworkPeerRouteFilterResult> getPiNetworkPeerRouteFilter(GetPiNetworkPeerRouteFilterArgs args, InvokeOptions options)
    public static Output<GetPiNetworkPeerRouteFilterResult> getPiNetworkPeerRouteFilter(GetPiNetworkPeerRouteFilterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiNetworkPeerRouteFilter:getPiNetworkPeerRouteFilter
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkPeerId string
    Network peer ID.
    PiRouteFilterId string
    Route filter ID.
    Id string
    (String) The unique identifier of the pi_network_peer_route_filter.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkPeerId string
    Network peer ID.
    PiRouteFilterId string
    Route filter ID.
    Id string
    (String) The unique identifier of the pi_network_peer_route_filter.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkPeerId String
    Network peer ID.
    piRouteFilterId String
    Route filter ID.
    id String
    (String) The unique identifier of the pi_network_peer_route_filter.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piNetworkPeerId string
    Network peer ID.
    piRouteFilterId string
    Route filter ID.
    id string
    (String) The unique identifier of the pi_network_peer_route_filter.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_network_peer_id str
    Network peer ID.
    pi_route_filter_id str
    Route filter ID.
    id str
    (String) The unique identifier of the pi_network_peer_route_filter.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkPeerId String
    Network peer ID.
    piRouteFilterId String
    Route filter ID.
    id String
    (String) The unique identifier of the pi_network_peer_route_filter.

    getPiNetworkPeerRouteFilter Result

    The following output properties are available:

    Action string
    (String) Action of the filter.
    CreationDate string
    (String) Time stamp for create route filter.
    Direction string
    (String) Direction of the filter.
    Error string
    (String) Error description.
    Ge double
    (Integer) The minimum matching length of the prefix-set.
    Id string
    (String) The unique identifier of the pi_network_peer_route_filter.
    Index double
    (Integer) Priority or order of the filter.
    Le double
    (Integer) The maximum matching length of the prefix-set.
    PiCloudInstanceId string
    PiNetworkPeerId string
    PiRouteFilterId string
    Prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    RouteFilterId string
    State string
    (String) Status of the route filter.
    Action string
    (String) Action of the filter.
    CreationDate string
    (String) Time stamp for create route filter.
    Direction string
    (String) Direction of the filter.
    Error string
    (String) Error description.
    Ge float64
    (Integer) The minimum matching length of the prefix-set.
    Id string
    (String) The unique identifier of the pi_network_peer_route_filter.
    Index float64
    (Integer) Priority or order of the filter.
    Le float64
    (Integer) The maximum matching length of the prefix-set.
    PiCloudInstanceId string
    PiNetworkPeerId string
    PiRouteFilterId string
    Prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    RouteFilterId string
    State string
    (String) Status of the route filter.
    action String
    (String) Action of the filter.
    creationDate String
    (String) Time stamp for create route filter.
    direction String
    (String) Direction of the filter.
    error String
    (String) Error description.
    ge Double
    (Integer) The minimum matching length of the prefix-set.
    id String
    (String) The unique identifier of the pi_network_peer_route_filter.
    index Double
    (Integer) Priority or order of the filter.
    le Double
    (Integer) The maximum matching length of the prefix-set.
    piCloudInstanceId String
    piNetworkPeerId String
    piRouteFilterId String
    prefix String
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId String
    state String
    (String) Status of the route filter.
    action string
    (String) Action of the filter.
    creationDate string
    (String) Time stamp for create route filter.
    direction string
    (String) Direction of the filter.
    error string
    (String) Error description.
    ge number
    (Integer) The minimum matching length of the prefix-set.
    id string
    (String) The unique identifier of the pi_network_peer_route_filter.
    index number
    (Integer) Priority or order of the filter.
    le number
    (Integer) The maximum matching length of the prefix-set.
    piCloudInstanceId string
    piNetworkPeerId string
    piRouteFilterId string
    prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId string
    state string
    (String) Status of the route filter.
    action str
    (String) Action of the filter.
    creation_date str
    (String) Time stamp for create route filter.
    direction str
    (String) Direction of the filter.
    error str
    (String) Error description.
    ge float
    (Integer) The minimum matching length of the prefix-set.
    id str
    (String) The unique identifier of the pi_network_peer_route_filter.
    index float
    (Integer) Priority or order of the filter.
    le float
    (Integer) The maximum matching length of the prefix-set.
    pi_cloud_instance_id str
    pi_network_peer_id str
    pi_route_filter_id str
    prefix str
    (String) IP prefix representing an address and mask length of the prefix-set.
    route_filter_id str
    state str
    (String) Status of the route filter.
    action String
    (String) Action of the filter.
    creationDate String
    (String) Time stamp for create route filter.
    direction String
    (String) Direction of the filter.
    error String
    (String) Error description.
    ge Number
    (Integer) The minimum matching length of the prefix-set.
    id String
    (String) The unique identifier of the pi_network_peer_route_filter.
    index Number
    (Integer) Priority or order of the filter.
    le Number
    (Integer) The maximum matching length of the prefix-set.
    piCloudInstanceId String
    piNetworkPeerId String
    piRouteFilterId String
    prefix String
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId String
    state String
    (String) Status of the route filter.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.84.0 published on Monday, Oct 13, 2025 by ibm-cloud
      Meet Neo: Your AI Platform Teammate