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

ibm.getPiNetworkPeer

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 pi_network_peer for on-prem locations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const piNetworkPeer = ibm.getPiNetworkPeer({
        piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        piNetworkPeerId: "123e4567-e89b-12d3-a456-426614174000",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    pi_network_peer = ibm.get_pi_network_peer(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        pi_network_peer_id="123e4567-e89b-12d3-a456-426614174000")
    
    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.LookupPiNetworkPeer(ctx, &ibm.LookupPiNetworkPeerArgs{
    			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    			PiNetworkPeerId:   "123e4567-e89b-12d3-a456-426614174000",
    		}, 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 piNetworkPeer = Ibm.GetPiNetworkPeer.Invoke(new()
        {
            PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
            PiNetworkPeerId = "123e4567-e89b-12d3-a456-426614174000",
        });
    
    });
    
    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.GetPiNetworkPeerArgs;
    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 piNetworkPeer = IbmFunctions.getPiNetworkPeer(GetPiNetworkPeerArgs.builder()
                .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
                .piNetworkPeerId("123e4567-e89b-12d3-a456-426614174000")
                .build());
    
        }
    }
    
    variables:
      piNetworkPeer:
        fn::invoke:
          function: ibm:getPiNetworkPeer
          arguments:
            piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
            piNetworkPeerId: 123e4567-e89b-12d3-a456-426614174000
    

    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 getPiNetworkPeer

    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 getPiNetworkPeer(args: GetPiNetworkPeerArgs, opts?: InvokeOptions): Promise<GetPiNetworkPeerResult>
    function getPiNetworkPeerOutput(args: GetPiNetworkPeerOutputArgs, opts?: InvokeOptions): Output<GetPiNetworkPeerResult>
    def get_pi_network_peer(id: Optional[str] = None,
                            pi_cloud_instance_id: Optional[str] = None,
                            pi_network_peer_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPiNetworkPeerResult
    def get_pi_network_peer_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,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPiNetworkPeerResult]
    func LookupPiNetworkPeer(ctx *Context, args *LookupPiNetworkPeerArgs, opts ...InvokeOption) (*LookupPiNetworkPeerResult, error)
    func LookupPiNetworkPeerOutput(ctx *Context, args *LookupPiNetworkPeerOutputArgs, opts ...InvokeOption) LookupPiNetworkPeerResultOutput

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

    public static class GetPiNetworkPeer 
    {
        public static Task<GetPiNetworkPeerResult> InvokeAsync(GetPiNetworkPeerArgs args, InvokeOptions? opts = null)
        public static Output<GetPiNetworkPeerResult> Invoke(GetPiNetworkPeerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiNetworkPeerResult> getPiNetworkPeer(GetPiNetworkPeerArgs args, InvokeOptions options)
    public static Output<GetPiNetworkPeerResult> getPiNetworkPeer(GetPiNetworkPeerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiNetworkPeer:getPiNetworkPeer
      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.
    Id string
    (String) The unique identifier of the network peer.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkPeerId string
    Network peer ID.
    Id string
    (String) The unique identifier of the network peer.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkPeerId String
    Network peer ID.
    id String
    (String) The unique identifier of the network peer.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piNetworkPeerId string
    Network peer ID.
    id string
    (String) The unique identifier of the network peer.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_network_peer_id str
    Network peer ID.
    id str
    (String) The unique identifier of the network peer.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkPeerId String
    Network peer ID.
    id String
    (String) The unique identifier of the network peer.

    getPiNetworkPeer Result

    The following output properties are available:

    CreationDate string
    (String) Time stamp for create route filter.
    CustomerAsn double
    (Integer) ASN number at customer network side.
    CustomerCidr string
    (String) IP address used for configuring customer network interface with network subnet mask.
    DefaultExportRouteFilter string
    (String) Default action for export route filter.
    DefaultImportRouteFilter string
    (String) Default action for import route filter.
    Error string
    (String) Error description.
    ExportRouteFilters List<GetPiNetworkPeerExportRouteFilter>
    (List) List of export route filters.
    IbmAsn double
    (Integer) ASN number at IBM PowerVS side.
    IbmCidr string
    (String) IP address used for configuring IBM network interface with network subnet mask.
    Id string
    (String) The unique identifier of the network peer.
    ImportRouteFilters List<GetPiNetworkPeerImportRouteFilter>
    (List) List of import route filters.
    Name string
    (String) User defined name.
    PeerInterfaceId string
    (String) Peer interface id.
    PiCloudInstanceId string
    PiNetworkPeerId string
    State string
    (String) Status of the network peer.
    Type string
    (String) Type of the peer network.
    UpdatedDate string
    (String) Time stamp for update network peer.
    Vlan double
    (Integer) A vlan configured at the customer network.
    CreationDate string
    (String) Time stamp for create route filter.
    CustomerAsn float64
    (Integer) ASN number at customer network side.
    CustomerCidr string
    (String) IP address used for configuring customer network interface with network subnet mask.
    DefaultExportRouteFilter string
    (String) Default action for export route filter.
    DefaultImportRouteFilter string
    (String) Default action for import route filter.
    Error string
    (String) Error description.
    ExportRouteFilters []GetPiNetworkPeerExportRouteFilter
    (List) List of export route filters.
    IbmAsn float64
    (Integer) ASN number at IBM PowerVS side.
    IbmCidr string
    (String) IP address used for configuring IBM network interface with network subnet mask.
    Id string
    (String) The unique identifier of the network peer.
    ImportRouteFilters []GetPiNetworkPeerImportRouteFilter
    (List) List of import route filters.
    Name string
    (String) User defined name.
    PeerInterfaceId string
    (String) Peer interface id.
    PiCloudInstanceId string
    PiNetworkPeerId string
    State string
    (String) Status of the network peer.
    Type string
    (String) Type of the peer network.
    UpdatedDate string
    (String) Time stamp for update network peer.
    Vlan float64
    (Integer) A vlan configured at the customer network.
    creationDate String
    (String) Time stamp for create route filter.
    customerAsn Double
    (Integer) ASN number at customer network side.
    customerCidr String
    (String) IP address used for configuring customer network interface with network subnet mask.
    defaultExportRouteFilter String
    (String) Default action for export route filter.
    defaultImportRouteFilter String
    (String) Default action for import route filter.
    error String
    (String) Error description.
    exportRouteFilters List<GetPiNetworkPeerExportRouteFilter>
    (List) List of export route filters.
    ibmAsn Double
    (Integer) ASN number at IBM PowerVS side.
    ibmCidr String
    (String) IP address used for configuring IBM network interface with network subnet mask.
    id String
    (String) The unique identifier of the network peer.
    importRouteFilters List<GetPiNetworkPeerImportRouteFilter>
    (List) List of import route filters.
    name String
    (String) User defined name.
    peerInterfaceId String
    (String) Peer interface id.
    piCloudInstanceId String
    piNetworkPeerId String
    state String
    (String) Status of the network peer.
    type String
    (String) Type of the peer network.
    updatedDate String
    (String) Time stamp for update network peer.
    vlan Double
    (Integer) A vlan configured at the customer network.
    creationDate string
    (String) Time stamp for create route filter.
    customerAsn number
    (Integer) ASN number at customer network side.
    customerCidr string
    (String) IP address used for configuring customer network interface with network subnet mask.
    defaultExportRouteFilter string
    (String) Default action for export route filter.
    defaultImportRouteFilter string
    (String) Default action for import route filter.
    error string
    (String) Error description.
    exportRouteFilters GetPiNetworkPeerExportRouteFilter[]
    (List) List of export route filters.
    ibmAsn number
    (Integer) ASN number at IBM PowerVS side.
    ibmCidr string
    (String) IP address used for configuring IBM network interface with network subnet mask.
    id string
    (String) The unique identifier of the network peer.
    importRouteFilters GetPiNetworkPeerImportRouteFilter[]
    (List) List of import route filters.
    name string
    (String) User defined name.
    peerInterfaceId string
    (String) Peer interface id.
    piCloudInstanceId string
    piNetworkPeerId string
    state string
    (String) Status of the network peer.
    type string
    (String) Type of the peer network.
    updatedDate string
    (String) Time stamp for update network peer.
    vlan number
    (Integer) A vlan configured at the customer network.
    creation_date str
    (String) Time stamp for create route filter.
    customer_asn float
    (Integer) ASN number at customer network side.
    customer_cidr str
    (String) IP address used for configuring customer network interface with network subnet mask.
    default_export_route_filter str
    (String) Default action for export route filter.
    default_import_route_filter str
    (String) Default action for import route filter.
    error str
    (String) Error description.
    export_route_filters Sequence[GetPiNetworkPeerExportRouteFilter]
    (List) List of export route filters.
    ibm_asn float
    (Integer) ASN number at IBM PowerVS side.
    ibm_cidr str
    (String) IP address used for configuring IBM network interface with network subnet mask.
    id str
    (String) The unique identifier of the network peer.
    import_route_filters Sequence[GetPiNetworkPeerImportRouteFilter]
    (List) List of import route filters.
    name str
    (String) User defined name.
    peer_interface_id str
    (String) Peer interface id.
    pi_cloud_instance_id str
    pi_network_peer_id str
    state str
    (String) Status of the network peer.
    type str
    (String) Type of the peer network.
    updated_date str
    (String) Time stamp for update network peer.
    vlan float
    (Integer) A vlan configured at the customer network.
    creationDate String
    (String) Time stamp for create route filter.
    customerAsn Number
    (Integer) ASN number at customer network side.
    customerCidr String
    (String) IP address used for configuring customer network interface with network subnet mask.
    defaultExportRouteFilter String
    (String) Default action for export route filter.
    defaultImportRouteFilter String
    (String) Default action for import route filter.
    error String
    (String) Error description.
    exportRouteFilters List<Property Map>
    (List) List of export route filters.
    ibmAsn Number
    (Integer) ASN number at IBM PowerVS side.
    ibmCidr String
    (String) IP address used for configuring IBM network interface with network subnet mask.
    id String
    (String) The unique identifier of the network peer.
    importRouteFilters List<Property Map>
    (List) List of import route filters.
    name String
    (String) User defined name.
    peerInterfaceId String
    (String) Peer interface id.
    piCloudInstanceId String
    piNetworkPeerId String
    state String
    (String) Status of the network peer.
    type String
    (String) Type of the peer network.
    updatedDate String
    (String) Time stamp for update network peer.
    vlan Number
    (Integer) A vlan configured at the customer network.

    Supporting Types

    GetPiNetworkPeerExportRouteFilter

    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.
    Index double
    (Integer) Priority or order of the filter.
    Le double
    (Integer) The maximum matching length of the prefix-set.
    Prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    RouteFilterId string
    (String) Route filter ID.
    State string
    (String) Status of the network peer.
    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.
    Index float64
    (Integer) Priority or order of the filter.
    Le float64
    (Integer) The maximum matching length of the prefix-set.
    Prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    RouteFilterId string
    (String) Route filter ID.
    State string
    (String) Status of the network peer.
    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.
    index Double
    (Integer) Priority or order of the filter.
    le Double
    (Integer) The maximum matching length of the prefix-set.
    prefix String
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId String
    (String) Route filter ID.
    state String
    (String) Status of the network peer.
    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.
    index number
    (Integer) Priority or order of the filter.
    le number
    (Integer) The maximum matching length of the prefix-set.
    prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId string
    (String) Route filter ID.
    state string
    (String) Status of the network peer.
    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.
    index float
    (Integer) Priority or order of the filter.
    le float
    (Integer) The maximum matching length of the prefix-set.
    prefix str
    (String) IP prefix representing an address and mask length of the prefix-set.
    route_filter_id str
    (String) Route filter ID.
    state str
    (String) Status of the network peer.
    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.
    index Number
    (Integer) Priority or order of the filter.
    le Number
    (Integer) The maximum matching length of the prefix-set.
    prefix String
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId String
    (String) Route filter ID.
    state String
    (String) Status of the network peer.

    GetPiNetworkPeerImportRouteFilter

    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.
    Index double
    (Integer) Priority or order of the filter.
    Le double
    (Integer) The maximum matching length of the prefix-set.
    Prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    RouteFilterId string
    (String) Route filter ID.
    State string
    (String) Status of the network peer.
    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.
    Index float64
    (Integer) Priority or order of the filter.
    Le float64
    (Integer) The maximum matching length of the prefix-set.
    Prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    RouteFilterId string
    (String) Route filter ID.
    State string
    (String) Status of the network peer.
    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.
    index Double
    (Integer) Priority or order of the filter.
    le Double
    (Integer) The maximum matching length of the prefix-set.
    prefix String
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId String
    (String) Route filter ID.
    state String
    (String) Status of the network peer.
    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.
    index number
    (Integer) Priority or order of the filter.
    le number
    (Integer) The maximum matching length of the prefix-set.
    prefix string
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId string
    (String) Route filter ID.
    state string
    (String) Status of the network peer.
    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.
    index float
    (Integer) Priority or order of the filter.
    le float
    (Integer) The maximum matching length of the prefix-set.
    prefix str
    (String) IP prefix representing an address and mask length of the prefix-set.
    route_filter_id str
    (String) Route filter ID.
    state str
    (String) Status of the network peer.
    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.
    index Number
    (Integer) Priority or order of the filter.
    le Number
    (Integer) The maximum matching length of the prefix-set.
    prefix String
    (String) IP prefix representing an address and mask length of the prefix-set.
    routeFilterId String
    (String) Route filter ID.
    state String
    (String) Status of the network peer.

    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