CreateIPSecConnectionDetails

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

Bases: object

CreateIPSecConnectionDetails model.

CPE_LOCAL_IDENTIFIER_TYPE_HOSTNAME = 'HOSTNAME'

A constant which can be used with the cpe_local_identifier_type property of a CreateIPSecConnectionDetails. This constant has a value of "HOSTNAME"

CPE_LOCAL_IDENTIFIER_TYPE_IP_ADDRESS = 'IP_ADDRESS'

A constant which can be used with the cpe_local_identifier_type property of a CreateIPSecConnectionDetails. This constant has a value of "IP_ADDRESS"

__init__(**kwargs)

Initializes a new CreateIPSecConnectionDetails 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 CreateIPSecConnectionDetails.
  • cpe_id (str) -- The value to assign to the cpe_id property of this CreateIPSecConnectionDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreateIPSecConnectionDetails.
  • display_name (str) -- The value to assign to the display_name property of this CreateIPSecConnectionDetails.
  • drg_id (str) -- The value to assign to the drg_id property of this CreateIPSecConnectionDetails.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreateIPSecConnectionDetails.
  • cpe_local_identifier (str) -- The value to assign to the cpe_local_identifier property of this CreateIPSecConnectionDetails.
  • cpe_local_identifier_type (str) -- The value to assign to the cpe_local_identifier_type property of this CreateIPSecConnectionDetails. Allowed values for this property are: "IP_ADDRESS", "HOSTNAME"
  • static_routes (list[str]) -- The value to assign to the static_routes property of this CreateIPSecConnectionDetails.
  • tunnel_configuration (list[CreateIPSecConnectionTunnelDetails]) -- The value to assign to the tunnel_configuration property of this CreateIPSecConnectionDetails.
compartment_id

[Required] Gets the compartment_id of this CreateIPSecConnectionDetails. The OCID of the compartment to contain the IPSec connection.

Returns:The compartment_id of this CreateIPSecConnectionDetails.
Return type:str
cpe_id

[Required] Gets the cpe_id of this CreateIPSecConnectionDetails. The OCID of the Cpe object.

Returns:The cpe_id of this CreateIPSecConnectionDetails.
Return type:str
cpe_local_identifier

Gets the cpe_local_identifier of this CreateIPSecConnectionDetails. Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for cpeLocalIdentifierType.

If you don't provide a value, the ipAddress attribute for the Cpe object specified by cpeId is used as the cpeLocalIdentifier.

For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.

Example IP address: 10.0.3.3

Example hostname: cpe.example.com

Returns:The cpe_local_identifier of this CreateIPSecConnectionDetails.
Return type:str
cpe_local_identifier_type

Gets the cpe_local_identifier_type of this CreateIPSecConnectionDetails. The type of identifier for your CPE device. The value you provide here must correspond to the value for cpeLocalIdentifier.

Allowed values for this property are: "IP_ADDRESS", "HOSTNAME"

Returns:The cpe_local_identifier_type of this CreateIPSecConnectionDetails.
Return type:str
defined_tags

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

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

Returns:The display_name of this CreateIPSecConnectionDetails.
Return type:str
drg_id

[Required] Gets the drg_id of this CreateIPSecConnectionDetails. The OCID of the DRG.

Returns:The drg_id of this CreateIPSecConnectionDetails.
Return type:str
freeform_tags

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

[Required] Gets the static_routes of this CreateIPSecConnectionDetails. Static routes to the CPE. A static route's CIDR must not be a multicast address or class E address.

Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. For more information, see the important note in IPSecConnection.

The CIDR can be either IPv4 or IPv6. Note that IPv6 addressing is currently supported only in the Government Cloud.

Example: 10.0.1.0/24

Example: 2001:db8::/32

Returns:The static_routes of this CreateIPSecConnectionDetails.
Return type:list[str]
tunnel_configuration

Gets the tunnel_configuration of this CreateIPSecConnectionDetails. Information for creating the individual tunnels in the IPSec connection. You can provide a maximum of 2 tunnelConfiguration objects in the array (one for each of the two tunnels).

Returns:The tunnel_configuration of this CreateIPSecConnectionDetails.
Return type:list[CreateIPSecConnectionTunnelDetails]