Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreatePrivateIpDetails

Properties

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

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

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

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, {@code bminstance1} in FQDN {@code bminstance1.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: {@code bminstance1}

Optional ipAddress

ipAddress: undefined | string

A private IP address of your choice. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet.

Example: {@code 10.0.3.3}

Optional vlanId

vlanId: undefined | string

Use this attribute only with the Oracle Cloud VMware Solution.

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IP is to be drawn. The IP address, *if supplied*, must be valid for the given VLAN. See Vlan.

Optional vnicId

vnicId: undefined | string

The OCID of the VNIC to assign the private IP to. The VNIC and private IP must be in the same subnet.

Functions

getDeserializedJsonObj

getJsonObj