Cpe

class oci.core.models.Cpe(**kwargs)

Bases: object

An object you create when setting up an IPSec VPN between your on-premises network and VCN. The Cpe is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the IPSec VPN connection. 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.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this Cpe.
cpe_device_shape_id Gets the cpe_device_shape_id of this Cpe.
defined_tags Gets the defined_tags of this Cpe.
display_name Gets the display_name of this Cpe.
freeform_tags Gets the freeform_tags of this Cpe.
id [Required] Gets the id of this Cpe.
ip_address [Required] Gets the ip_address of this Cpe.
time_created Gets the time_created of this Cpe.
__init__(**kwargs)

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

Parameters:
  • compartment_id (str) – The value to assign to the compartment_id property of this Cpe.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Cpe.
  • display_name (str) – The value to assign to the display_name property of this Cpe.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Cpe.
  • id (str) – The value to assign to the id property of this Cpe.
  • ip_address (str) – The value to assign to the ip_address property of this Cpe.
  • cpe_device_shape_id (str) – The value to assign to the cpe_device_shape_id property of this Cpe.
  • time_created (datetime) – The value to assign to the time_created property of this Cpe.
compartment_id

[Required] Gets the compartment_id of this Cpe. The OCID of the compartment containing the CPE.

Returns:The compartment_id of this Cpe.
Return type:str
cpe_device_shape_id

Gets the cpe_device_shape_id of this Cpe. The OCID of the CPE’s device type. The Networking service maintains a general list of CPE device types (for example, Cisco ASA). For each type, Oracle provides CPE configuration content that can help a network engineer configure the CPE. The OCID uniquely identifies the type of device. To get the OCIDs for the device types on the list, see list_cpe_device_shapes().

For information about how to generate CPE configuration content for a CPE device type, see:

  • get_cpe_device_config_content()
  • get_ipsec_cpe_device_config_content()
  • get_tunnel_cpe_device_config_content()
  • get_tunnel_cpe_device_config()
Returns:The cpe_device_shape_id of this Cpe.
Return type:str
defined_tags

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

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

Returns:The display_name of this Cpe.
Return type:str
freeform_tags

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

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

Returns:The id of this Cpe.
Return type:str
ip_address

[Required] Gets the ip_address of this Cpe. The public IP address of the on-premises router.

Returns:The ip_address of this Cpe.
Return type:str
time_created

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

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

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