ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getPiNetwork

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

Example Usage

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

const dsNetwork = ibm.getPiNetwork({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    piNetworkName: "APP",
});

import pulumi
import pulumi_ibm as ibm

ds_network = ibm.get_pi_network(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    pi_network_name="APP")

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.LookupPiNetwork(ctx, &ibm.LookupPiNetworkArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
			PiNetworkName:     "APP",
		}, 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 dsNetwork = Ibm.GetPiNetwork.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        PiNetworkName = "APP",
    });

});

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.GetPiNetworkArgs;
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.getPiNetwork(GetPiNetworkArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .piNetworkName("APP")
            .build());

    }
}

variables:
  dsNetwork:
    fn::invoke:
      function: ibm:getPiNetwork
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
        piNetworkName: APP

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 getPiNetwork

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 getPiNetwork(args: GetPiNetworkArgs, opts?: InvokeOptions): Promise<GetPiNetworkResult>
function getPiNetworkOutput(args: GetPiNetworkOutputArgs, opts?: InvokeOptions): Output<GetPiNetworkResult>

def get_pi_network(id: Optional[str] = None,
                   pi_cloud_instance_id: Optional[str] = None,
                   pi_network_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPiNetworkResult
def get_pi_network_output(id: Optional[pulumi.Input[str]] = None,
                   pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                   pi_network_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPiNetworkResult]

func LookupPiNetwork(ctx *Context, args *LookupPiNetworkArgs, opts ...InvokeOption) (*LookupPiNetworkResult, error)
func LookupPiNetworkOutput(ctx *Context, args *LookupPiNetworkOutputArgs, opts ...InvokeOption) LookupPiNetworkResultOutput

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

public static class GetPiNetwork 
{
    public static Task<GetPiNetworkResult> InvokeAsync(GetPiNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetPiNetworkResult> Invoke(GetPiNetworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPiNetworkResult> getPiNetwork(GetPiNetworkArgs args, InvokeOptions options)
public static Output<GetPiNetworkResult> getPiNetwork(GetPiNetworkArgs args, InvokeOptions options)

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

The following arguments are supported:

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

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

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

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

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

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

getPiNetwork Result

The following output properties are available:

AccessConfig string: (Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Deprecated: Deprecated
AvailableIpCount double: (Float) The total number of IP addresses that you have in your network.
Cidr string: (String) The CIDR of the network.
Crn string: (String) The CRN of this resource.
Dns List<string>: (Set) The DNS Servers for the network.
Gateway string: (String) The network gateway that is attached to your network.
Id string: (String) The ID of the network.
Jumbo bool: (Deprecated, Boolean) MTU Jumbo option of the network (for multi-zone locations only).
Deprecated: Deprecated
Mtu double: (Boolean) Maximum Transmission Unit option of the network.
Name string: Deprecated: Deprecated
NetworkAddressTranslations List<GetPiNetworkNetworkAddressTranslation>: (List) Contains the network address translation details (for on-prem locations only).
PeerId string: (String) Network peer ID (for on-prem locations only).
PiCloudInstanceId string
PiNetworkName string
Type string: (String) The type of network.
UsedIpCount double: (Float) The number of used IP addresses.
UsedIpPercent double: (Float) The percentage of IP addresses used.
UserTags List<string>: (List) List of user tags attached to the resource.
VlanId double: (String) The VLAN ID that the network is connected to.

AccessConfig string: (Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Deprecated: Deprecated
AvailableIpCount float64: (Float) The total number of IP addresses that you have in your network.
Cidr string: (String) The CIDR of the network.
Crn string: (String) The CRN of this resource.
Dns []string: (Set) The DNS Servers for the network.
Gateway string: (String) The network gateway that is attached to your network.
Id string: (String) The ID of the network.
Jumbo bool: (Deprecated, Boolean) MTU Jumbo option of the network (for multi-zone locations only).
Deprecated: Deprecated
Mtu float64: (Boolean) Maximum Transmission Unit option of the network.
Name string: Deprecated: Deprecated
NetworkAddressTranslations []GetPiNetworkNetworkAddressTranslation: (List) Contains the network address translation details (for on-prem locations only).
PeerId string: (String) Network peer ID (for on-prem locations only).
PiCloudInstanceId string
PiNetworkName string
Type string: (String) The type of network.
UsedIpCount float64: (Float) The number of used IP addresses.
UsedIpPercent float64: (Float) The percentage of IP addresses used.
UserTags []string: (List) List of user tags attached to the resource.
VlanId float64: (String) The VLAN ID that the network is connected to.

accessConfig String: (Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Deprecated: Deprecated
availableIpCount Double: (Float) The total number of IP addresses that you have in your network.
cidr String: (String) The CIDR of the network.
crn String: (String) The CRN of this resource.
dns List<String>: (Set) The DNS Servers for the network.
gateway String: (String) The network gateway that is attached to your network.
id String: (String) The ID of the network.
jumbo Boolean: (Deprecated, Boolean) MTU Jumbo option of the network (for multi-zone locations only).
Deprecated: Deprecated
mtu Double: (Boolean) Maximum Transmission Unit option of the network.
name String: Deprecated: Deprecated
networkAddressTranslations List<GetPiNetworkNetworkAddressTranslation>: (List) Contains the network address translation details (for on-prem locations only).
peerId String: (String) Network peer ID (for on-prem locations only).
piCloudInstanceId String
piNetworkName String
type String: (String) The type of network.
usedIpCount Double: (Float) The number of used IP addresses.
usedIpPercent Double: (Float) The percentage of IP addresses used.
userTags List<String>: (List) List of user tags attached to the resource.
vlanId Double: (String) The VLAN ID that the network is connected to.

accessConfig string: (Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Deprecated: Deprecated
availableIpCount number: (Float) The total number of IP addresses that you have in your network.
cidr string: (String) The CIDR of the network.
crn string: (String) The CRN of this resource.
dns string[]: (Set) The DNS Servers for the network.
gateway string: (String) The network gateway that is attached to your network.
id string: (String) The ID of the network.
jumbo boolean: (Deprecated, Boolean) MTU Jumbo option of the network (for multi-zone locations only).
Deprecated: Deprecated
mtu number: (Boolean) Maximum Transmission Unit option of the network.
name string: Deprecated: Deprecated
networkAddressTranslations GetPiNetworkNetworkAddressTranslation[]: (List) Contains the network address translation details (for on-prem locations only).
peerId string: (String) Network peer ID (for on-prem locations only).
piCloudInstanceId string
piNetworkName string
type string: (String) The type of network.
usedIpCount number: (Float) The number of used IP addresses.
usedIpPercent number: (Float) The percentage of IP addresses used.
userTags string[]: (List) List of user tags attached to the resource.
vlanId number: (String) The VLAN ID that the network is connected to.

access_config str: (Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Deprecated: Deprecated
available_ip_count float: (Float) The total number of IP addresses that you have in your network.
cidr str: (String) The CIDR of the network.
crn str: (String) The CRN of this resource.
dns Sequence[str]: (Set) The DNS Servers for the network.
gateway str: (String) The network gateway that is attached to your network.
id str: (String) The ID of the network.
jumbo bool: (Deprecated, Boolean) MTU Jumbo option of the network (for multi-zone locations only).
Deprecated: Deprecated
mtu float: (Boolean) Maximum Transmission Unit option of the network.
name str: Deprecated: Deprecated
network_address_translations Sequence[GetPiNetworkNetworkAddressTranslation]: (List) Contains the network address translation details (for on-prem locations only).
peer_id str: (String) Network peer ID (for on-prem locations only).
pi_cloud_instance_id str
pi_network_name str
type str: (String) The type of network.
used_ip_count float: (Float) The number of used IP addresses.
used_ip_percent float: (Float) The percentage of IP addresses used.
user_tags Sequence[str]: (List) List of user tags attached to the resource.
vlan_id float: (String) The VLAN ID that the network is connected to.

accessConfig String: (Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
Deprecated: Deprecated
availableIpCount Number: (Float) The total number of IP addresses that you have in your network.
cidr String: (String) The CIDR of the network.
crn String: (String) The CRN of this resource.
dns List<String>: (Set) The DNS Servers for the network.
gateway String: (String) The network gateway that is attached to your network.
id String: (String) The ID of the network.
jumbo Boolean: (Deprecated, Boolean) MTU Jumbo option of the network (for multi-zone locations only).
Deprecated: Deprecated
mtu Number: (Boolean) Maximum Transmission Unit option of the network.
name String: Deprecated: Deprecated
networkAddressTranslations List<Property Map>: (List) Contains the network address translation details (for on-prem locations only).
peerId String: (String) Network peer ID (for on-prem locations only).
piCloudInstanceId String
piNetworkName String
type String: (String) The type of network.
usedIpCount Number: (Float) The number of used IP addresses.
usedIpPercent Number: (Float) The percentage of IP addresses used.
userTags List<String>: (List) List of user tags attached to the resource.
vlanId Number: (String) The VLAN ID that the network is connected to.

Supporting Types

GetPiNetworkNetworkAddressTranslation

SourceIp string: (String) source IP address.

SourceIp string: (String) source IP address.

sourceIp String: (String) source IP address.

sourceIp string: (String) source IP address.

source_ip str: (String) source IP address.

sourceIp String: (String) source IP address.

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.getPiNetwork

On this page

On this page

Example Usage

Notes

Using getPiNetwork

getPiNetwork Result

Supporting Types

GetPiNetworkNetworkAddressTranslation

Package Details

On this page

On this page