Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiNetworks
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiNetworks

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Retrieve a list of networks that you can use in your Power Systems Virtual Server instance. For more information, about power virtual server instance networks, see setting up an IBM network install server.

Example Usage

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

const dsNetwork = ibm.getPiNetworks({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});
Copy
import pulumi
import pulumi_ibm as ibm

ds_network = ibm.get_pi_networks(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")
Copy
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.GetPiNetworks(ctx, &ibm.GetPiNetworksArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var dsNetwork = Ibm.GetPiNetworks.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });

});
Copy
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.GetPiNetworksArgs;
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 dsNetwork = IbmFunctions.getPiNetworks(GetPiNetworksArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}
Copy
variables:
  dsNetwork:
    fn::invoke:
      function: ibm:getPiNetworks
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
Copy

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";
Copy
import pulumi
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Using getPiNetworks

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 getPiNetworks(args: GetPiNetworksArgs, opts?: InvokeOptions): Promise<GetPiNetworksResult>
function getPiNetworksOutput(args: GetPiNetworksOutputArgs, opts?: InvokeOptions): Output<GetPiNetworksResult>
Copy
def get_pi_networks(id: Optional[str] = None,
                    pi_cloud_instance_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPiNetworksResult
def get_pi_networks_output(id: Optional[pulumi.Input[str]] = None,
                    pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetPiNetworksResult]
Copy
func GetPiNetworks(ctx *Context, args *GetPiNetworksArgs, opts ...InvokeOption) (*GetPiNetworksResult, error)
func GetPiNetworksOutput(ctx *Context, args *GetPiNetworksOutputArgs, opts ...InvokeOption) GetPiNetworksResultOutput
Copy

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

public static class GetPiNetworks 
{
    public static Task<GetPiNetworksResult> InvokeAsync(GetPiNetworksArgs args, InvokeOptions? opts = null)
    public static Output<GetPiNetworksResult> Invoke(GetPiNetworksInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPiNetworksResult> getPiNetworks(GetPiNetworksArgs args, InvokeOptions options)
public static Output<GetPiNetworksResult> getPiNetworks(GetPiNetworksArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getPiNetworks:getPiNetworks
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
Id string
PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
Id string
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
id String
piCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
id string
pi_cloud_instance_id This property is required. str
The GUID of the service instance associated with an account.
id str
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
id String

getPiNetworks Result

The following output properties are available:

Id string
Networks List<GetPiNetworksNetwork>
(List) List of all networks.
PiCloudInstanceId string
Id string
Networks []GetPiNetworksNetwork
(List) List of all networks.
PiCloudInstanceId string
id String
networks List<GetPiNetworksNetwork>
(List) List of all networks.
piCloudInstanceId String
id string
networks GetPiNetworksNetwork[]
(List) List of all networks.
piCloudInstanceId string
id String
networks List<Property Map>
(List) List of all networks.
piCloudInstanceId String

Supporting Types

GetPiNetworksNetwork

AccessConfig This property is required. string
(Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Crn This property is required. string
(String) The CRN of this resource.
DhcpManaged This property is required. bool
(Boolean) Indicates if the network DHCP Managed.
Href This property is required. string
(String) The hyper link of a network.
Mtu This property is required. double
(Boolean) Maximum Transmission Unit option of the network.
Name This property is required. string
(String) The name of a network.
NetworkId This property is required. string
(String) The ID of the network.
PeerId This property is required. string
(String) Network peer ID (for on-prem locations only).
Type This property is required. string
(String) The type of network.
UserTags This property is required. List<string>
(List) List of user tags attached to the resource.
VlanId This property is required. double
(String) The VLAN ID that the network is connected to.
AccessConfig This property is required. string
(Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Crn This property is required. string
(String) The CRN of this resource.
DhcpManaged This property is required. bool
(Boolean) Indicates if the network DHCP Managed.
Href This property is required. string
(String) The hyper link of a network.
Mtu This property is required. float64
(Boolean) Maximum Transmission Unit option of the network.
Name This property is required. string
(String) The name of a network.
NetworkId This property is required. string
(String) The ID of the network.
PeerId This property is required. string
(String) Network peer ID (for on-prem locations only).
Type This property is required. string
(String) The type of network.
UserTags This property is required. []string
(List) List of user tags attached to the resource.
VlanId This property is required. float64
(String) The VLAN ID that the network is connected to.
accessConfig This property is required. String
(Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
crn This property is required. String
(String) The CRN of this resource.
dhcpManaged This property is required. Boolean
(Boolean) Indicates if the network DHCP Managed.
href This property is required. String
(String) The hyper link of a network.
mtu This property is required. Double
(Boolean) Maximum Transmission Unit option of the network.
name This property is required. String
(String) The name of a network.
networkId This property is required. String
(String) The ID of the network.
peerId This property is required. String
(String) Network peer ID (for on-prem locations only).
type This property is required. String
(String) The type of network.
userTags This property is required. List<String>
(List) List of user tags attached to the resource.
vlanId This property is required. Double
(String) The VLAN ID that the network is connected to.
accessConfig This property is required. string
(Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
crn This property is required. string
(String) The CRN of this resource.
dhcpManaged This property is required. boolean
(Boolean) Indicates if the network DHCP Managed.
href This property is required. string
(String) The hyper link of a network.
mtu This property is required. number
(Boolean) Maximum Transmission Unit option of the network.
name This property is required. string
(String) The name of a network.
networkId This property is required. string
(String) The ID of the network.
peerId This property is required. string
(String) Network peer ID (for on-prem locations only).
type This property is required. string
(String) The type of network.
userTags This property is required. string[]
(List) List of user tags attached to the resource.
vlanId This property is required. number
(String) The VLAN ID that the network is connected to.
access_config This property is required. str
(Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
crn This property is required. str
(String) The CRN of this resource.
dhcp_managed This property is required. bool
(Boolean) Indicates if the network DHCP Managed.
href This property is required. str
(String) The hyper link of a network.
mtu This property is required. float
(Boolean) Maximum Transmission Unit option of the network.
name This property is required. str
(String) The name of a network.
network_id This property is required. str
(String) The ID of the network.
peer_id This property is required. str
(String) Network peer ID (for on-prem locations only).
type This property is required. str
(String) The type of network.
user_tags This property is required. Sequence[str]
(List) List of user tags attached to the resource.
vlan_id This property is required. float
(String) The VLAN ID that the network is connected to.
accessConfig This property is required. String
(Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
crn This property is required. String
(String) The CRN of this resource.
dhcpManaged This property is required. Boolean
(Boolean) Indicates if the network DHCP Managed.
href This property is required. String
(String) The hyper link of a network.
mtu This property is required. Number
(Boolean) Maximum Transmission Unit option of the network.
name This property is required. String
(String) The name of a network.
networkId This property is required. String
(String) The ID of the network.
peerId This property is required. String
(String) Network peer ID (for on-prem locations only).
type This property is required. String
(String) The type of network.
userTags This property is required. List<String>
(List) List of user tags attached to the resource.
vlanId This property is required. Number
(String) The VLAN ID that the network is connected to.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm