Vcn¶

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

Bases: object

A virtual cloud network (VCN). For more information, see Overview of the Networking Service.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes:

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a Vcn.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a Vcn.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a Vcn.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a Vcn.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Vcn.
`byoipv6_cidr_blocks`	Gets the byoipv6_cidr_blocks of this Vcn.
`cidr_block`	[Required] Gets the cidr_block of this Vcn.
`cidr_blocks`	[Required] Gets the cidr_blocks of this Vcn.
`compartment_id`	[Required] Gets the compartment_id of this Vcn.
`default_dhcp_options_id`	Gets the default_dhcp_options_id of this Vcn.
`default_route_table_id`	Gets the default_route_table_id of this Vcn.
`default_security_list_id`	Gets the default_security_list_id of this Vcn.
`defined_tags`	Gets the defined_tags of this Vcn.
`display_name`	Gets the display_name of this Vcn.
`dns_label`	Gets the dns_label of this Vcn.
`freeform_tags`	Gets the freeform_tags of this Vcn.
`id`	[Required] Gets the id of this Vcn.
`ipv6_cidr_blocks`	Gets the ipv6_cidr_blocks of this Vcn.
`ipv6_private_cidr_blocks`	Gets the ipv6_private_cidr_blocks of this Vcn.
`is_zpr_only`	Gets the is_zpr_only of this Vcn.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Vcn.
`security_attributes`	Gets the security_attributes of this Vcn.
`system_tags`	Gets the system_tags of this Vcn.
`time_created`	Gets the time_created of this Vcn.
`vcn_domain_name`	Gets the vcn_domain_name of this Vcn.

Methods:

__init__(**kwargs)

Initializes a new Vcn object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a Vcn. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a Vcn. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a Vcn. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a Vcn. This constant has a value of “TERMINATING”

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

__init__(**kwargs)¶

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

Parameters

byoipv6_cidr_blocks (list[str]) – The value to assign to the byoipv6_cidr_blocks property of this Vcn.
ipv6_private_cidr_blocks (list[str]) – The value to assign to the ipv6_private_cidr_blocks property of this Vcn.
cidr_block (str) – The value to assign to the cidr_block property of this Vcn.
cidr_blocks (list[str]) – The value to assign to the cidr_blocks property of this Vcn.
compartment_id (str) – The value to assign to the compartment_id property of this Vcn.
default_dhcp_options_id (str) – The value to assign to the default_dhcp_options_id property of this Vcn.
default_route_table_id (str) – The value to assign to the default_route_table_id property of this Vcn.
default_security_list_id (str) – The value to assign to the default_security_list_id property of this Vcn.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Vcn.
display_name (str) – The value to assign to the display_name property of this Vcn.
dns_label (str) – The value to assign to the dns_label property of this Vcn.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Vcn.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this Vcn.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Vcn.
id (str) – The value to assign to the id property of this Vcn.
ipv6_cidr_blocks (list[str]) – The value to assign to the ipv6_cidr_blocks property of this Vcn.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Vcn. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, ‘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 Vcn.
vcn_domain_name (str) – The value to assign to the vcn_domain_name property of this Vcn.
is_zpr_only (bool) – The value to assign to the is_zpr_only property of this Vcn.

property byoipv6_cidr_blocks¶

Gets the byoipv6_cidr_blocks of this Vcn. The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.

Returns: The byoipv6_cidr_blocks of this Vcn.
Return type: list[str]

property cidr_block¶

[Required] Gets the cidr_block of this Vcn. Deprecated. The first CIDR IP address from cidrBlocks.

Example: 172.16.0.0/16

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

property cidr_blocks¶

[Required] Gets the cidr_blocks of this Vcn. The list of IPv4 CIDR blocks the VCN will use.

Returns: The cidr_blocks of this Vcn.
Return type: list[str]

property compartment_id¶

[Required] Gets the compartment_id of this Vcn. The OCID of the compartment containing the VCN.

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

property default_dhcp_options_id¶

Gets the default_dhcp_options_id of this Vcn. The OCID for the VCN’s default set of DHCP options.

Returns: The default_dhcp_options_id of this Vcn.
Return type: str

property default_route_table_id¶

Gets the default_route_table_id of this Vcn. The OCID for the VCN’s default route table.

Returns: The default_route_table_id of this Vcn.
Return type: str

property default_security_list_id¶

Gets the default_security_list_id of this Vcn. The OCID for the VCN’s default security list.

Returns: The default_security_list_id of this Vcn.
Return type: str

property defined_tags¶

Gets the defined_tags of this Vcn. 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 Vcn.
Return type: dict(str, dict(str, object))

property display_name¶

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

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

property dns_label¶

Gets the dns_label of this Vcn. A DNS label for the VCN, used in conjunction with the VNIC’s hostname and subnet’s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.

The absence of this parameter means the Internet and VCN Resolver will not work for this VCN.

For more information, see DNS in Your Virtual Cloud Network.

Example: vcn1

Returns: The dns_label of this Vcn.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this Vcn. 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 Vcn.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this Vcn. The VCN’s Oracle ID (OCID).

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

property ipv6_cidr_blocks¶

Gets the ipv6_cidr_blocks of this Vcn. For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN’s IP address space. The prefixes are provided by Oracle and the sizes are always /56.

Returns: The ipv6_cidr_blocks of this Vcn.
Return type: list[str]

property ipv6_private_cidr_blocks¶

Gets the ipv6_private_cidr_blocks of this Vcn. For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN’s IP address space.

Returns: The ipv6_private_cidr_blocks of this Vcn.
Return type: list[str]

property is_zpr_only¶

Gets the is_zpr_only of this Vcn. Indicates whether ZPR Only mode is enforced.

Returns: The is_zpr_only of this Vcn.
Return type: bool

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Vcn. The VCN’s current state.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property security_attributes¶

Gets the security_attributes of this Vcn. Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {“Oracle-DataSecurity-ZPR”: {“MaxEgressCount”: {“value”:”42”,”mode”:”audit”}}}

Returns: The security_attributes of this Vcn.
Return type: dict(str, dict(str, object))

property system_tags¶

Gets the system_tags of this Vcn. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } }

Returns: The system_tags of this Vcn.
Return type: dict(str, dict(str, object))

property time_created¶

Gets the time_created of this Vcn. The date and time the VCN was created, in the format defined by RFC3339.

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

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

property vcn_domain_name¶

Gets the vcn_domain_name of this Vcn. The VCN’s domain name, which consists of the VCN’s DNS label, and the oraclevcn.com domain.

For more information, see DNS in Your Virtual Cloud Network.

Example: vcn1.oraclevcn.com

Returns: The vcn_domain_name of this Vcn.
Return type: str