1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiNetworks
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getPiNetworks

Explore with Pulumi AI

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

    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",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    ds_network = ibm.get_pi_networks(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.GetPiNetworks(ctx, &ibm.GetPiNetworksArgs{
    			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 dsNetwork = Ibm.GetPiNetworks.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.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());
    
        }
    }
    
    variables:
      dsNetwork:
        fn::invoke:
          function: ibm:getPiNetworks
          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 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>
    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]
    func GetPiNetworks(ctx *Context, args *GetPiNetworksArgs, opts ...InvokeOption) (*GetPiNetworksResult, error)
    func GetPiNetworksOutput(ctx *Context, args *GetPiNetworksOutputArgs, opts ...InvokeOption) GetPiNetworksResultOutput

    > 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)
    }
    public static CompletableFuture<GetPiNetworksResult> getPiNetworks(GetPiNetworksArgs args, InvokeOptions options)
    public static Output<GetPiNetworksResult> getPiNetworks(GetPiNetworksArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiNetworks:getPiNetworks
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    piCloudInstanceId 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 string
    (Deprecated, String) The network communication configuration option of the network (for on-prem locations only). Use peer_id instead.
    Crn string
    (String) The CRN of this resource.
    DhcpManaged bool
    (Boolean) Indicates if the network DHCP Managed.
    Href string
    (String) The hyper link of a network.
    Mtu double
    (Boolean) Maximum Transmission Unit option of the network.
    Name string
    (String) The name of a network.
    NetworkId string
    (String) The ID of the network.
    PeerId string
    (String) Network peer ID (for on-prem locations only).
    Type string
    (String) The type of network.
    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.
    Crn string
    (String) The CRN of this resource.
    DhcpManaged bool
    (Boolean) Indicates if the network DHCP Managed.
    Href string
    (String) The hyper link of a network.
    Mtu float64
    (Boolean) Maximum Transmission Unit option of the network.
    Name string
    (String) The name of a network.
    NetworkId string
    (String) The ID of the network.
    PeerId string
    (String) Network peer ID (for on-prem locations only).
    Type string
    (String) The type of network.
    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.
    crn String
    (String) The CRN of this resource.
    dhcpManaged Boolean
    (Boolean) Indicates if the network DHCP Managed.
    href String
    (String) The hyper link of a network.
    mtu Double
    (Boolean) Maximum Transmission Unit option of the network.
    name String
    (String) The name of a network.
    networkId String
    (String) The ID of the network.
    peerId String
    (String) Network peer ID (for on-prem locations only).
    type String
    (String) The type of network.
    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.
    crn string
    (String) The CRN of this resource.
    dhcpManaged boolean
    (Boolean) Indicates if the network DHCP Managed.
    href string
    (String) The hyper link of a network.
    mtu number
    (Boolean) Maximum Transmission Unit option of the network.
    name string
    (String) The name of a network.
    networkId string
    (String) The ID of the network.
    peerId string
    (String) Network peer ID (for on-prem locations only).
    type string
    (String) The type of network.
    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.
    crn str
    (String) The CRN of this resource.
    dhcp_managed bool
    (Boolean) Indicates if the network DHCP Managed.
    href str
    (String) The hyper link of a network.
    mtu float
    (Boolean) Maximum Transmission Unit option of the network.
    name str
    (String) The name of a network.
    network_id str
    (String) The ID of the network.
    peer_id str
    (String) Network peer ID (for on-prem locations only).
    type str
    (String) The type of network.
    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.
    crn String
    (String) The CRN of this resource.
    dhcpManaged Boolean
    (Boolean) Indicates if the network DHCP Managed.
    href String
    (String) The hyper link of a network.
    mtu Number
    (Boolean) Maximum Transmission Unit option of the network.
    name String
    (String) The name of a network.
    networkId String
    (String) The ID of the network.
    peerId String
    (String) Network peer ID (for on-prem locations only).
    type String
    (String) The type of network.
    userTags List<String>
    (List) List of user tags attached to the resource.
    vlanId 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 logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud