1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiInstanceNetwork
ibm 1.87.0-beta1 published on Monday, Dec 22, 2025 by ibm-cloud
ibm logo
ibm 1.87.0-beta1 published on Monday, Dec 22, 2025 by ibm-cloud

    Retrieve information about a specific network on a Power Systems Virtual Server instance. For more information about Power Virtual Server instances, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const dsInstanceNetwork = ibm.getPiInstanceNetwork({
        piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        piInstanceId: "cea6651a-bc0a-4438-9f8a-a0770b112ebb",
        piNetworkId: "52b7c0b1-1df1-495a-9c2d-8b7a6c5ef9aa",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    ds_instance_network = ibm.get_pi_instance_network(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        pi_instance_id="cea6651a-bc0a-4438-9f8a-a0770b112ebb",
        pi_network_id="52b7c0b1-1df1-495a-9c2d-8b7a6c5ef9aa")
    
    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.LookupPiInstanceNetwork(ctx, &ibm.LookupPiInstanceNetworkArgs{
    			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    			PiInstanceId:      "cea6651a-bc0a-4438-9f8a-a0770b112ebb",
    			PiNetworkId:       "52b7c0b1-1df1-495a-9c2d-8b7a6c5ef9aa",
    		}, 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 dsInstanceNetwork = Ibm.GetPiInstanceNetwork.Invoke(new()
        {
            PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
            PiInstanceId = "cea6651a-bc0a-4438-9f8a-a0770b112ebb",
            PiNetworkId = "52b7c0b1-1df1-495a-9c2d-8b7a6c5ef9aa",
        });
    
    });
    
    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.GetPiInstanceNetworkArgs;
    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 dsInstanceNetwork = IbmFunctions.getPiInstanceNetwork(GetPiInstanceNetworkArgs.builder()
                .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
                .piInstanceId("cea6651a-bc0a-4438-9f8a-a0770b112ebb")
                .piNetworkId("52b7c0b1-1df1-495a-9c2d-8b7a6c5ef9aa")
                .build());
    
        }
    }
    
    variables:
      dsInstanceNetwork:
        fn::invoke:
          function: ibm:getPiInstanceNetwork
          arguments:
            piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
            piInstanceId: cea6651a-bc0a-4438-9f8a-a0770b112ebb
            piNetworkId: 52b7c0b1-1df1-495a-9c2d-8b7a6c5ef9aa
    

    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 getPiInstanceNetwork

    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 getPiInstanceNetwork(args: GetPiInstanceNetworkArgs, opts?: InvokeOptions): Promise<GetPiInstanceNetworkResult>
    function getPiInstanceNetworkOutput(args: GetPiInstanceNetworkOutputArgs, opts?: InvokeOptions): Output<GetPiInstanceNetworkResult>
    def get_pi_instance_network(id: Optional[str] = None,
                                pi_cloud_instance_id: Optional[str] = None,
                                pi_instance_id: Optional[str] = None,
                                pi_network_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetPiInstanceNetworkResult
    def get_pi_instance_network_output(id: Optional[pulumi.Input[str]] = None,
                                pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                                pi_instance_id: Optional[pulumi.Input[str]] = None,
                                pi_network_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetPiInstanceNetworkResult]
    func LookupPiInstanceNetwork(ctx *Context, args *LookupPiInstanceNetworkArgs, opts ...InvokeOption) (*LookupPiInstanceNetworkResult, error)
    func LookupPiInstanceNetworkOutput(ctx *Context, args *LookupPiInstanceNetworkOutputArgs, opts ...InvokeOption) LookupPiInstanceNetworkResultOutput

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

    public static class GetPiInstanceNetwork 
    {
        public static Task<GetPiInstanceNetworkResult> InvokeAsync(GetPiInstanceNetworkArgs args, InvokeOptions? opts = null)
        public static Output<GetPiInstanceNetworkResult> Invoke(GetPiInstanceNetworkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiInstanceNetworkResult> getPiInstanceNetwork(GetPiInstanceNetworkArgs args, InvokeOptions options)
    public static Output<GetPiInstanceNetworkResult> getPiInstanceNetwork(GetPiInstanceNetworkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiInstanceNetwork:getPiInstanceNetwork
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceId string
    The PVM instance id.
    PiNetworkId string
    The network id.
    Id string
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceId string
    The PVM instance id.
    PiNetworkId string
    The network id.
    Id string
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceId String
    The PVM instance id.
    piNetworkId String
    The network id.
    id String
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piInstanceId string
    The PVM instance id.
    piNetworkId string
    The network id.
    id string
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_instance_id str
    The PVM instance id.
    pi_network_id str
    The network id.
    id str
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceId String
    The PVM instance id.
    piNetworkId String
    The network id.
    id String
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.

    getPiInstanceNetwork Result

    The following output properties are available:

    ExternalIp string
    (String) TThe external IP address of the network (for pub-VLAN networks).
    Href string
    (String) Link to this PVM instance network.
    Id string
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    IpAddress string
    (String) The IP address of the network interface.
    MacAddress string
    (String) The MAC address of the network interface.
    NetworkId string
    (String) The network ID.
    NetworkInterfaceId string
    (String) ID of the network interface.
    NetworkName string
    (String) The network name.
    NetworkSecurityGroupIds List<string>
    (List) IDs of the network security groups that the network interface is a member of.
    NetworkSecurityGroupsHreves List<string>
    (List) Links to the network security groups that the network interface is a member of.
    PiCloudInstanceId string
    PiInstanceId string
    PiNetworkId string
    Type string
    (String) The address type (for example, fixed or dynamic).
    Version double
    (Float) Version of the network information.
    ExternalIp string
    (String) TThe external IP address of the network (for pub-VLAN networks).
    Href string
    (String) Link to this PVM instance network.
    Id string
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    IpAddress string
    (String) The IP address of the network interface.
    MacAddress string
    (String) The MAC address of the network interface.
    NetworkId string
    (String) The network ID.
    NetworkInterfaceId string
    (String) ID of the network interface.
    NetworkName string
    (String) The network name.
    NetworkSecurityGroupIds []string
    (List) IDs of the network security groups that the network interface is a member of.
    NetworkSecurityGroupsHreves []string
    (List) Links to the network security groups that the network interface is a member of.
    PiCloudInstanceId string
    PiInstanceId string
    PiNetworkId string
    Type string
    (String) The address type (for example, fixed or dynamic).
    Version float64
    (Float) Version of the network information.
    externalIp String
    (String) TThe external IP address of the network (for pub-VLAN networks).
    href String
    (String) Link to this PVM instance network.
    id String
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    ipAddress String
    (String) The IP address of the network interface.
    macAddress String
    (String) The MAC address of the network interface.
    networkId String
    (String) The network ID.
    networkInterfaceId String
    (String) ID of the network interface.
    networkName String
    (String) The network name.
    networkSecurityGroupIds List<String>
    (List) IDs of the network security groups that the network interface is a member of.
    networkSecurityGroupsHreves List<String>
    (List) Links to the network security groups that the network interface is a member of.
    piCloudInstanceId String
    piInstanceId String
    piNetworkId String
    type String
    (String) The address type (for example, fixed or dynamic).
    version Double
    (Float) Version of the network information.
    externalIp string
    (String) TThe external IP address of the network (for pub-VLAN networks).
    href string
    (String) Link to this PVM instance network.
    id string
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    ipAddress string
    (String) The IP address of the network interface.
    macAddress string
    (String) The MAC address of the network interface.
    networkId string
    (String) The network ID.
    networkInterfaceId string
    (String) ID of the network interface.
    networkName string
    (String) The network name.
    networkSecurityGroupIds string[]
    (List) IDs of the network security groups that the network interface is a member of.
    networkSecurityGroupsHreves string[]
    (List) Links to the network security groups that the network interface is a member of.
    piCloudInstanceId string
    piInstanceId string
    piNetworkId string
    type string
    (String) The address type (for example, fixed or dynamic).
    version number
    (Float) Version of the network information.
    external_ip str
    (String) TThe external IP address of the network (for pub-VLAN networks).
    href str
    (String) Link to this PVM instance network.
    id str
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    ip_address str
    (String) The IP address of the network interface.
    mac_address str
    (String) The MAC address of the network interface.
    network_id str
    (String) The network ID.
    network_interface_id str
    (String) ID of the network interface.
    network_name str
    (String) The network name.
    network_security_group_ids Sequence[str]
    (List) IDs of the network security groups that the network interface is a member of.
    network_security_groups_hreves Sequence[str]
    (List) Links to the network security groups that the network interface is a member of.
    pi_cloud_instance_id str
    pi_instance_id str
    pi_network_id str
    type str
    (String) The address type (for example, fixed or dynamic).
    version float
    (Float) Version of the network information.
    externalIp String
    (String) TThe external IP address of the network (for pub-VLAN networks).
    href String
    (String) Link to this PVM instance network.
    id String
    (String) The unique identifier of the data source in the form <pi_cloud_instance_id>/<pi_instance_id>/<pi_network_id>.
    ipAddress String
    (String) The IP address of the network interface.
    macAddress String
    (String) The MAC address of the network interface.
    networkId String
    (String) The network ID.
    networkInterfaceId String
    (String) ID of the network interface.
    networkName String
    (String) The network name.
    networkSecurityGroupIds List<String>
    (List) IDs of the network security groups that the network interface is a member of.
    networkSecurityGroupsHreves List<String>
    (List) Links to the network security groups that the network interface is a member of.
    piCloudInstanceId String
    piInstanceId String
    piNetworkId String
    type String
    (String) The address type (for example, fixed or dynamic).
    version Number
    (Float) Version of the network information.

    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.87.0-beta1 published on Monday, Dec 22, 2025 by ibm-cloud
      Meet Neo: Your AI Platform Teammate