Skip to main content

byoip_ranges

Creates, updates, deletes, gets or lists a byoip_ranges resource.

Overview​

Namebyoip_ranges
TypeResource
Idoci.network.byoip_ranges

Fields​

The following fields are returned by SELECT queries:

The ByoipRange resource was retrieved.

NameDatatypeDescription
idstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ByoipRange resource.
byoipRangeVcnIpv6AllocationsarrayA list of ByoipRangeVcnIpv6AllocationSummary objects.
cidrBlockstringThe public IPv4 CIDR block being imported from on-premises to the Oracle cloud.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block.
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"}
ipv6CidrBlockstringThe IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
lifecycleDetailsstringThe ByoipRange resource's current status. (CREATING, VALIDATING, PROVISIONED, ACTIVE, FAILED, DELETING, DELETED, ADVERTISING, WITHDRAWING)
lifecycleStatestringThe ByoipRange resource's current state. (INACTIVE, UPDATING, ACTIVE, DELETING, DELETED)
originAsnobjectInformation about the origin asn.
timeAdvertisedstring (date-time)The date and time the ByoipRange resource was advertised to the internet by BGP, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeCreatedstring (date-time)The date and time the ByoipRange resource was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeValidatedstring (date-time)The date and time the ByoipRange resource was validated, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
timeWithdrawnstring (date-time)The date and time the ByoipRange resource was withdrawn from advertisement by BGP to the internet, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
validationTokenstringThe validation token is an internally-generated ASCII string used in the validation process. See [Importing a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbyoipRangeId, regionopc-request-idGets the ByoipRange resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />
listselectcompartmentId, regionopc-request-id, limit, page, displayName, lifecycleState, sortBy, sortOrderLists the ByoipRange resources in the specified compartment.<br />You can filter the list using query parameters.<br />
createinsertregion, compartmentIdopc-request-id, opc-retry-tokenCreates a subrange of the BYOIP CIDR block.<br />
updateupdatebyoipRangeId, regionopc-request-id, if-matchUpdates the tags or display name associated to the specified BYOIP CIDR block.<br />
deletedeletebyoipRangeId, regionopc-request-id, if-matchDeletes the specified ByoipRange resource.<br />The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED.<br />It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail.<br />You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />If the ByoipRange resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.<br />
advertise_byoip_rangeexecbyoipRangeId, regionopc-request-idBegins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.<br />The ByoipRange resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.<br />
change_compartmentexecbyoipRangeId, region, compartmentIdopc-request-id, opc-retry-tokenMoves a BYOIP CIDR block to a different compartment. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />
set_origin_asnexecbyoipRangeId, region, byoasnIdopc-request-id, opc-retry-token, if-matchUpdate BYOIP's origin ASN to byoasn.<br />
set_origin_asn_to_oracleexecbyoipRangeId, regionopc-request-id, if-matchUpdate prefix's origin ASN to OCI<br />
validate_byoip_rangeexecbyoipRangeId, regionopc-request-idSubmits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already<br />modified the information for the BYOIP CIDR block with your Regional Internet Registry. See [To import a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.<br />
withdraw_byoip_rangeexecbyoipRangeId, regionopc-request-idWithdraws BGP route advertisement for the BYOIP CIDR block.<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
byoipRangeIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ByoipRange resource containing the BYOIP CIDR block.
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
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)
displayNamestringA filter to return only resources that match the given display name exactly.
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.
lifecycleStatestringA filter to return only resources that match the given lifecycle state name exactly.
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).
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples​

Gets the ByoipRange resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />

SELECT
id,
byoipRangeVcnIpv6Allocations,
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
ipv6CidrBlock,
lifecycleDetails,
lifecycleState,
originAsn,
timeAdvertised,
timeCreated,
timeValidated,
timeWithdrawn,
validationToken
FROM oci.network.byoip_ranges
WHERE byoipRangeId = '{{ byoipRangeId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a subrange of the BYOIP CIDR block.<br />

INSERT INTO oci.network.byoip_ranges (
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
ipv6CidrBlock,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ cidrBlock }}',
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ ipv6CidrBlock }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
byoipRangeVcnIpv6Allocations,
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
ipv6CidrBlock,
lifecycleDetails,
lifecycleState,
originAsn,
timeAdvertised,
timeCreated,
timeValidated,
timeWithdrawn,
validationToken
;

UPDATE examples​

Updates the tags or display name associated to the specified BYOIP CIDR block.<br />

UPDATE oci.network.byoip_ranges
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
byoipRangeId = '{{ byoipRangeId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
byoipRangeVcnIpv6Allocations,
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
ipv6CidrBlock,
lifecycleDetails,
lifecycleState,
originAsn,
timeAdvertised,
timeCreated,
timeValidated,
timeWithdrawn,
validationToken;

DELETE examples​

Deletes the specified ByoipRange resource.<br />The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED.<br />It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail.<br />You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />If the ByoipRange resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.<br />

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

Lifecycle Methods​

Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.<br />The ByoipRange resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.<br />

EXEC oci.network.byoip_ranges.advertise_byoip_range 
@byoipRangeId='{{ byoipRangeId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}'
;