ibm 1.83.2, Oct 7 25

ibm 1.83.2 published on Tuesday, Oct 7, 2025 by ibm-cloud

ibm.getPiNetworkPeers

Explore with Pulumi AI

ibm 1.83.2 published on Tuesday, Oct 7, 2025 by ibm-cloud

Example Usage

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

const piNetworkPeers = ibm.getPiNetworkPeers({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});

import pulumi
import pulumi_ibm as ibm

pi_network_peers = ibm.get_pi_network_peers(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")

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.GetPiNetworkPeers(ctx, &ibm.GetPiNetworkPeersArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
		}, 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 piNetworkPeers = Ibm.GetPiNetworkPeers.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });

});

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.GetPiNetworkPeersArgs;
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 piNetworkPeers = IbmFunctions.getPiNetworkPeers(GetPiNetworkPeersArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}

variables:
  piNetworkPeers:
    fn::invoke:
      function: ibm:getPiNetworkPeers
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b

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 getPiNetworkPeers

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 getPiNetworkPeers(args: GetPiNetworkPeersArgs, opts?: InvokeOptions): Promise<GetPiNetworkPeersResult>
function getPiNetworkPeersOutput(args: GetPiNetworkPeersOutputArgs, opts?: InvokeOptions): Output<GetPiNetworkPeersResult>

def get_pi_network_peers(id: Optional[str] = None,
                         pi_cloud_instance_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPiNetworkPeersResult
def get_pi_network_peers_output(id: Optional[pulumi.Input[str]] = None,
                         pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPiNetworkPeersResult]

func GetPiNetworkPeers(ctx *Context, args *GetPiNetworkPeersArgs, opts ...InvokeOption) (*GetPiNetworkPeersResult, error)
func GetPiNetworkPeersOutput(ctx *Context, args *GetPiNetworkPeersOutputArgs, opts ...InvokeOption) GetPiNetworkPeersResultOutput

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

public static class GetPiNetworkPeers 
{
    public static Task<GetPiNetworkPeersResult> InvokeAsync(GetPiNetworkPeersArgs args, InvokeOptions? opts = null)
    public static Output<GetPiNetworkPeersResult> Invoke(GetPiNetworkPeersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPiNetworkPeersResult> getPiNetworkPeers(GetPiNetworkPeersArgs args, InvokeOptions options)
public static Output<GetPiNetworkPeersResult> getPiNetworkPeers(GetPiNetworkPeersArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getPiNetworkPeers:getPiNetworkPeers
  arguments:
    # arguments dictionary

The following arguments are supported:

PiCloudInstanceId string: The GUID of the service instance associated with an account.
Id string: (String) ID of the network peer.

PiCloudInstanceId string: The GUID of the service instance associated with an account.
Id string: (String) ID of the network peer.

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String: (String) ID of the network peer.

piCloudInstanceId string: The GUID of the service instance associated with an account.
id string: (String) ID of the network peer.

pi_cloud_instance_id str: The GUID of the service instance associated with an account.
id str: (String) ID of the network peer.

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String: (String) ID of the network peer.

getPiNetworkPeers Result

The following output properties are available:

Id string: (String) ID of the network peer.
NetworkPeers List<GetPiNetworkPeersNetworkPeer>: (List) List of network peers.
PiCloudInstanceId string

Id string: (String) ID of the network peer.
NetworkPeers []GetPiNetworkPeersNetworkPeer: (List) List of network peers.
PiCloudInstanceId string

id String: (String) ID of the network peer.
networkPeers List<GetPiNetworkPeersNetworkPeer>: (List) List of network peers.
piCloudInstanceId String

id string: (String) ID of the network peer.
networkPeers GetPiNetworkPeersNetworkPeer[]: (List) List of network peers.
piCloudInstanceId string

id str: (String) ID of the network peer.
network_peers Sequence[GetPiNetworkPeersNetworkPeer]: (List) List of network peers.
pi_cloud_instance_id str

id String: (String) ID of the network peer.
networkPeers List<Property Map>: (List) List of network peers.
piCloudInstanceId String

Supporting Types

GetPiNetworkPeersNetworkPeer

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.
Description string
Error string: (String) Error description.
ExportRouteFilters List<GetPiNetworkPeersNetworkPeerExportRouteFilter>: (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) ID of the network peer.
ImportRouteFilters List<GetPiNetworkPeersNetworkPeerImportRouteFilter>: (List) List of import route filters.
Name string: (String) User defined name.
PeerInterfaceId string: (String) Peer interface id.
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.
Description string
Error string: (String) Error description.
ExportRouteFilters []GetPiNetworkPeersNetworkPeerExportRouteFilter: (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) ID of the network peer.
ImportRouteFilters []GetPiNetworkPeersNetworkPeerImportRouteFilter: (List) List of import route filters.
Name string: (String) User defined name.
PeerInterfaceId string: (String) Peer interface id.
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.
description String
error String: (String) Error description.
exportRouteFilters List<GetPiNetworkPeersNetworkPeerExportRouteFilter>: (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) ID of the network peer.
importRouteFilters List<GetPiNetworkPeersNetworkPeerImportRouteFilter>: (List) List of import route filters.
name String: (String) User defined name.
peerInterfaceId String: (String) Peer interface id.
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.
description string
error string: (String) Error description.
exportRouteFilters GetPiNetworkPeersNetworkPeerExportRouteFilter[]: (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) ID of the network peer.
importRouteFilters GetPiNetworkPeersNetworkPeerImportRouteFilter[]: (List) List of import route filters.
name string: (String) User defined name.
peerInterfaceId string: (String) Peer interface id.
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.
description str
error str: (String) Error description.
export_route_filters Sequence[GetPiNetworkPeersNetworkPeerExportRouteFilter]: (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) ID of the network peer.
import_route_filters Sequence[GetPiNetworkPeersNetworkPeerImportRouteFilter]: (List) List of import route filters.
name str: (String) User defined name.
peer_interface_id str: (String) Peer interface id.
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.
description String
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) ID 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.
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.

GetPiNetworkPeersNetworkPeerExportRouteFilter

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.

GetPiNetworkPeersNetworkPeerImportRouteFilter

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 1.83.2 published on Tuesday, Oct 7, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getPiNetworkPeers

On this page

On this page

Example Usage

Notes

Using getPiNetworkPeers

getPiNetworkPeers Result

Supporting Types

GetPiNetworkPeersNetworkPeer

GetPiNetworkPeersNetworkPeerExportRouteFilter

GetPiNetworkPeersNetworkPeerImportRouteFilter

Package Details

On this page

On this page