Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PrivateIp

A private IP is a conceptual term that refers to an IPv4 private IP address and related properties. The privateIp object is the API representation of a private IP.

*Note:** For information about IPv6 addresses, see Ipv6.

Each instance has a *primary private IP* that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can't remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated.

You can add *secondary private IPs* to a VNIC after it's created. For more information, see the `privateIp` operations and also [IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).

*Note:** Only {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps} and {@link #getPrivateIp(GetPrivateIpRequest) getPrivateIp} work with *primary* private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP's properties come from the values you specify in CreateVnicDetails when calling either {@link #launchInstance(LaunchInstanceRequest) launchInstance} or {@link #attachVnic(AttachVnicRequest) attachVnic}. To update the hostname for a primary private IP, you use {@link #updateVnic(UpdateVnicRequest) updateVnic}.

`PrivateIp` objects that are created for use with the Oracle Cloud VMware Solution are assigned to a VLAN and not a VNIC in a subnet. See the descriptions of the relevant attributes in the `PrivateIp` object. Also see Vlan.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional availabilityDomain

availabilityDomain: undefined | 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`

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment containing the private IP.

Optional definedTags

definedTags: undefined | 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\"}}`

Optional displayName

displayName: undefined | string

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

Optional freeformTags

freeformTags: undefined | 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\"}`

Optional hostnameLabel

hostnameLabel: undefined | 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.

For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

Example: `bminstance-1`

Optional id

id: undefined | string

The private IP's Oracle ID (OCID).

Optional ipAddress

ipAddress: undefined | string

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

However, if the `PrivateIp` object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the address is from the range specified by the `cidrBlock` attribute for the VLAN. See Vlan.

Example: `10.0.3.3`

Optional isPrimary

isPrimary: undefined | false | true

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`

Optional subnetId

subnetId: undefined | string

The OCID of the subnet the VNIC is in.

However, if the `PrivateIp` object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the `subnetId` is null.

Optional timeCreated

timeCreated: Date

The date and time the private IP was created, in the format defined by RFC3339.

Example: `2016-08-25T21:10:29.600Z`

Optional vlanId

vlanId: undefined | 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.

Optional vnicId

vnicId: undefined | 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.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: PrivateIp): object

getJsonObj