Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. PiNetwork
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.PiNetwork

Explore with Pulumi AI

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

    Create, update, or delete a network connection for your Power Systems Virtual Server instance. For more information, about power virtual server instance network, see setting up an IBM network install server.

    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) {
    }
}

    {}

    Create PiNetwork Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PiNetwork(name: string, args: PiNetworkArgs, opts?: CustomResourceOptions);
    @overload
def PiNetwork(resource_name: str,
              args: PiNetworkArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def PiNetwork(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              pi_network_name: Optional[str] = None,
              pi_cloud_instance_id: Optional[str] = None,
              pi_network_type: Optional[str] = None,
              pi_gateway: Optional[str] = None,
              pi_ipaddress_ranges: Optional[Sequence[PiNetworkPiIpaddressRangeArgs]] = None,
              pi_network_access_config: Optional[str] = None,
              pi_network_id: Optional[str] = None,
              pi_network_jumbo: Optional[bool] = None,
              pi_network_mtu: Optional[float] = None,
              pi_cidr: Optional[str] = None,
              pi_network_peer: Optional[PiNetworkPiNetworkPeerArgs] = None,
              pi_dns: Optional[Sequence[str]] = None,
              pi_user_tags: Optional[Sequence[str]] = None,
              timeouts: Optional[PiNetworkTimeoutsArgs] = None)
    func NewPiNetwork(ctx *Context, name string, args PiNetworkArgs, opts ...ResourceOption) (*PiNetwork, error)
    public PiNetwork(string name, PiNetworkArgs args, CustomResourceOptions? opts = null)
    public PiNetwork(String name, PiNetworkArgs args)
public PiNetwork(String name, PiNetworkArgs args, CustomResourceOptions options)

    type: ibm:PiNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PiNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PiNetworkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PiNetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PiNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PiNetworkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var piNetworkResource = new Ibm.PiNetwork("piNetworkResource", new()
{
    PiNetworkName = "string",
    PiCloudInstanceId = "string",
    PiNetworkType = "string",
    PiGateway = "string",
    PiIpaddressRanges = new[]
    {
        new Ibm.Inputs.PiNetworkPiIpaddressRangeArgs
        {
            PiEndingIpAddress = "string",
            PiStartingIpAddress = "string",
        },
    },
    PiNetworkId = "string",
    PiNetworkMtu = 0,
    PiCidr = "string",
    PiNetworkPeer = new Ibm.Inputs.PiNetworkPiNetworkPeerArgs
    {
        Id = "string",
        NetworkAddressTranslation = new Ibm.Inputs.PiNetworkPiNetworkPeerNetworkAddressTranslationArgs
        {
            SourceIp = "string",
        },
        Type = "string",
    },
    PiDns = new[]
    {
        "string",
    },
    PiUserTags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.PiNetworkTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewPiNetwork(ctx, "piNetworkResource", &ibm.PiNetworkArgs{
	PiNetworkName:     pulumi.String("string"),
	PiCloudInstanceId: pulumi.String("string"),
	PiNetworkType:     pulumi.String("string"),
	PiGateway:         pulumi.String("string"),
	PiIpaddressRanges: ibm.PiNetworkPiIpaddressRangeArray{
		&ibm.PiNetworkPiIpaddressRangeArgs{
			PiEndingIpAddress:   pulumi.String("string"),
			PiStartingIpAddress: pulumi.String("string"),
		},
	},
	PiNetworkId:  pulumi.String("string"),
	PiNetworkMtu: pulumi.Float64(0),
	PiCidr:       pulumi.String("string"),
	PiNetworkPeer: &ibm.PiNetworkPiNetworkPeerArgs{
		Id: pulumi.String("string"),
		NetworkAddressTranslation: &ibm.PiNetworkPiNetworkPeerNetworkAddressTranslationArgs{
			SourceIp: pulumi.String("string"),
		},
		Type: pulumi.String("string"),
	},
	PiDns: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiUserTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.PiNetworkTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var piNetworkResource = new PiNetwork("piNetworkResource", PiNetworkArgs.builder()
    .piNetworkName("string")
    .piCloudInstanceId("string")
    .piNetworkType("string")
    .piGateway("string")
    .piIpaddressRanges(PiNetworkPiIpaddressRangeArgs.builder()
        .piEndingIpAddress("string")
        .piStartingIpAddress("string")
        .build())
    .piNetworkId("string")
    .piNetworkMtu(0)
    .piCidr("string")
    .piNetworkPeer(PiNetworkPiNetworkPeerArgs.builder()
        .id("string")
        .networkAddressTranslation(PiNetworkPiNetworkPeerNetworkAddressTranslationArgs.builder()
            .sourceIp("string")
            .build())
        .type("string")
        .build())
    .piDns("string")
    .piUserTags("string")
    .timeouts(PiNetworkTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    pi_network_resource = ibm.PiNetwork("piNetworkResource",
    pi_network_name="string",
    pi_cloud_instance_id="string",
    pi_network_type="string",
    pi_gateway="string",
    pi_ipaddress_ranges=[{
        "pi_ending_ip_address": "string",
        "pi_starting_ip_address": "string",
    }],
    pi_network_id="string",
    pi_network_mtu=0,
    pi_cidr="string",
    pi_network_peer={
        "id": "string",
        "network_address_translation": {
            "source_ip": "string",
        },
        "type": "string",
    },
    pi_dns=["string"],
    pi_user_tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const piNetworkResource = new ibm.PiNetwork("piNetworkResource", {
    piNetworkName: "string",
    piCloudInstanceId: "string",
    piNetworkType: "string",
    piGateway: "string",
    piIpaddressRanges: [{
        piEndingIpAddress: "string",
        piStartingIpAddress: "string",
    }],
    piNetworkId: "string",
    piNetworkMtu: 0,
    piCidr: "string",
    piNetworkPeer: {
        id: "string",
        networkAddressTranslation: {
            sourceIp: "string",
        },
        type: "string",
    },
    piDns: ["string"],
    piUserTags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:PiNetwork
properties:
    piCidr: string
    piCloudInstanceId: string
    piDns:
        - string
    piGateway: string
    piIpaddressRanges:
        - piEndingIpAddress: string
          piStartingIpAddress: string
    piNetworkId: string
    piNetworkMtu: 0
    piNetworkName: string
    piNetworkPeer:
        id: string
        networkAddressTranslation:
            sourceIp: string
        type: string
    piNetworkType: string
    piUserTags:
        - string
    timeouts:
        create: string
        delete: string
        update: string

    PiNetwork Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PiNetwork resource accepts the following input properties:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkName string
    The name of the network.
    PiNetworkType string
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    PiCidr string
    The network CIDR. Required for vlan network type.
    PiDns List<string>
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    PiGateway string
    The gateway ip address.
    PiIpaddressRanges List<PiNetworkPiIpaddressRange>
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    PiNetworkAccessConfig string
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    PiNetworkId string
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    PiNetworkJumbo bool
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    PiNetworkMtu double
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    PiNetworkPeer PiNetworkPiNetworkPeer

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    PiUserTags List<string>
    The user tags attached to this resource.
    Timeouts PiNetworkTimeouts
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkName string
    The name of the network.
    PiNetworkType string
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    PiCidr string
    The network CIDR. Required for vlan network type.
    PiDns []string
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    PiGateway string
    The gateway ip address.
    PiIpaddressRanges []PiNetworkPiIpaddressRangeArgs
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    PiNetworkAccessConfig string
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    PiNetworkId string
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    PiNetworkJumbo bool
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    PiNetworkMtu float64
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    PiNetworkPeer PiNetworkPiNetworkPeerArgs

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    PiUserTags []string
    The user tags attached to this resource.
    Timeouts PiNetworkTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkName String
    The name of the network.
    piNetworkType String
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    piCidr String
    The network CIDR. Required for vlan network type.
    piDns List<String>
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    piGateway String
    The gateway ip address.
    piIpaddressRanges List<PiNetworkPiIpaddressRange>
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    piNetworkAccessConfig String
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    piNetworkId String
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    piNetworkJumbo Boolean
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    piNetworkMtu Double
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    piNetworkPeer PiNetworkPiNetworkPeer

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    piUserTags List<String>
    The user tags attached to this resource.
    timeouts PiNetworkTimeouts
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piNetworkName string
    The name of the network.
    piNetworkType string
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    piCidr string
    The network CIDR. Required for vlan network type.
    piDns string[]
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    piGateway string
    The gateway ip address.
    piIpaddressRanges PiNetworkPiIpaddressRange[]
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    piNetworkAccessConfig string
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    piNetworkId string
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    piNetworkJumbo boolean
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    piNetworkMtu number
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    piNetworkPeer PiNetworkPiNetworkPeer

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    piUserTags string[]
    The user tags attached to this resource.
    timeouts PiNetworkTimeouts
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_network_name str
    The name of the network.
    pi_network_type str
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    pi_cidr str
    The network CIDR. Required for vlan network type.
    pi_dns Sequence[str]
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    pi_gateway str
    The gateway ip address.
    pi_ipaddress_ranges Sequence[PiNetworkPiIpaddressRangeArgs]
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    pi_network_access_config str
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    pi_network_id str
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    pi_network_jumbo bool
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    pi_network_mtu float
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    pi_network_peer PiNetworkPiNetworkPeerArgs

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    timeouts PiNetworkTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkName String
    The name of the network.
    piNetworkType String
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    piCidr String
    The network CIDR. Required for vlan network type.
    piDns List<String>
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    piGateway String
    The gateway ip address.
    piIpaddressRanges List<Property Map>
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    piNetworkAccessConfig String
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    piNetworkId String
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    piNetworkJumbo Boolean
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    piNetworkMtu Number
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    piNetworkPeer Property Map

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    piUserTags List<String>
    The user tags attached to this resource.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PiNetwork resource produces the following output properties:

    Crn string
    (String) The CRN of this resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkAddressTranslations List<PiNetworkNetworkAddressTranslation>
    (List) Contains the network address translation details (for on-prem locations only).
    NetworkId string
    (String) The unique identifier of the network.
    PeerId string
    (String) Network peer ID (for on-prem locations only).
    VlanId double
    (Integer) The ID of the VLAN that your network is attached to.
    Crn string
    (String) The CRN of this resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkAddressTranslations []PiNetworkNetworkAddressTranslation
    (List) Contains the network address translation details (for on-prem locations only).
    NetworkId string
    (String) The unique identifier of the network.
    PeerId string
    (String) Network peer ID (for on-prem locations only).
    VlanId float64
    (Integer) The ID of the VLAN that your network is attached to.
    crn String
    (String) The CRN of this resource.
    id String
    The provider-assigned unique ID for this managed resource.
    networkAddressTranslations List<PiNetworkNetworkAddressTranslation>
    (List) Contains the network address translation details (for on-prem locations only).
    networkId String
    (String) The unique identifier of the network.
    peerId String
    (String) Network peer ID (for on-prem locations only).
    vlanId Double
    (Integer) The ID of the VLAN that your network is attached to.
    crn string
    (String) The CRN of this resource.
    id string
    The provider-assigned unique ID for this managed resource.
    networkAddressTranslations PiNetworkNetworkAddressTranslation[]
    (List) Contains the network address translation details (for on-prem locations only).
    networkId string
    (String) The unique identifier of the network.
    peerId string
    (String) Network peer ID (for on-prem locations only).
    vlanId number
    (Integer) The ID of the VLAN that your network is attached to.
    crn str
    (String) The CRN of this resource.
    id str
    The provider-assigned unique ID for this managed resource.
    network_address_translations Sequence[PiNetworkNetworkAddressTranslation]
    (List) Contains the network address translation details (for on-prem locations only).
    network_id str
    (String) The unique identifier of the network.
    peer_id str
    (String) Network peer ID (for on-prem locations only).
    vlan_id float
    (Integer) The ID of the VLAN that your network is attached to.
    crn String
    (String) The CRN of this resource.
    id String
    The provider-assigned unique ID for this managed resource.
    networkAddressTranslations List<Property Map>
    (List) Contains the network address translation details (for on-prem locations only).
    networkId String
    (String) The unique identifier of the network.
    peerId String
    (String) Network peer ID (for on-prem locations only).
    vlanId Number
    (Integer) The ID of the VLAN that your network is attached to.

    Look up Existing PiNetwork Resource

    Get an existing PiNetwork resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PiNetworkState, opts?: CustomResourceOptions): PiNetwork
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        crn: Optional[str] = None,
        network_address_translations: Optional[Sequence[PiNetworkNetworkAddressTranslationArgs]] = None,
        network_id: Optional[str] = None,
        peer_id: Optional[str] = None,
        pi_cidr: Optional[str] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_dns: Optional[Sequence[str]] = None,
        pi_gateway: Optional[str] = None,
        pi_ipaddress_ranges: Optional[Sequence[PiNetworkPiIpaddressRangeArgs]] = None,
        pi_network_access_config: Optional[str] = None,
        pi_network_id: Optional[str] = None,
        pi_network_jumbo: Optional[bool] = None,
        pi_network_mtu: Optional[float] = None,
        pi_network_name: Optional[str] = None,
        pi_network_peer: Optional[PiNetworkPiNetworkPeerArgs] = None,
        pi_network_type: Optional[str] = None,
        pi_user_tags: Optional[Sequence[str]] = None,
        timeouts: Optional[PiNetworkTimeoutsArgs] = None,
        vlan_id: Optional[float] = None) -> PiNetwork
    func GetPiNetwork(ctx *Context, name string, id IDInput, state *PiNetworkState, opts ...ResourceOption) (*PiNetwork, error)
    public static PiNetwork Get(string name, Input<string> id, PiNetworkState? state, CustomResourceOptions? opts = null)
    public static PiNetwork get(String name, Output<String> id, PiNetworkState state, CustomResourceOptions options)
    resources:  _:    type: ibm:PiNetwork    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Crn string
    (String) The CRN of this resource.
    NetworkAddressTranslations List<PiNetworkNetworkAddressTranslation>
    (List) Contains the network address translation details (for on-prem locations only).
    NetworkId string
    (String) The unique identifier of the network.
    PeerId string
    (String) Network peer ID (for on-prem locations only).
    PiCidr string
    The network CIDR. Required for vlan network type.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiDns List<string>
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    PiGateway string
    The gateway ip address.
    PiIpaddressRanges List<PiNetworkPiIpaddressRange>
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    PiNetworkAccessConfig string
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    PiNetworkId string
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    PiNetworkJumbo bool
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    PiNetworkMtu double
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    PiNetworkName string
    The name of the network.
    PiNetworkPeer PiNetworkPiNetworkPeer

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    PiNetworkType string
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    PiUserTags List<string>
    The user tags attached to this resource.
    Timeouts PiNetworkTimeouts
    VlanId double
    (Integer) The ID of the VLAN that your network is attached to.
    Crn string
    (String) The CRN of this resource.
    NetworkAddressTranslations []PiNetworkNetworkAddressTranslationArgs
    (List) Contains the network address translation details (for on-prem locations only).
    NetworkId string
    (String) The unique identifier of the network.
    PeerId string
    (String) Network peer ID (for on-prem locations only).
    PiCidr string
    The network CIDR. Required for vlan network type.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiDns []string
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    PiGateway string
    The gateway ip address.
    PiIpaddressRanges []PiNetworkPiIpaddressRangeArgs
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    PiNetworkAccessConfig string
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    PiNetworkId string
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    PiNetworkJumbo bool
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    PiNetworkMtu float64
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    PiNetworkName string
    The name of the network.
    PiNetworkPeer PiNetworkPiNetworkPeerArgs

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    PiNetworkType string
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    PiUserTags []string
    The user tags attached to this resource.
    Timeouts PiNetworkTimeoutsArgs
    VlanId float64
    (Integer) The ID of the VLAN that your network is attached to.
    crn String
    (String) The CRN of this resource.
    networkAddressTranslations List<PiNetworkNetworkAddressTranslation>
    (List) Contains the network address translation details (for on-prem locations only).
    networkId String
    (String) The unique identifier of the network.
    peerId String
    (String) Network peer ID (for on-prem locations only).
    piCidr String
    The network CIDR. Required for vlan network type.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piDns List<String>
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    piGateway String
    The gateway ip address.
    piIpaddressRanges List<PiNetworkPiIpaddressRange>
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    piNetworkAccessConfig String
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    piNetworkId String
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    piNetworkJumbo Boolean
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    piNetworkMtu Double
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    piNetworkName String
    The name of the network.
    piNetworkPeer PiNetworkPiNetworkPeer

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    piNetworkType String
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    piUserTags List<String>
    The user tags attached to this resource.
    timeouts PiNetworkTimeouts
    vlanId Double
    (Integer) The ID of the VLAN that your network is attached to.
    crn string
    (String) The CRN of this resource.
    networkAddressTranslations PiNetworkNetworkAddressTranslation[]
    (List) Contains the network address translation details (for on-prem locations only).
    networkId string
    (String) The unique identifier of the network.
    peerId string
    (String) Network peer ID (for on-prem locations only).
    piCidr string
    The network CIDR. Required for vlan network type.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piDns string[]
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    piGateway string
    The gateway ip address.
    piIpaddressRanges PiNetworkPiIpaddressRange[]
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    piNetworkAccessConfig string
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    piNetworkId string
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    piNetworkJumbo boolean
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    piNetworkMtu number
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    piNetworkName string
    The name of the network.
    piNetworkPeer PiNetworkPiNetworkPeer

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    piNetworkType string
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    piUserTags string[]
    The user tags attached to this resource.
    timeouts PiNetworkTimeouts
    vlanId number
    (Integer) The ID of the VLAN that your network is attached to.
    crn str
    (String) The CRN of this resource.
    network_address_translations Sequence[PiNetworkNetworkAddressTranslationArgs]
    (List) Contains the network address translation details (for on-prem locations only).
    network_id str
    (String) The unique identifier of the network.
    peer_id str
    (String) Network peer ID (for on-prem locations only).
    pi_cidr str
    The network CIDR. Required for vlan network type.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_dns Sequence[str]
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    pi_gateway str
    The gateway ip address.
    pi_ipaddress_ranges Sequence[PiNetworkPiIpaddressRangeArgs]
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    pi_network_access_config str
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    pi_network_id str
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    pi_network_jumbo bool
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    pi_network_mtu float
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    pi_network_name str
    The name of the network.
    pi_network_peer PiNetworkPiNetworkPeerArgs

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    pi_network_type str
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    timeouts PiNetworkTimeoutsArgs
    vlan_id float
    (Integer) The ID of the VLAN that your network is attached to.
    crn String
    (String) The CRN of this resource.
    networkAddressTranslations List<Property Map>
    (List) Contains the network address translation details (for on-prem locations only).
    networkId String
    (String) The unique identifier of the network.
    peerId String
    (String) Network peer ID (for on-prem locations only).
    piCidr String
    The network CIDR. Required for vlan network type.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piDns List<String>
    The DNS Servers for the network. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network). A maximum of one DNS server can be specified for private networks in Power Edge Router workspaces.
    piGateway String
    The gateway ip address.
    piIpaddressRanges List<Property Map>
    List of one or more ip address range(s). The pi_ipaddress_range object structure is documented below. The pi_ipaddress_range block supports:
    piNetworkAccessConfig String
    The network communication configuration option of the network (for on-prem locations only). Please use pi_network_peer.

    Deprecated: Deprecated

    piNetworkId String
    (String) The unique identifier of the network. The ID is composed of <pi_cloud_instance_id>/<network_id>.
    piNetworkJumbo Boolean
    MTU Jumbo option of the network (for multi-zone locations only).

    Deprecated: Deprecated

    piNetworkMtu Number
    Maximum Transmission Unit option of the network. Minimum is 1450 and maximum is 9000.
    piNetworkName String
    The name of the network.
    piNetworkPeer Property Map

    Network peer information (for on-prem locations only). Max items: 1.

    Nested schema for pi_network_peer:

    piNetworkType String
    The type of network that you want to create. Valid values are pub-vlan, vlan and dhcp-vlan.
    piUserTags List<String>
    The user tags attached to this resource.
    timeouts Property Map
    vlanId Number
    (Integer) The ID of the VLAN that your network is attached to.

    Supporting Types

    PiNetworkNetworkAddressTranslation, PiNetworkNetworkAddressTranslationArgs

    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.

    PiNetworkPiIpaddressRange, PiNetworkPiIpaddressRangeArgs

    PiEndingIpAddress string
    The ending ip address.
    PiStartingIpAddress string
    The staring ip address. Note if the pi_gateway or pi_ipaddress_range is not provided, it will calculate the value based on CIDR respectively.
    PiEndingIpAddress string
    The ending ip address.
    PiStartingIpAddress string
    The staring ip address. Note if the pi_gateway or pi_ipaddress_range is not provided, it will calculate the value based on CIDR respectively.
    piEndingIpAddress String
    The ending ip address.
    piStartingIpAddress String
    The staring ip address. Note if the pi_gateway or pi_ipaddress_range is not provided, it will calculate the value based on CIDR respectively.
    piEndingIpAddress string
    The ending ip address.
    piStartingIpAddress string
    The staring ip address. Note if the pi_gateway or pi_ipaddress_range is not provided, it will calculate the value based on CIDR respectively.
    pi_ending_ip_address str
    The ending ip address.
    pi_starting_ip_address str
    The staring ip address. Note if the pi_gateway or pi_ipaddress_range is not provided, it will calculate the value based on CIDR respectively.
    piEndingIpAddress String
    The ending ip address.
    piStartingIpAddress String
    The staring ip address. Note if the pi_gateway or pi_ipaddress_range is not provided, it will calculate the value based on CIDR respectively.

    PiNetworkPiNetworkPeer, PiNetworkPiNetworkPeerArgs

    Id string
    ID of the network peer.
    NetworkAddressTranslation PiNetworkPiNetworkPeerNetworkAddressTranslation

    Contains the Network Address Translation Details. Max items: 1.

    Nested schema for network_address_translation:

    Type string
    Type of the network peer. Allowable values are: L2, L3BGP, L3Static.
    Id string
    ID of the network peer.
    NetworkAddressTranslation PiNetworkPiNetworkPeerNetworkAddressTranslation

    Contains the Network Address Translation Details. Max items: 1.

    Nested schema for network_address_translation:

    Type string
    Type of the network peer. Allowable values are: L2, L3BGP, L3Static.
    id String
    ID of the network peer.
    networkAddressTranslation PiNetworkPiNetworkPeerNetworkAddressTranslation

    Contains the Network Address Translation Details. Max items: 1.

    Nested schema for network_address_translation:

    type String
    Type of the network peer. Allowable values are: L2, L3BGP, L3Static.
    id string
    ID of the network peer.
    networkAddressTranslation PiNetworkPiNetworkPeerNetworkAddressTranslation

    Contains the Network Address Translation Details. Max items: 1.

    Nested schema for network_address_translation:

    type string
    Type of the network peer. Allowable values are: L2, L3BGP, L3Static.
    id str
    ID of the network peer.
    network_address_translation PiNetworkPiNetworkPeerNetworkAddressTranslation

    Contains the Network Address Translation Details. Max items: 1.

    Nested schema for network_address_translation:

    type str
    Type of the network peer. Allowable values are: L2, L3BGP, L3Static.
    id String
    ID of the network peer.
    networkAddressTranslation Property Map

    Contains the Network Address Translation Details. Max items: 1.

    Nested schema for network_address_translation:

    type String
    Type of the network peer. Allowable values are: L2, L3BGP, L3Static.

    PiNetworkPiNetworkPeerNetworkAddressTranslation, PiNetworkPiNetworkPeerNetworkAddressTranslationArgs

    SourceIp string
    source IP address, required if network peer type is L3BGP or L3STATIC and if NAT is enabled.
    SourceIp string
    source IP address, required if network peer type is L3BGP or L3STATIC and if NAT is enabled.
    sourceIp String
    source IP address, required if network peer type is L3BGP or L3STATIC and if NAT is enabled.
    sourceIp string
    source IP address, required if network peer type is L3BGP or L3STATIC and if NAT is enabled.
    source_ip str
    source IP address, required if network peer type is L3BGP or L3STATIC and if NAT is enabled.
    sourceIp String
    source IP address, required if network peer type is L3BGP or L3STATIC and if NAT is enabled.

    PiNetworkTimeouts, PiNetworkTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    Example

    bash

    $ pulumi import ibm:index/piNetwork:PiNetwork example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770bbf3ebb

    To learn more about importing existing cloud resources, see Importing resources.

    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
    ibm-cloud/terraform-provider-ibm