ByoipRange¶

class oci.core.models.ByoipRange(**kwargs)¶

Bases: object

Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure. A ByoipRange resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. The process used to Bring Your Own IP is explained in the documentation.

Attributes

`LIFECYCLE_DETAILS_ACTIVE`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_ADVERTISING`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_CREATING`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_DELETED`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_DELETING`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_FAILED`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_PROVISIONED`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_VALIDATING`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_DETAILS_WITHDRAWING`	A constant which can be used with the lifecycle_details property of a ByoipRange.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ByoipRange.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ByoipRange.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ByoipRange.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a ByoipRange.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ByoipRange.
`byoip_range_vcn_ipv6_allocations`	Gets the byoip_range_vcn_ipv6_allocations of this ByoipRange.
`cidr_block`	Gets the cidr_block of this ByoipRange.
`compartment_id`	[Required] Gets the compartment_id of this ByoipRange.
`defined_tags`	Gets the defined_tags of this ByoipRange.
`display_name`	Gets the display_name of this ByoipRange.
`freeform_tags`	Gets the freeform_tags of this ByoipRange.
`id`	[Required] Gets the id of this ByoipRange.
`ipv6_cidr_block`	Gets the ipv6_cidr_block of this ByoipRange.
`lifecycle_details`	Gets the lifecycle_details of this ByoipRange.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ByoipRange.
`time_advertised`	Gets the time_advertised of this ByoipRange.
`time_created`	[Required] Gets the time_created of this ByoipRange.
`time_validated`	Gets the time_validated of this ByoipRange.
`time_withdrawn`	Gets the time_withdrawn of this ByoipRange.
`validation_token`	[Required] Gets the validation_token of this ByoipRange.

Methods

__init__(**kwargs) Initializes a new ByoipRange object with values from keyword arguments.

LIFECYCLE_DETAILS_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “ACTIVE”

LIFECYCLE_DETAILS_ADVERTISING = 'ADVERTISING'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “ADVERTISING”

LIFECYCLE_DETAILS_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “CREATING”

LIFECYCLE_DETAILS_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “DELETED”

LIFECYCLE_DETAILS_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “DELETING”

LIFECYCLE_DETAILS_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “FAILED”

LIFECYCLE_DETAILS_PROVISIONED = 'PROVISIONED'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “PROVISIONED”

LIFECYCLE_DETAILS_VALIDATING = 'VALIDATING'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “VALIDATING”

LIFECYCLE_DETAILS_WITHDRAWING = 'WITHDRAWING'¶: A constant which can be used with the lifecycle_details property of a ByoipRange. This constant has a value of “WITHDRAWING”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ByoipRange. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ByoipRange. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ByoipRange. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ByoipRange. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ByoipRange. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ByoipRange object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

byoip_range_vcn_ipv6_allocations (list[oci.core.models.ByoipRangeVcnIpv6AllocationSummary]) – The value to assign to the byoip_range_vcn_ipv6_allocations property of this ByoipRange.
cidr_block (str) – The value to assign to the cidr_block property of this ByoipRange.
compartment_id (str) – The value to assign to the compartment_id property of this ByoipRange.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ByoipRange.
display_name (str) – The value to assign to the display_name property of this ByoipRange.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ByoipRange.
id (str) – The value to assign to the id property of this ByoipRange.
ipv6_cidr_block (str) – The value to assign to the ipv6_cidr_block property of this ByoipRange.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ByoipRange. Allowed values for this property are: “CREATING”, “VALIDATING”, “PROVISIONED”, “ACTIVE”, “FAILED”, “DELETING”, “DELETED”, “ADVERTISING”, “WITHDRAWING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ByoipRange. Allowed values for this property are: “INACTIVE”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this ByoipRange.
time_validated (datetime) – The value to assign to the time_validated property of this ByoipRange.
time_advertised (datetime) – The value to assign to the time_advertised property of this ByoipRange.
time_withdrawn (datetime) – The value to assign to the time_withdrawn property of this ByoipRange.
validation_token (str) – The value to assign to the validation_token property of this ByoipRange.

byoip_range_vcn_ipv6_allocations¶

Gets the byoip_range_vcn_ipv6_allocations of this ByoipRange. A list of ByoipRangeVcnIpv6AllocationSummary objects.

Returns:	The byoip_range_vcn_ipv6_allocations of this ByoipRange.
Return type:	list[oci.core.models.ByoipRangeVcnIpv6AllocationSummary]

cidr_block¶

Gets the cidr_block of this ByoipRange. The public IPv4 CIDR block being imported from on-premises to the Oracle cloud.

Returns:	The cidr_block of this ByoipRange.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ByoipRange. The OCID of the compartment containing the BYOIP CIDR block.

Returns:	The compartment_id of this ByoipRange.
Return type:	str

defined_tags¶

Gets the defined_tags of this ByoipRange. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this ByoipRange.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this ByoipRange. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this ByoipRange.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ByoipRange. 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”}

Returns:	The freeform_tags of this ByoipRange.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ByoipRange. The OCID of the ByoipRange resource.

Returns:	The id of this ByoipRange.
Return type:	str

ipv6_cidr_block¶

Gets the ipv6_cidr_block of this ByoipRange. The 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.

Returns:	The ipv6_cidr_block of this ByoipRange.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ByoipRange. The ByoipRange resource’s current status.

Allowed values for this property are: “CREATING”, “VALIDATING”, “PROVISIONED”, “ACTIVE”, “FAILED”, “DELETING”, “DELETED”, “ADVERTISING”, “WITHDRAWING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_details of this ByoipRange.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ByoipRange. The ByoipRange resource’s current state.

Allowed values for this property are: “INACTIVE”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ByoipRange.
Return type:	str

time_advertised¶

Gets the time_advertised of this ByoipRange. The date and time the ByoipRange resource was advertised to the internet by BGP, in the format defined by RFC3339.

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

Returns:	The time_advertised of this ByoipRange.
Return type:	datetime

time_created¶

[Required] Gets the time_created of this ByoipRange. The date and time the ByoipRange resource was created, in the format defined by RFC3339.

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

Returns:	The time_created of this ByoipRange.
Return type:	datetime

time_validated¶

Gets the time_validated of this ByoipRange. The date and time the ByoipRange resource was validated, in the format defined by RFC3339.

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

Returns:	The time_validated of this ByoipRange.
Return type:	datetime

time_withdrawn¶

Gets the time_withdrawn of this ByoipRange. The date and time the ByoipRange resource was withdrawn from advertisement by BGP to the internet, in the format defined by RFC3339.

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

Returns:	The time_withdrawn of this ByoipRange.
Return type:	datetime

validation_token¶

[Required] Gets the validation_token of this ByoipRange. The validation token is an internally-generated ASCII string used in the validation process. See Importing a CIDR block for details.

Returns:	The validation_token of this ByoipRange.
Return type:	str