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

ibm.PiNetworkInterface

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, and delete a network interface.

    Example Usage

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

const networkInterface = new ibm.PiNetworkInterface("networkInterface", {
    piCloudInstanceId: "<value of the cloud_instance_id>",
    piName: "network-interface-name",
    piNetworkId: "network_id",
});

    import pulumi
import pulumi_ibm as ibm

network_interface = ibm.PiNetworkInterface("networkInterface",
    pi_cloud_instance_id="<value of the cloud_instance_id>",
    pi_name="network-interface-name",
    pi_network_id="network_id")

    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.NewPiNetworkInterface(ctx, "networkInterface", &ibm.PiNetworkInterfaceArgs{
			PiCloudInstanceId: pulumi.String("<value of the cloud_instance_id>"),
			PiName:            pulumi.String("network-interface-name"),
			PiNetworkId:       pulumi.String("network_id"),
		})
		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 networkInterface = new Ibm.PiNetworkInterface("networkInterface", new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
        PiName = "network-interface-name",
        PiNetworkId = "network_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiNetworkInterface;
import com.pulumi.ibm.PiNetworkInterfaceArgs;
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) {
        var networkInterface = new PiNetworkInterface("networkInterface", PiNetworkInterfaceArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .piName("network-interface-name")
            .piNetworkId("network_id")
            .build());

    }
}

    resources:
  networkInterface:
    type: ibm:PiNetworkInterface
    properties:
      piCloudInstanceId: <value of the cloud_instance_id>
      piName: network-interface-name
      piNetworkId: network_id

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

    {}

    Example

    terraform import ibm_pi_network_interface.example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770bbf3ebb/041b186b-9598-4cb9-bf70-966d7b9d1dc8

    Create PiNetworkInterface Resource

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

    Constructor syntax

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

@overload
def PiNetworkInterface(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       pi_cloud_instance_id: Optional[str] = None,
                       pi_network_id: Optional[str] = None,
                       instances: Optional[Sequence[PiNetworkInterfaceInstanceArgs]] = None,
                       pi_instance_id: Optional[str] = None,
                       pi_ip_address: Optional[str] = None,
                       pi_name: Optional[str] = None,
                       pi_network_interface_id: Optional[str] = None,
                       pi_user_tags: Optional[Sequence[str]] = None,
                       timeouts: Optional[PiNetworkInterfaceTimeoutsArgs] = None)
    func NewPiNetworkInterface(ctx *Context, name string, args PiNetworkInterfaceArgs, opts ...ResourceOption) (*PiNetworkInterface, error)
    public PiNetworkInterface(string name, PiNetworkInterfaceArgs args, CustomResourceOptions? opts = null)
    public PiNetworkInterface(String name, PiNetworkInterfaceArgs args)
public PiNetworkInterface(String name, PiNetworkInterfaceArgs args, CustomResourceOptions options)

    type: ibm:PiNetworkInterface
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 PiNetworkInterfaceArgs
    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 PiNetworkInterfaceArgs
    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 PiNetworkInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PiNetworkInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PiNetworkInterfaceArgs
    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 piNetworkInterfaceResource = new Ibm.PiNetworkInterface("piNetworkInterfaceResource", new()
{
    PiCloudInstanceId = "string",
    PiNetworkId = "string",
    Instances = new[]
    {
        new Ibm.Inputs.PiNetworkInterfaceInstanceArgs
        {
            Href = "string",
            InstanceId = "string",
        },
    },
    PiInstanceId = "string",
    PiIpAddress = "string",
    PiName = "string",
    PiNetworkInterfaceId = "string",
    PiUserTags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.PiNetworkInterfaceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewPiNetworkInterface(ctx, "piNetworkInterfaceResource", &ibm.PiNetworkInterfaceArgs{
	PiCloudInstanceId: pulumi.String("string"),
	PiNetworkId:       pulumi.String("string"),
	Instances: ibm.PiNetworkInterfaceInstanceArray{
		&ibm.PiNetworkInterfaceInstanceArgs{
			Href:       pulumi.String("string"),
			InstanceId: pulumi.String("string"),
		},
	},
	PiInstanceId:         pulumi.String("string"),
	PiIpAddress:          pulumi.String("string"),
	PiName:               pulumi.String("string"),
	PiNetworkInterfaceId: pulumi.String("string"),
	PiUserTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.PiNetworkInterfaceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var piNetworkInterfaceResource = new PiNetworkInterface("piNetworkInterfaceResource", PiNetworkInterfaceArgs.builder()
    .piCloudInstanceId("string")
    .piNetworkId("string")
    .instances(PiNetworkInterfaceInstanceArgs.builder()
        .href("string")
        .instanceId("string")
        .build())
    .piInstanceId("string")
    .piIpAddress("string")
    .piName("string")
    .piNetworkInterfaceId("string")
    .piUserTags("string")
    .timeouts(PiNetworkInterfaceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    pi_network_interface_resource = ibm.PiNetworkInterface("piNetworkInterfaceResource",
    pi_cloud_instance_id="string",
    pi_network_id="string",
    instances=[{
        "href": "string",
        "instance_id": "string",
    }],
    pi_instance_id="string",
    pi_ip_address="string",
    pi_name="string",
    pi_network_interface_id="string",
    pi_user_tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const piNetworkInterfaceResource = new ibm.PiNetworkInterface("piNetworkInterfaceResource", {
    piCloudInstanceId: "string",
    piNetworkId: "string",
    instances: [{
        href: "string",
        instanceId: "string",
    }],
    piInstanceId: "string",
    piIpAddress: "string",
    piName: "string",
    piNetworkInterfaceId: "string",
    piUserTags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:PiNetworkInterface
properties:
    instances:
        - href: string
          instanceId: string
    piCloudInstanceId: string
    piInstanceId: string
    piIpAddress: string
    piName: string
    piNetworkId: string
    piNetworkInterfaceId: string
    piUserTags:
        - string
    timeouts:
        create: string
        delete: string
        update: string

    PiNetworkInterface 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 PiNetworkInterface resource accepts the following input properties:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkId string
    network id.
    Instances List<PiNetworkInterfaceInstance>
    (List) The attached instance to this network interface.
    PiInstanceId string
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    PiIpAddress string
    The requested IP address of this network interface.
    PiName string
    Name of the network interface.
    PiNetworkInterfaceId string
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    PiUserTags List<string>
    The user tags attached to this resource.
    Timeouts PiNetworkInterfaceTimeouts
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiNetworkId string
    network id.
    Instances []PiNetworkInterfaceInstanceArgs
    (List) The attached instance to this network interface.
    PiInstanceId string
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    PiIpAddress string
    The requested IP address of this network interface.
    PiName string
    Name of the network interface.
    PiNetworkInterfaceId string
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    PiUserTags []string
    The user tags attached to this resource.
    Timeouts PiNetworkInterfaceTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkId String
    network id.
    instances List<PiNetworkInterfaceInstance>
    (List) The attached instance to this network interface.
    piInstanceId String
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    piIpAddress String
    The requested IP address of this network interface.
    piName String
    Name of the network interface.
    piNetworkInterfaceId String
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    piUserTags List<String>
    The user tags attached to this resource.
    timeouts PiNetworkInterfaceTimeouts
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piNetworkId string
    network id.
    instances PiNetworkInterfaceInstance[]
    (List) The attached instance to this network interface.
    piInstanceId string
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    piIpAddress string
    The requested IP address of this network interface.
    piName string
    Name of the network interface.
    piNetworkInterfaceId string
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    piUserTags string[]
    The user tags attached to this resource.
    timeouts PiNetworkInterfaceTimeouts
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_network_id str
    network id.
    instances Sequence[PiNetworkInterfaceInstanceArgs]
    (List) The attached instance to this network interface.
    pi_instance_id str
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    pi_ip_address str
    The requested IP address of this network interface.
    pi_name str
    Name of the network interface.
    pi_network_interface_id str
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    timeouts PiNetworkInterfaceTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piNetworkId String
    network id.
    instances List<Property Map>
    (List) The attached instance to this network interface.
    piInstanceId String
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    piIpAddress String
    The requested IP address of this network interface.
    piName String
    Name of the network interface.
    piNetworkInterfaceId String
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    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 PiNetworkInterface resource produces the following output properties:

    Crn string
    (String) The network interface's crn.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    (String) The ip address of this network interface.
    MacAddress string
    (String) The mac address of the network interface.
    Name string
    (String) Name of the network interface (not unique or indexable).
    NetworkInterfaceId string
    (String) The unique identifier of the network interface.
    NetworkSecurityGroupId string
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    NetworkSecurityGroupIds List<string>
    (List) List of network security groups that the network interface is a member of.
    Status string
    (String) The status of the network interface.
    Crn string
    (String) The network interface's crn.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    (String) The ip address of this network interface.
    MacAddress string
    (String) The mac address of the network interface.
    Name string
    (String) Name of the network interface (not unique or indexable).
    NetworkInterfaceId string
    (String) The unique identifier of the network interface.
    NetworkSecurityGroupId string
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    NetworkSecurityGroupIds []string
    (List) List of network security groups that the network interface is a member of.
    Status string
    (String) The status of the network interface.
    crn String
    (String) The network interface's crn.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    (String) The ip address of this network interface.
    macAddress String
    (String) The mac address of the network interface.
    name String
    (String) Name of the network interface (not unique or indexable).
    networkInterfaceId String
    (String) The unique identifier of the network interface.
    networkSecurityGroupId String
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    networkSecurityGroupIds List<String>
    (List) List of network security groups that the network interface is a member of.
    status String
    (String) The status of the network interface.
    crn string
    (String) The network interface's crn.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    (String) The ip address of this network interface.
    macAddress string
    (String) The mac address of the network interface.
    name string
    (String) Name of the network interface (not unique or indexable).
    networkInterfaceId string
    (String) The unique identifier of the network interface.
    networkSecurityGroupId string
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    networkSecurityGroupIds string[]
    (List) List of network security groups that the network interface is a member of.
    status string
    (String) The status of the network interface.
    crn str
    (String) The network interface's crn.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    (String) The ip address of this network interface.
    mac_address str
    (String) The mac address of the network interface.
    name str
    (String) Name of the network interface (not unique or indexable).
    network_interface_id str
    (String) The unique identifier of the network interface.
    network_security_group_id str
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    network_security_group_ids Sequence[str]
    (List) List of network security groups that the network interface is a member of.
    status str
    (String) The status of the network interface.
    crn String
    (String) The network interface's crn.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    (String) The ip address of this network interface.
    macAddress String
    (String) The mac address of the network interface.
    name String
    (String) Name of the network interface (not unique or indexable).
    networkInterfaceId String
    (String) The unique identifier of the network interface.
    networkSecurityGroupId String
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    networkSecurityGroupIds List<String>
    (List) List of network security groups that the network interface is a member of.
    status String
    (String) The status of the network interface.

    Look up Existing PiNetworkInterface Resource

    Get an existing PiNetworkInterface 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?: PiNetworkInterfaceState, opts?: CustomResourceOptions): PiNetworkInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        crn: Optional[str] = None,
        instances: Optional[Sequence[PiNetworkInterfaceInstanceArgs]] = None,
        ip_address: Optional[str] = None,
        mac_address: Optional[str] = None,
        name: Optional[str] = None,
        network_interface_id: Optional[str] = None,
        network_security_group_id: Optional[str] = None,
        network_security_group_ids: Optional[Sequence[str]] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_instance_id: Optional[str] = None,
        pi_ip_address: Optional[str] = None,
        pi_name: Optional[str] = None,
        pi_network_id: Optional[str] = None,
        pi_network_interface_id: Optional[str] = None,
        pi_user_tags: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        timeouts: Optional[PiNetworkInterfaceTimeoutsArgs] = None) -> PiNetworkInterface
    func GetPiNetworkInterface(ctx *Context, name string, id IDInput, state *PiNetworkInterfaceState, opts ...ResourceOption) (*PiNetworkInterface, error)
    public static PiNetworkInterface Get(string name, Input<string> id, PiNetworkInterfaceState? state, CustomResourceOptions? opts = null)
    public static PiNetworkInterface get(String name, Output<String> id, PiNetworkInterfaceState state, CustomResourceOptions options)
    resources:  _:    type: ibm:PiNetworkInterface    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 network interface's crn.
    Instances List<PiNetworkInterfaceInstance>
    (List) The attached instance to this network interface.
    IpAddress string
    (String) The ip address of this network interface.
    MacAddress string
    (String) The mac address of the network interface.
    Name string
    (String) Name of the network interface (not unique or indexable).
    NetworkInterfaceId string
    (String) The unique identifier of the network interface.
    NetworkSecurityGroupId string
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    NetworkSecurityGroupIds List<string>
    (List) List of network security groups that the network interface is a member of.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceId string
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    PiIpAddress string
    The requested IP address of this network interface.
    PiName string
    Name of the network interface.
    PiNetworkId string
    network id.
    PiNetworkInterfaceId string
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    PiUserTags List<string>
    The user tags attached to this resource.
    Status string
    (String) The status of the network interface.
    Timeouts PiNetworkInterfaceTimeouts
    Crn string
    (String) The network interface's crn.
    Instances []PiNetworkInterfaceInstanceArgs
    (List) The attached instance to this network interface.
    IpAddress string
    (String) The ip address of this network interface.
    MacAddress string
    (String) The mac address of the network interface.
    Name string
    (String) Name of the network interface (not unique or indexable).
    NetworkInterfaceId string
    (String) The unique identifier of the network interface.
    NetworkSecurityGroupId string
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    NetworkSecurityGroupIds []string
    (List) List of network security groups that the network interface is a member of.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceId string
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    PiIpAddress string
    The requested IP address of this network interface.
    PiName string
    Name of the network interface.
    PiNetworkId string
    network id.
    PiNetworkInterfaceId string
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    PiUserTags []string
    The user tags attached to this resource.
    Status string
    (String) The status of the network interface.
    Timeouts PiNetworkInterfaceTimeoutsArgs
    crn String
    (String) The network interface's crn.
    instances List<PiNetworkInterfaceInstance>
    (List) The attached instance to this network interface.
    ipAddress String
    (String) The ip address of this network interface.
    macAddress String
    (String) The mac address of the network interface.
    name String
    (String) Name of the network interface (not unique or indexable).
    networkInterfaceId String
    (String) The unique identifier of the network interface.
    networkSecurityGroupId String
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    networkSecurityGroupIds List<String>
    (List) List of network security groups that the network interface is a member of.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceId String
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    piIpAddress String
    The requested IP address of this network interface.
    piName String
    Name of the network interface.
    piNetworkId String
    network id.
    piNetworkInterfaceId String
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    piUserTags List<String>
    The user tags attached to this resource.
    status String
    (String) The status of the network interface.
    timeouts PiNetworkInterfaceTimeouts
    crn string
    (String) The network interface's crn.
    instances PiNetworkInterfaceInstance[]
    (List) The attached instance to this network interface.
    ipAddress string
    (String) The ip address of this network interface.
    macAddress string
    (String) The mac address of the network interface.
    name string
    (String) Name of the network interface (not unique or indexable).
    networkInterfaceId string
    (String) The unique identifier of the network interface.
    networkSecurityGroupId string
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    networkSecurityGroupIds string[]
    (List) List of network security groups that the network interface is a member of.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piInstanceId string
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    piIpAddress string
    The requested IP address of this network interface.
    piName string
    Name of the network interface.
    piNetworkId string
    network id.
    piNetworkInterfaceId string
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    piUserTags string[]
    The user tags attached to this resource.
    status string
    (String) The status of the network interface.
    timeouts PiNetworkInterfaceTimeouts
    crn str
    (String) The network interface's crn.
    instances Sequence[PiNetworkInterfaceInstanceArgs]
    (List) The attached instance to this network interface.
    ip_address str
    (String) The ip address of this network interface.
    mac_address str
    (String) The mac address of the network interface.
    name str
    (String) Name of the network interface (not unique or indexable).
    network_interface_id str
    (String) The unique identifier of the network interface.
    network_security_group_id str
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    network_security_group_ids Sequence[str]
    (List) List of network security groups that the network interface is a member of.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_instance_id str
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    pi_ip_address str
    The requested IP address of this network interface.
    pi_name str
    Name of the network interface.
    pi_network_id str
    network id.
    pi_network_interface_id str
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    status str
    (String) The status of the network interface.
    timeouts PiNetworkInterfaceTimeoutsArgs
    crn String
    (String) The network interface's crn.
    instances List<Property Map>
    (List) The attached instance to this network interface.
    ipAddress String
    (String) The ip address of this network interface.
    macAddress String
    (String) The mac address of the network interface.
    name String
    (String) Name of the network interface (not unique or indexable).
    networkInterfaceId String
    (String) The unique identifier of the network interface.
    networkSecurityGroupId String
    (Deprecated, String) ID of the network security group the network interface will be added to. Please use network_security_group_ids instead.

    Deprecated: Deprecated

    networkSecurityGroupIds List<String>
    (List) List of network security groups that the network interface is a member of.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceId String
    If supplied populated it attaches to the instance ID, if empty detaches from the instance ID.
    piIpAddress String
    The requested IP address of this network interface.
    piName String
    Name of the network interface.
    piNetworkId String
    network id.
    piNetworkInterfaceId String
    (String) The unique identifier of the network interface resource. The ID is composed of <cloud_instance_id>/<network_id>/<network_interface_id>.
    piUserTags List<String>
    The user tags attached to this resource.
    status String
    (String) The status of the network interface.
    timeouts Property Map

    Supporting Types

    PiNetworkInterfaceInstance, PiNetworkInterfaceInstanceArgs

    Href string
    (String) Link to instance resource.
    InstanceId string
    (String) The attached instance id.
    Href string
    (String) Link to instance resource.
    InstanceId string
    (String) The attached instance id.
    href String
    (String) Link to instance resource.
    instanceId String
    (String) The attached instance id.
    href string
    (String) Link to instance resource.
    instanceId string
    (String) The attached instance id.
    href str
    (String) Link to instance resource.
    instance_id str
    (String) The attached instance id.
    href String
    (String) Link to instance resource.
    instanceId String
    (String) The attached instance id.

    PiNetworkInterfaceTimeouts, PiNetworkInterfaceTimeoutsArgs

    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

    The ibm_pi_network_interface resource can be imported by using cloud_instance_id, network_id and network_interface_id.

    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