Oracle Cloud Infrastructure

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

getPrivateIp

This data source provides details about a specific Private Ip resource in Oracle Cloud Infrastructure Core service.

Gets the specified private IP. You must specify the object’s OCID. Alternatively, you can get the object by using ListPrivateIps with the private IP address (for example, 10.0.3.3) and subnet OCID.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testPrivateIp = Output.Create(Oci.Core.GetPrivateIp.InvokeAsync(new Oci.Core.GetPrivateIpArgs
        {
            PrivateIpId = oci_core_private_ip.Test_private_ip.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.GetPrivateIp(ctx, &core.GetPrivateIpArgs{
			PrivateIpId: oci_core_private_ip.Test_private_ip.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_private_ip = oci.Core.get_private_ip(private_ip_id=oci_core_private_ip["test_private_ip"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPrivateIp = oci.Core.getPrivateIp({
    privateIpId: oci_core_private_ip.test_private_ip.id,
});

Coming soon!

Using getPrivateIp

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 getPrivateIp(args: GetPrivateIpArgs, opts?: InvokeOptions): Promise<GetPrivateIpResult>
function getPrivateIpOutput(args: GetPrivateIpOutputArgs, opts?: InvokeOptions): Output<GetPrivateIpResult>
def get_private_ip(private_ip_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPrivateIpResult
def get_private_ip_output(private_ip_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPrivateIpResult]
func GetPrivateIp(ctx *Context, args *GetPrivateIpArgs, opts ...InvokeOption) (*GetPrivateIpResult, error)
func GetPrivateIpOutput(ctx *Context, args *GetPrivateIpOutputArgs, opts ...InvokeOption) GetPrivateIpResultOutput

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

public static class GetPrivateIp 
{
    public static Task<GetPrivateIpResult> InvokeAsync(GetPrivateIpArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateIpResult> Invoke(GetPrivateIpInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPrivateIpResult> getPrivateIp(GetPrivateIpArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Core/getPrivateIp:getPrivateIp
  Arguments:
    # Arguments dictionary

The following arguments are supported:

PrivateIpId string

The OCID of the private IP or IPv6.

PrivateIpId string

The OCID of the private IP or IPv6.

privateIpId String

The OCID of the private IP or IPv6.

privateIpId string

The OCID of the private IP or IPv6.

private_ip_id str

The OCID of the private IP or IPv6.

privateIpId String

The OCID of the private IP or IPv6.

getPrivateIp Result

The following output properties are available:

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

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

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

PrivateIpId string
SubnetId string

The OCID of the subnet the VNIC is in.

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

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.

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

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

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

PrivateIpId string
SubnetId string

The OCID of the subnet the VNIC is in.

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

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.

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

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

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

privateIpId String
subnetId String

The OCID of the subnet the VNIC is in.

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

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.

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

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

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

privateIpId string
subnetId string

The OCID of the subnet the VNIC is in.

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

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.

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

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

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

private_ip_id str
subnet_id str

The OCID of the subnet the VNIC is in.

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

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.

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

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

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

privateIpId String
subnetId String

The OCID of the subnet the VNIC is in.

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

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.

Package Details

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

This Pulumi package is based on the oci Terraform Provider.