Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Core.getPrivateIps

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

// Filter on Subnet OCID
const testPrivateIpsBySubnet = oci.Core.getPrivateIps({
    subnetId: privateIpSubnetId,
});

import pulumi
import pulumi_oci as oci

# Filter on Subnet OCID
test_private_ips_by_subnet = oci.Core.get_private_ips(subnet_id=private_ip_subnet_id)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Filter on Subnet OCID
		_, err := core.GetPrivateIps(ctx, &core.GetPrivateIpsArgs{
			SubnetId: pulumi.StringRef(privateIpSubnetId),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    // Filter on Subnet OCID
    var testPrivateIpsBySubnet = Oci.Core.GetPrivateIps.Invoke(new()
    {
        SubnetId = privateIpSubnetId,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetPrivateIpsArgs;
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) {
        // Filter on Subnet OCID
        final var testPrivateIpsBySubnet = CoreFunctions.getPrivateIps(GetPrivateIpsArgs.builder()
            .subnetId(privateIpSubnetId)
            .build());

    }
}

variables:
  # Filter on Subnet OCID
  testPrivateIpsBySubnet:
    fn::invoke:
      function: oci:Core:getPrivateIps
      arguments:
        subnetId: ${privateIpSubnetId}

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

// Filter on VNIC OCID
const testPrivateIpsByVnic = oci.Core.getPrivateIps({
    vnicId: testVnic.id,
});

import pulumi
import pulumi_oci as oci

# Filter on VNIC OCID
test_private_ips_by_vnic = oci.Core.get_private_ips(vnic_id=test_vnic["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Filter on VNIC OCID
		_, err := core.GetPrivateIps(ctx, &core.GetPrivateIpsArgs{
			VnicId: pulumi.StringRef(testVnic.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    // Filter on VNIC OCID
    var testPrivateIpsByVnic = Oci.Core.GetPrivateIps.Invoke(new()
    {
        VnicId = testVnic.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetPrivateIpsArgs;
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) {
        // Filter on VNIC OCID
        final var testPrivateIpsByVnic = CoreFunctions.getPrivateIps(GetPrivateIpsArgs.builder()
            .vnicId(testVnic.id())
            .build());

    }
}

variables:
  # Filter on VNIC OCID
  testPrivateIpsByVnic:
    fn::invoke:
      function: oci:Core:getPrivateIps
      arguments:
        vnicId: ${testVnic.id}

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

// Filter on private IP address and Subnet OCID
const testPrivateIpsByIpAddress = oci.Core.getPrivateIps({
    ipAddress: privateIpIpAddress,
    ipState: privateIpIpState,
    lifetime: privateIpLifetime,
    subnetId: testSubnet.id,
    vlanId: testVlan.id,
    vnicId: testVnicAttachment.id,
});

import pulumi
import pulumi_oci as oci

# Filter on private IP address and Subnet OCID
test_private_ips_by_ip_address = oci.Core.get_private_ips(ip_address=private_ip_ip_address,
    ip_state=private_ip_ip_state,
    lifetime=private_ip_lifetime,
    subnet_id=test_subnet["id"],
    vlan_id=test_vlan["id"],
    vnic_id=test_vnic_attachment["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Filter on private IP address and Subnet OCID
		_, err := core.GetPrivateIps(ctx, &core.GetPrivateIpsArgs{
			IpAddress: pulumi.StringRef(privateIpIpAddress),
			IpState:   pulumi.StringRef(privateIpIpState),
			Lifetime:  pulumi.StringRef(privateIpLifetime),
			SubnetId:  pulumi.StringRef(testSubnet.Id),
			VlanId:    pulumi.StringRef(testVlan.Id),
			VnicId:    pulumi.StringRef(testVnicAttachment.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    // Filter on private IP address and Subnet OCID
    var testPrivateIpsByIpAddress = Oci.Core.GetPrivateIps.Invoke(new()
    {
        IpAddress = privateIpIpAddress,
        IpState = privateIpIpState,
        Lifetime = privateIpLifetime,
        SubnetId = testSubnet.Id,
        VlanId = testVlan.Id,
        VnicId = testVnicAttachment.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetPrivateIpsArgs;
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) {
        // Filter on private IP address and Subnet OCID
        final var testPrivateIpsByIpAddress = CoreFunctions.getPrivateIps(GetPrivateIpsArgs.builder()
            .ipAddress(privateIpIpAddress)
            .ipState(privateIpIpState)
            .lifetime(privateIpLifetime)
            .subnetId(testSubnet.id())
            .vlanId(testVlan.id())
            .vnicId(testVnicAttachment.id())
            .build());

    }
}

variables:
  # Filter on private IP address and Subnet OCID
  testPrivateIpsByIpAddress:
    fn::invoke:
      function: oci:Core:getPrivateIps
      arguments:
        ipAddress: ${privateIpIpAddress}
        ipState: ${privateIpIpState}
        lifetime: ${privateIpLifetime}
        subnetId: ${testSubnet.id}
        vlanId: ${testVlan.id}
        vnicId: ${testVnicAttachment.id}

Using getPrivateIps

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 getPrivateIps(args: GetPrivateIpsArgs, opts?: InvokeOptions): Promise<GetPrivateIpsResult>
function getPrivateIpsOutput(args: GetPrivateIpsOutputArgs, opts?: InvokeOptions): Output<GetPrivateIpsResult>

def get_private_ips(filters: Optional[Sequence[GetPrivateIpsFilter]] = None,
                    ip_address: Optional[str] = None,
                    ip_state: Optional[str] = None,
                    lifetime: Optional[str] = None,
                    subnet_id: Optional[str] = None,
                    vlan_id: Optional[str] = None,
                    vnic_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPrivateIpsResult
def get_private_ips_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPrivateIpsFilterArgs]]]] = None,
                    ip_address: Optional[pulumi.Input[str]] = None,
                    ip_state: Optional[pulumi.Input[str]] = None,
                    lifetime: Optional[pulumi.Input[str]] = None,
                    subnet_id: Optional[pulumi.Input[str]] = None,
                    vlan_id: Optional[pulumi.Input[str]] = None,
                    vnic_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetPrivateIpsResult]

func GetPrivateIps(ctx *Context, args *GetPrivateIpsArgs, opts ...InvokeOption) (*GetPrivateIpsResult, error)
func GetPrivateIpsOutput(ctx *Context, args *GetPrivateIpsOutputArgs, opts ...InvokeOption) GetPrivateIpsResultOutput

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

public static class GetPrivateIps 
{
    public static Task<GetPrivateIpsResult> InvokeAsync(GetPrivateIpsArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateIpsResult> Invoke(GetPrivateIpsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivateIpsResult> getPrivateIps(GetPrivateIpsArgs args, InvokeOptions options)
public static Output<GetPrivateIpsResult> getPrivateIps(GetPrivateIpsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Core/getPrivateIps:getPrivateIps
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetPrivateIpsFilter>

IpAddress string

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

IpState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

Lifetime string

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

SubnetId string

The OCID of the subnet.

VlanId string

The OCID of the VLAN.

VnicId string

The OCID of the VNIC.

Filters []GetPrivateIpsFilter

IpAddress string

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

IpState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

Lifetime string

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

SubnetId string

The OCID of the subnet.

VlanId string

The OCID of the VLAN.

VnicId string

The OCID of the VNIC.

filters List<GetPrivateIpsFilter>

ipAddress String

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ipState String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

lifetime String

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

subnetId String

The OCID of the subnet.

vlanId String

The OCID of the VLAN.

vnicId String

The OCID of the VNIC.

filters GetPrivateIpsFilter[]

ipAddress string

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ipState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

lifetime string

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

subnetId string

The OCID of the subnet.

vlanId string

The OCID of the VLAN.

vnicId string

The OCID of the VNIC.

filters Sequence[GetPrivateIpsFilter]

ip_address str

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ip_state str

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

lifetime str

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

subnet_id str

The OCID of the subnet.

vlan_id str

The OCID of the VLAN.

vnic_id str

The OCID of the VNIC.

filters List<Property Map>

ipAddress String

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ipState String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

lifetime String

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

subnetId String

The OCID of the subnet.

vlanId String

The OCID of the VLAN.

vnicId String

The OCID of the VNIC.

getPrivateIps Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

PrivateIps List<GetPrivateIpsPrivateIp>

The list of private_ips.

Filters List<GetPrivateIpsFilter>

IpAddress string

The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

IpState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

Lifetime string

Lifetime of the IP address. There are two types of IPv6 IPs:

Ephemeral
Reserved

SubnetId string

The OCID of the subnet the VNIC is in.

VlanId string

Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.

VnicId string

The OCID of the VNIC the private IP is assigned to. The VNIC and private IP must be in the same subnet. However, if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the vnicId is null.

Id string

The provider-assigned unique ID for this managed resource.

PrivateIps []GetPrivateIpsPrivateIp

The list of private_ips.

Filters []GetPrivateIpsFilter

IpAddress string

The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

IpState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

Lifetime string

Lifetime of the IP address. There are two types of IPv6 IPs:

Ephemeral
Reserved

SubnetId string

The OCID of the subnet the VNIC is in.

VlanId string

Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.

VnicId string

id String

The provider-assigned unique ID for this managed resource.

privateIps List<GetPrivateIpsPrivateIp>

The list of private_ips.

filters List<GetPrivateIpsFilter>

ipAddress String

The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

ipState String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

lifetime String

Lifetime of the IP address. There are two types of IPv6 IPs:

Ephemeral
Reserved

subnetId String

The OCID of the subnet the VNIC is in.

vlanId String

Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.

vnicId String

id string

The provider-assigned unique ID for this managed resource.

privateIps GetPrivateIpsPrivateIp[]

The list of private_ips.

filters GetPrivateIpsFilter[]

ipAddress string

The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

ipState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

lifetime string

Lifetime of the IP address. There are two types of IPv6 IPs:

Ephemeral
Reserved

subnetId string

The OCID of the subnet the VNIC is in.

vlanId string

Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.

vnicId string

id str

The provider-assigned unique ID for this managed resource.

private_ips Sequence[GetPrivateIpsPrivateIp]

The list of private_ips.

filters Sequence[GetPrivateIpsFilter]

ip_address str

The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

ip_state str

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

lifetime str

Lifetime of the IP address. There are two types of IPv6 IPs:

Ephemeral
Reserved

subnet_id str

The OCID of the subnet the VNIC is in.

vlan_id str

Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.

vnic_id str

id String

The provider-assigned unique ID for this managed resource.

privateIps List<Property Map>

The list of private_ips.

filters List<Property Map>

ipAddress String

The private IP address of the privateIp object. The address is within the CIDR of the VNIC's subnet.

ipState String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.

lifetime String

Lifetime of the IP address. There are two types of IPv6 IPs:

Ephemeral
Reserved

subnetId String

The OCID of the subnet the VNIC is in.

vlanId String

Applicable only if the PrivateIp object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The vlanId is the OCID of the VLAN. See Vlan.

vnicId String

Supporting Types

GetPrivateIpsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetPrivateIpsPrivateIp

AvailabilityDomain string

The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet. Example: Uocm:PHX-AD-1

CompartmentId string

The OCID of the compartment containing the private IP.

DefinedTags Dictionary<string, string>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

HostnameLabel string

The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP's fully qualified domain name (FQDN) (for example, bminstance1 in FQDN bminstance1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

Id string

The private IP's Oracle ID (OCID).

IpAddress string

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

IpState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

IsPrimary bool

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: true

IsReserved bool

Lifetime string

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

RouteTableId string

The OCID of the route table the IP address or VNIC will use. For more information, see Source Based Routing.

SubnetId string

The OCID of the subnet.

TimeCreated string

The date and time the private IP was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

VlanId string

The OCID of the VLAN.

VnicId string

The OCID of the VNIC.

AvailabilityDomain string

The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet. Example: Uocm:PHX-AD-1

CompartmentId string

The OCID of the compartment containing the private IP.

DefinedTags map[string]string

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags map[string]string

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

HostnameLabel string

Id string

The private IP's Oracle ID (OCID).

IpAddress string

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

IpState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

IsPrimary bool

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: true

IsReserved bool

Lifetime string

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

RouteTableId string

The OCID of the route table the IP address or VNIC will use. For more information, see Source Based Routing.

SubnetId string

The OCID of the subnet.

TimeCreated string

The date and time the private IP was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

VlanId string

The OCID of the VLAN.

VnicId string

The OCID of the VNIC.

availabilityDomain String

The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet. Example: Uocm:PHX-AD-1

compartmentId String

The OCID of the compartment containing the private IP.

definedTags Map<String,String>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String,String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel String

id String

The private IP's Oracle ID (OCID).

ipAddress String

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ipState String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

isPrimary Boolean

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: true

isReserved Boolean

lifetime String

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

routeTableId String

The OCID of the route table the IP address or VNIC will use. For more information, see Source Based Routing.

subnetId String

The OCID of the subnet.

timeCreated String

The date and time the private IP was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

vlanId String

The OCID of the VLAN.

vnicId String

The OCID of the VNIC.

availabilityDomain string

The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet. Example: Uocm:PHX-AD-1

compartmentId string

The OCID of the compartment containing the private IP.

definedTags {[key: string]: string}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags {[key: string]: string}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel string

id string

The private IP's Oracle ID (OCID).

ipAddress string

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ipState string

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

isPrimary boolean

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: true

isReserved boolean

lifetime string

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

routeTableId string

The OCID of the route table the IP address or VNIC will use. For more information, see Source Based Routing.

subnetId string

The OCID of the subnet.

timeCreated string

The date and time the private IP was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

vlanId string

The OCID of the VLAN.

vnicId string

The OCID of the VNIC.

availability_domain str

The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet. Example: Uocm:PHX-AD-1

compartment_id str

The OCID of the compartment containing the private IP.

defined_tags Mapping[str, str]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeform_tags Mapping[str, str]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostname_label str

id str

The private IP's Oracle ID (OCID).

ip_address str

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ip_state str

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

is_primary bool

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: true

is_reserved bool

lifetime str

Lifetime of the IP address. There are two types of IPs:

Ephemeral
Reserved

route_table_id str

The OCID of the route table the IP address or VNIC will use. For more information, see Source Based Routing.

subnet_id str

The OCID of the subnet.

time_created str

The date and time the private IP was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

vlan_id str

The OCID of the VLAN.

vnic_id str

The OCID of the VNIC.

availabilityDomain String

The private IP's availability domain. This attribute will be null if this is a secondary private IP assigned to a VNIC that is in a regional subnet. Example: Uocm:PHX-AD-1

compartmentId String

The OCID of the compartment containing the private IP.

definedTags Map<String>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel String

id String

The private IP's Oracle ID (OCID).

ipAddress String

An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

ipState String

State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

isPrimary Boolean

Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: true

isReserved Boolean

lifetime String