Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getPrivateIps

This data source provides the list of Private Ips in Oracle Cloud Infrastructure Core service.

Lists the PrivateIp objects based on one of these filters:

  • Subnet OCID.
  • VNIC OCID.
  • Both private IP address and subnet OCID: This lets you get a privateIP object based on its private IP address (for example, 10.0.3.3) and not its OCID. For comparison, GetPrivateIp requires the OCID.

If you’re listing all the private IPs associated with a given subnet or VNIC, the response includes both primary and secondary private IPs.

If you are an Oracle Cloud VMware Solution customer and have VLANs in your VCN, you can filter the list by VLAN OCID. See Vlan.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testPrivateIpsBySubnet = Output.Create(Oci.Core.GetPrivateIps.InvokeAsync(new Oci.Core.GetPrivateIpsArgs
        {
            SubnetId = @var.Private_ip_subnet_id,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.GetPrivateIps(ctx, &core.GetPrivateIpsArgs{
			SubnetId: pulumi.StringRef(_var.Private_ip_subnet_id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_private_ips_by_subnet = oci.Core.get_private_ips(subnet_id=var["private_ip_subnet_id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPrivateIpsBySubnet = oci.Core.getPrivateIps({
    subnetId: _var.private_ip_subnet_id,
});

Coming soon!

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[_core.GetPrivateIpsFilter]] = None,
                    ip_address: 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[_core.GetPrivateIpsFilterArgs]]]] = None,
                    ip_address: 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)
// Output-based functions aren't available in Java yet
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

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

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

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

subnetId string

The OCID of the subnet.

vlanId string

The OCID of the VLAN.

vnicId string

The OCID of the VNIC.

filters GetPrivateIpsFilter]
ip_address str

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

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

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.

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.

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 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.

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.

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 str

The provider-assigned unique ID for this managed resource.

private_ips GetPrivateIpsPrivateIp]

The list of private_ips.

filters GetPrivateIpsFilter]
ip_address str

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

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

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 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.

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.

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, object>

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, object>

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, bminstance-1 in FQDN bminstance-1.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

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

true if the IP is reserved and can exist detached from vnic

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]interface{}

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]interface{}

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, bminstance-1 in FQDN bminstance-1.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

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

true if the IP is reserved and can exist detached from vnic

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,Object>

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,Object>

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, bminstance-1 in FQDN bminstance-1.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

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

true if the IP is reserved and can exist detached from vnic

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]: any}

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]: any}

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, bminstance-1 in FQDN bminstance-1.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

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

true if the IP is reserved and can exist detached from vnic

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, Any]

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, Any]

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

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, bminstance-1 in FQDN bminstance-1.subnet123.vcn1.oraclevcn.com). Must be unique across all VNICs in the subnet and comply with RFC 952 and RFC 1123.

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

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

true if the IP is reserved and can exist detached from vnic

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<Any>

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<Any>

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, bminstance-1 in FQDN bminstance-1.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

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

true if the IP is reserved and can exist detached from vnic

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.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.