Skip to main content

ipv6s

Creates, updates, deletes, gets or lists an ipv6s resource.

Overview​

Nameipv6s
TypeResource
Idoci.network.ipv6s

Fields​

The following fields are returned by SELECT queries:

The IPv6 was retrievd.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6.
cidrPrefixLengthintegerLength of cidr range. Optional field to specify flexible cidr.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPv6. This is the same as the VNIC's compartment.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectFree-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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
ipAddressstringThe IPv6 address of the IPv6 object. The address is within the IPv6 prefix of the VNIC's subnet (see the ipv6CidrBlock attribute for the [Subnet](#/en/iaas/latest/Subnet/) object. Example: 2001:0db8:0123:1111:abcd:ef01:2345:6789
ipStatestringState of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE. (ASSIGNED, AVAILABLE)
isInternetAccessAllowedbooleanWhether 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
lifecycleStatestringThe IPv6's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
lifetimestringLifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved (EPHEMERAL, RESERVED)
publicIpAddressstringThe IPv6 address to be used for internet communication. The address is within the IPv6 prefix of the VNIC's subnet (see the ipv6PublicCidrBlock attribute for the [Subnet](#/en/iaas/latest/Subnet/) object). If your organization did NOT assign a custom IPv6 prefix to the VCN for the private address space, Oracle provides the IPv6 prefix and uses that same prefix for the private and public address space. Therefore the publicIpAddress would be the same as the ipAddress. If your organization assigned a custom IPv6 prefix to the VCN for the address space, the right 80 bits of the IPv6 IP (the subnet and address bits) are the same as for the ipAddress. But the left 48 bits are from the IPv6 prefix 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
routeTableIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https:​//docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing).
subnetIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
timeCreatedstring (date-time)The date and time the IPv6 was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
vnicIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC the IPv6 is assigned to. The VNIC and IPv6 must be in the same subnet.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectipv6Id, regionopc-request-idGets the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />Alternatively, you can get the object by using<br />[ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s)<br />with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />
listselectregionlimit, page, ipAddress, subnetId, vnicId, ipState, lifetime, opc-request-idLists the [IPv6](#/en/iaas/latest/Ipv6/) objects based<br />on one of these filters:<br /><br /> * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br /> * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br /> * Both IPv6 address and subnet OCID: This lets you get an Ipv6 object based on its private<br /> IPv6 address (for example, 2001:0db8:0123:1111🔡ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,<br /> [GetIpv6](#/en/iaas/latest/Ipv6/GetIpv6) requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />
createinsertregionopc-request-id, opc-retry-tokenCreates an IPv6 for the specified VNIC.<br />
updateupdateipv6Id, regionif-match, opc-request-idUpdates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />Use this operation if you want to:<br /><br /> * Move an IPv6 to a different VNIC in the same subnet.<br /> * Enable/disable internet access for an IPv6.<br /> * Change the display name for an IPv6.<br /> * Update resource tags for an IPv6.<br />
deletedeleteipv6Id, regionif-match, opc-request-idUnassigns and deletes the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />The IPv6 address is returned to the subnet's pool of available addresses.<br />
bulk_create_ipv6sexecregion, bulkCreateIpv6sItemopc-retry-token, opc-request-idCreate new IPv6s in bulk for a VNIC or subnet.<br />
bulk_delete_ipv6sexecregion, bulkDeleteIpv6sItemopc-retry-token, opc-request-idUnassign and delete IPv6s for a VNIC in bulk.<br />
bulk_detach_ipv6sexecregion, bulkDetachIpv6sItemopc-retry-token, opc-request-idDetach the specified IPv6s.<br />
bulk_update_ipv6sexecregion, bulkUpdateIpv6sItemopc-retry-token, opc-request-idUpdates the specified IPv6s in bulk.<br />
ipv6_vnic_detachexecipv6Id, regionif-match, opc-request-id, opc-retry-tokenUnassign the specified IPv6 address from Virtual Network Interface Card (VNIC). You must specify the IPv6 [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
ipv6IdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
ipAddressstringAn IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3
ipStatestringState of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE
lifetimestringLifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved
limitintegerFor list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringFor list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
subnetIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet.
vnicIdstringThe OCID of the VNIC.

SELECT examples​

Gets the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />Alternatively, you can get the object by using<br />[ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s)<br />with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />

SELECT
id,
cidrPrefixLength,
compartmentId,
definedTags,
displayName,
freeformTags,
ipAddress,
ipState,
isInternetAccessAllowed,
lifecycleState,
lifetime,
publicIpAddress,
routeTableId,
subnetId,
timeCreated,
vnicId
FROM oci.network.ipv6s
WHERE ipv6Id = '{{ ipv6Id }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates an IPv6 for the specified VNIC.<br />

INSERT INTO oci.network.ipv6s (
cidrPrefixLength,
definedTags,
displayName,
freeformTags,
ipAddress,
ipv6SubnetCidr,
isInternetAccessAllowed,
lifetime,
routeTableId,
subnetId,
vnicId,
region,
opc-request-id,
opc-retry-token
)
SELECT 
{{ cidrPrefixLength }},
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ ipAddress }}',
'{{ ipv6SubnetCidr }}',
{{ isInternetAccessAllowed }},
'{{ lifetime }}',
'{{ routeTableId }}',
'{{ subnetId }}',
'{{ vnicId }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
cidrPrefixLength,
compartmentId,
definedTags,
displayName,
freeformTags,
ipAddress,
ipState,
isInternetAccessAllowed,
lifecycleState,
lifetime,
publicIpAddress,
routeTableId,
subnetId,
timeCreated,
vnicId
;

UPDATE examples​

Updates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />Use this operation if you want to:<br /><br /> * Move an IPv6 to a different VNIC in the same subnet.<br /> * Enable/disable internet access for an IPv6.<br /> * Change the display name for an IPv6.<br /> * Update resource tags for an IPv6.<br />

UPDATE oci.network.ipv6s
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
isInternetAccessAllowed = {{ isInternetAccessAllowed }},
lifetime = '{{ lifetime }}',
routeTableId = '{{ routeTableId }}',
vnicId = '{{ vnicId }}'
WHERE 
ipv6Id = '{{ ipv6Id }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
cidrPrefixLength,
compartmentId,
definedTags,
displayName,
freeformTags,
ipAddress,
ipState,
isInternetAccessAllowed,
lifecycleState,
lifetime,
publicIpAddress,
routeTableId,
subnetId,
timeCreated,
vnicId;

DELETE examples​

Unassigns and deletes the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />The IPv6 address is returned to the subnet's pool of available addresses.<br />

DELETE FROM oci.network.ipv6s
WHERE ipv6Id = '{{ ipv6Id }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods​

Create new IPv6s in bulk for a VNIC or subnet.<br />

EXEC oci.network.ipv6s.bulk_create_ipv6s 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"bulkCreateIpv6sItem": "{{ bulkCreateIpv6sItem }}", 
"subnetId": "{{ subnetId }}", 
"vnicId": "{{ vnicId }}"
}'
;