Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.Core.getPrivateIp
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testPrivateIp = oci.Core.getPrivateIp({
privateIpId: testPrivateIpOciCorePrivateIp.id,
});
import pulumi
import pulumi_oci as oci
test_private_ip = oci.Core.get_private_ip(private_ip_id=test_private_ip_oci_core_private_ip["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 {
_, err := Core.GetPrivateIp(ctx, &core.GetPrivateIpArgs{
PrivateIpId: testPrivateIpOciCorePrivateIp.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(() =>
{
var testPrivateIp = Oci.Core.GetPrivateIp.Invoke(new()
{
PrivateIpId = testPrivateIpOciCorePrivateIp.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.GetPrivateIpArgs;
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) {
final var testPrivateIp = CoreFunctions.getPrivateIp(GetPrivateIpArgs.builder()
.privateIpId(testPrivateIpOciCorePrivateIp.id())
.build());
}
}
variables:
testPrivateIp:
fn::invoke:
Function: oci:Core:getPrivateIp
Arguments:
privateIpId: ${testPrivateIpOciCorePrivateIp.id}
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:
- Private
Ip stringId - The OCID of the private IP or IPv6.
- Private
Ip stringId - The OCID of the private IP or IPv6.
- private
Ip StringId - The OCID of the private IP or IPv6.
- private
Ip stringId - The OCID of the private IP or IPv6.
- private_
ip_ strid - The OCID of the private IP or IPv6.
- private
Ip StringId - The OCID of the private IP or IPv6.
getPrivateIp Result
The following output properties are available:
- Availability
Domain 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
- Compartment
Id string - The OCID of the compartment containing the private IP.
- 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"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Hostname
Label 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 FQDNbminstance1.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).
- Ip
Address string - 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 stringId - Subnet
Id string - The OCID of the subnet the VNIC is in.
- Time
Created string - The date and time the private IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Vlan
Id string - Applicable only if the
PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution. ThevlanId
is the OCID of the VLAN. See Vlan. - Vnic
Id 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, thevnicId
is null.
- Availability
Domain 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
- Compartment
Id string - The OCID of the compartment containing the private IP.
- 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"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Hostname
Label 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 FQDNbminstance1.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).
- Ip
Address string - 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 stringId - Subnet
Id string - The OCID of the subnet the VNIC is in.
- Time
Created string - The date and time the private IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- Vlan
Id string - Applicable only if the
PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution. ThevlanId
is the OCID of the VLAN. See Vlan. - Vnic
Id 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, thevnicId
is null.
- availability
Domain 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
- compartment
Id String - The OCID of the compartment containing the private IP.
- 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"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- hostname
Label 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 FQDNbminstance1.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).
- ip
Address String - The private IP address of the
privateIp
object. The address is within the CIDR of the VNIC's subnet. - is
Primary 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
- is
Reserved Boolean - true if the IP is reserved and can exist detached from vnic
- private
Ip StringId - subnet
Id String - The OCID of the subnet the VNIC is in.
- time
Created String - The date and time the private IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- vlan
Id String - Applicable only if the
PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution. ThevlanId
is the OCID of the VLAN. See Vlan. - vnic
Id 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, thevnicId
is null.
- availability
Domain 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
- compartment
Id string - The OCID of the compartment containing the private IP.
- {[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"}
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[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"}
- hostname
Label 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 FQDNbminstance1.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).
- ip
Address string - The private IP address of the
privateIp
object. The address is within the CIDR of the VNIC's subnet. - is
Primary 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
- is
Reserved boolean - true if the IP is reserved and can exist detached from vnic
- private
Ip stringId - subnet
Id string - The OCID of the subnet the VNIC is in.
- time
Created string - The date and time the private IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- vlan
Id string - Applicable only if the
PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution. ThevlanId
is the OCID of the VLAN. See Vlan. - vnic
Id 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, thevnicId
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.
- 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.
- 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 - 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 FQDNbminstance1.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_ strid - 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. ThevlanId
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, thevnicId
is null.
- availability
Domain 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
- compartment
Id String - The OCID of the compartment containing the private IP.
- 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"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- hostname
Label 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 FQDNbminstance1.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).
- ip
Address String - The private IP address of the
privateIp
object. The address is within the CIDR of the VNIC's subnet. - is
Primary 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
- is
Reserved Boolean - true if the IP is reserved and can exist detached from vnic
- private
Ip StringId - subnet
Id String - The OCID of the subnet the VNIC is in.
- time
Created String - The date and time the private IP was created, in the format defined by RFC3339. Example:
2016-08-25T21:10:29.600Z
- vlan
Id String - Applicable only if the
PrivateIp
object is being used with a VLAN as part of the Oracle Cloud VMware Solution. ThevlanId
is the OCID of the VLAN. See Vlan. - vnic
Id 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, thevnicId
is null.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.