Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Ipv6

An IPv6 is a conceptual term that refers to an IPv6 address and related properties. The IPv6 object is the API representation of an IPv6.

You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an IPv6-enabled VCN.

*Note:** IPv6 addressing is currently supported only in certain regions. For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](https://docs.cloud.oracle.com/Content/Network/Concepts/ipv6.htm).

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the IPv6. This is the same as the VNIC's compartment.

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

displayName

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

id

id: string

The OCID of the IPv6.

ipAddress

ipAddress: string

The IPv6 address of the IPv6 object. The address is within the private IPv6 CIDR block of the VNIC's subnet (see the ipv6CidrBlock attribute for the Subnet object).

Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789`

Optional isInternetAccessAllowed

isInternetAccessAllowed: undefined | false | true

Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is true, the IPv6 uses its public IP address for internet communication.

Example: `true`

lifecycleState

lifecycleState: LifecycleState

The IPv6's current state.

Optional publicIpAddress

publicIpAddress: undefined | string

The IPv6 address to be used for internet communication. The address is within the public IPv6 CIDR block of the VNIC's subnet (see the ipv6PublicCidrBlock attribute for the Subnet object).

If your organization did NOT assign a custom IPv6 CIDR to the VCN for the private address space, Oracle provides the IPv6 CIDR and uses that same CIDR for the private and public address space. Therefore the `publicIpAddress` would be the same as the `ipAddress`.

If your organization assigned a custom IPv6 CIDR to the VCN for the private address space, the right 80 bits of the IPv6 public IP (the subnet and address bits) are the same as for the `ipAddress`. But the left 48 bits are from the public IPv6 CIDR that Oracle assigned to the VCN.

This is null if the IPv6 is created with `isInternetAccessAllowed` set to `false`.

Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789`

subnetId

subnetId: string

The OCID of the subnet the VNIC is in.

timeCreated

timeCreated: Date

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

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

vnicId

vnicId: string

The OCID of the VNIC the IPv6 is assigned to. The VNIC and IPv6 must be in the same subnet.

Functions

getJsonObj

  • getJsonObj(obj: Ipv6): object