CreateCpeDetails¶

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

Bases: object

CreateCpeDetails model.

Methods:

__init__(**kwargs)

Initializes a new CreateCpeDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateCpeDetails.
`cpe_device_shape_id`	Gets the cpe_device_shape_id of this CreateCpeDetails.
`defined_tags`	Gets the defined_tags of this CreateCpeDetails.
`display_name`	Gets the display_name of this CreateCpeDetails.
`freeform_tags`	Gets the freeform_tags of this CreateCpeDetails.
`ip_address`	[Required] Gets the ip_address of this CreateCpeDetails.
`is_private`	Gets the is_private of this CreateCpeDetails.

__init__(**kwargs)¶

Initializes a new CreateCpeDetails 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 CreateCpeDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateCpeDetails.
display_name (str) – The value to assign to the display_name property of this CreateCpeDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateCpeDetails.
ip_address (str) – The value to assign to the ip_address property of this CreateCpeDetails.
cpe_device_shape_id (str) – The value to assign to the cpe_device_shape_id property of this CreateCpeDetails.
is_private (bool) – The value to assign to the is_private property of this CreateCpeDetails.

property compartment_id¶

[Required] Gets the compartment_id of this CreateCpeDetails. The OCID of the compartment to contain the CPE.

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

property cpe_device_shape_id¶

Gets the cpe_device_shape_id of this CreateCpeDetails. The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call update_cpe() later to provide a value. For a list of possible values, see list_cpe_device_shapes().

For more information about generating CPE device configuration content, 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 CreateCpeDetails.
Return type: str

property defined_tags¶

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

property display_name¶

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

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

property freeform_tags¶

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

property ip_address¶

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

Example: 203.0.113.2

Returns: The ip_address of this CreateCpeDetails.
Return type: str

property is_private¶

Gets the is_private of this CreateCpeDetails. Indicates whether this CPE is of type private or not.

Returns: The is_private of this CreateCpeDetails.
Return type: bool