IPSecConnectionTunnel¶

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

Bases: object

Information about a single IPSec tunnel in an IPSec connection. This object does not include the tunnel’s shared secret (pre-shared key), which is found in the IPSecConnectionTunnelSharedSecret object.

Attributes

`DPD_MODE_INITIATE_AND_RESPOND`	A constant which can be used with the dpd_mode property of a IPSecConnectionTunnel.
`DPD_MODE_RESPOND_ONLY`	A constant which can be used with the dpd_mode property of a IPSecConnectionTunnel.
`IKE_VERSION_V1`	A constant which can be used with the ike_version property of a IPSecConnectionTunnel.
`IKE_VERSION_V2`	A constant which can be used with the ike_version property of a IPSecConnectionTunnel.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a IPSecConnectionTunnel.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a IPSecConnectionTunnel.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a IPSecConnectionTunnel.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a IPSecConnectionTunnel.
`NAT_TRANSLATION_ENABLED_AUTO`	A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel.
`NAT_TRANSLATION_ENABLED_DISABLED`	A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel.
`NAT_TRANSLATION_ENABLED_ENABLED`	A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel.
`ORACLE_CAN_INITIATE_INITIATOR_OR_RESPONDER`	A constant which can be used with the oracle_can_initiate property of a IPSecConnectionTunnel.
`ORACLE_CAN_INITIATE_RESPONDER_ONLY`	A constant which can be used with the oracle_can_initiate property of a IPSecConnectionTunnel.
`ROUTING_BGP`	A constant which can be used with the routing property of a IPSecConnectionTunnel.
`ROUTING_POLICY`	A constant which can be used with the routing property of a IPSecConnectionTunnel.
`ROUTING_STATIC`	A constant which can be used with the routing property of a IPSecConnectionTunnel.
`STATUS_DOWN`	A constant which can be used with the status property of a IPSecConnectionTunnel.
`STATUS_DOWN_FOR_MAINTENANCE`	A constant which can be used with the status property of a IPSecConnectionTunnel.
`STATUS_PARTIAL_UP`	A constant which can be used with the status property of a IPSecConnectionTunnel.
`STATUS_UP`	A constant which can be used with the status property of a IPSecConnectionTunnel.
`associated_virtual_circuits`	Gets the associated_virtual_circuits of this IPSecConnectionTunnel.
`bgp_session_info`	Gets the bgp_session_info of this IPSecConnectionTunnel.
`compartment_id`	[Required] Gets the compartment_id of this IPSecConnectionTunnel.
`cpe_ip`	Gets the cpe_ip of this IPSecConnectionTunnel.
`display_name`	Gets the display_name of this IPSecConnectionTunnel.
`dpd_mode`	Gets the dpd_mode of this IPSecConnectionTunnel.
`dpd_timeout_in_sec`	Gets the dpd_timeout_in_sec of this IPSecConnectionTunnel.
`encryption_domain_config`	Gets the encryption_domain_config of this IPSecConnectionTunnel.
`id`	[Required] Gets the id of this IPSecConnectionTunnel.
`ike_version`	Gets the ike_version of this IPSecConnectionTunnel.
`lifecycle_state`	[Required] Gets the lifecycle_state of this IPSecConnectionTunnel.
`nat_translation_enabled`	Gets the nat_translation_enabled of this IPSecConnectionTunnel.
`oracle_can_initiate`	Gets the oracle_can_initiate of this IPSecConnectionTunnel.
`phase_one_details`	Gets the phase_one_details of this IPSecConnectionTunnel.
`phase_two_details`	Gets the phase_two_details of this IPSecConnectionTunnel.
`routing`	Gets the routing of this IPSecConnectionTunnel.
`status`	Gets the status of this IPSecConnectionTunnel.
`time_created`	Gets the time_created of this IPSecConnectionTunnel.
`time_status_updated`	Gets the time_status_updated of this IPSecConnectionTunnel.
`vpn_ip`	Gets the vpn_ip of this IPSecConnectionTunnel.

Methods

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

DPD_MODE_INITIATE_AND_RESPOND = 'INITIATE_AND_RESPOND'¶: A constant which can be used with the dpd_mode property of a IPSecConnectionTunnel. This constant has a value of “INITIATE_AND_RESPOND”

DPD_MODE_RESPOND_ONLY = 'RESPOND_ONLY'¶: A constant which can be used with the dpd_mode property of a IPSecConnectionTunnel. This constant has a value of “RESPOND_ONLY”

IKE_VERSION_V1 = 'V1'¶: A constant which can be used with the ike_version property of a IPSecConnectionTunnel. This constant has a value of “V1”

IKE_VERSION_V2 = 'V2'¶: A constant which can be used with the ike_version property of a IPSecConnectionTunnel. This constant has a value of “V2”

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

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

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

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

NAT_TRANSLATION_ENABLED_AUTO = 'AUTO'¶: A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel. This constant has a value of “AUTO”

NAT_TRANSLATION_ENABLED_DISABLED = 'DISABLED'¶: A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel. This constant has a value of “DISABLED”

NAT_TRANSLATION_ENABLED_ENABLED = 'ENABLED'¶: A constant which can be used with the nat_translation_enabled property of a IPSecConnectionTunnel. This constant has a value of “ENABLED”

ORACLE_CAN_INITIATE_INITIATOR_OR_RESPONDER = 'INITIATOR_OR_RESPONDER'¶: A constant which can be used with the oracle_can_initiate property of a IPSecConnectionTunnel. This constant has a value of “INITIATOR_OR_RESPONDER”

ORACLE_CAN_INITIATE_RESPONDER_ONLY = 'RESPONDER_ONLY'¶: A constant which can be used with the oracle_can_initiate property of a IPSecConnectionTunnel. This constant has a value of “RESPONDER_ONLY”

ROUTING_BGP = 'BGP'¶: A constant which can be used with the routing property of a IPSecConnectionTunnel. This constant has a value of “BGP”

ROUTING_POLICY = 'POLICY'¶: A constant which can be used with the routing property of a IPSecConnectionTunnel. This constant has a value of “POLICY”

ROUTING_STATIC = 'STATIC'¶: A constant which can be used with the routing property of a IPSecConnectionTunnel. This constant has a value of “STATIC”

STATUS_DOWN = 'DOWN'¶: A constant which can be used with the status property of a IPSecConnectionTunnel. This constant has a value of “DOWN”

STATUS_DOWN_FOR_MAINTENANCE = 'DOWN_FOR_MAINTENANCE'¶: A constant which can be used with the status property of a IPSecConnectionTunnel. This constant has a value of “DOWN_FOR_MAINTENANCE”

STATUS_PARTIAL_UP = 'PARTIAL_UP'¶: A constant which can be used with the status property of a IPSecConnectionTunnel. This constant has a value of “PARTIAL_UP”

STATUS_UP = 'UP'¶: A constant which can be used with the status property of a IPSecConnectionTunnel. This constant has a value of “UP”

__init__(**kwargs)¶

Initializes a new IPSecConnectionTunnel 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 IPSecConnectionTunnel.
id (str) – The value to assign to the id property of this IPSecConnectionTunnel.
vpn_ip (str) – The value to assign to the vpn_ip property of this IPSecConnectionTunnel.
cpe_ip (str) – The value to assign to the cpe_ip property of this IPSecConnectionTunnel.
status (str) – The value to assign to the status property of this IPSecConnectionTunnel. Allowed values for this property are: “UP”, “DOWN”, “DOWN_FOR_MAINTENANCE”, “PARTIAL_UP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ike_version (str) – The value to assign to the ike_version property of this IPSecConnectionTunnel. Allowed values for this property are: “V1”, “V2”, ‘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 IPSecConnectionTunnel. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this IPSecConnectionTunnel.
bgp_session_info (oci.core.models.BgpSessionInfo) – The value to assign to the bgp_session_info property of this IPSecConnectionTunnel.
encryption_domain_config (oci.core.models.EncryptionDomainConfig) – The value to assign to the encryption_domain_config property of this IPSecConnectionTunnel.
routing (str) – The value to assign to the routing property of this IPSecConnectionTunnel. Allowed values for this property are: “BGP”, “STATIC”, “POLICY”, ‘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 IPSecConnectionTunnel.
time_status_updated (datetime) – The value to assign to the time_status_updated property of this IPSecConnectionTunnel.
oracle_can_initiate (str) – The value to assign to the oracle_can_initiate property of this IPSecConnectionTunnel. Allowed values for this property are: “INITIATOR_OR_RESPONDER”, “RESPONDER_ONLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
nat_translation_enabled (str) – The value to assign to the nat_translation_enabled property of this IPSecConnectionTunnel. Allowed values for this property are: “ENABLED”, “DISABLED”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dpd_mode (str) – The value to assign to the dpd_mode property of this IPSecConnectionTunnel. Allowed values for this property are: “INITIATE_AND_RESPOND”, “RESPOND_ONLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dpd_timeout_in_sec (int) – The value to assign to the dpd_timeout_in_sec property of this IPSecConnectionTunnel.
phase_one_details (oci.core.models.TunnelPhaseOneDetails) – The value to assign to the phase_one_details property of this IPSecConnectionTunnel.
phase_two_details (oci.core.models.TunnelPhaseTwoDetails) – The value to assign to the phase_two_details property of this IPSecConnectionTunnel.
associated_virtual_circuits (list[str]) – The value to assign to the associated_virtual_circuits property of this IPSecConnectionTunnel.

associated_virtual_circuits¶

Gets the associated_virtual_circuits of this IPSecConnectionTunnel. The list of virtual circuit `OCID`__s over which your network can reach this tunnel.

Returns:	The associated_virtual_circuits of this IPSecConnectionTunnel.
Return type:	list[str]

bgp_session_info¶

Gets the bgp_session_info of this IPSecConnectionTunnel.

Returns:	The bgp_session_info of this IPSecConnectionTunnel.
Return type:	oci.core.models.BgpSessionInfo

compartment_id¶

[Required] Gets the compartment_id of this IPSecConnectionTunnel. The `OCID`__ of the compartment containing the tunnel.

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

cpe_ip¶

Gets the cpe_ip of this IPSecConnectionTunnel. The IP address of the CPE device’s VPN headend.

Example: 203.0.113.22

Returns:	The cpe_ip of this IPSecConnectionTunnel.
Return type:	str

display_name¶

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

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

dpd_mode¶

Gets the dpd_mode of this IPSecConnectionTunnel. Dead peer detection (DPD) mode set on the Oracle side of the connection. This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, or both respond to and initiate requests.

Allowed values for this property are: “INITIATE_AND_RESPOND”, “RESPOND_ONLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The dpd_mode of this IPSecConnectionTunnel.
Return type:	str

dpd_timeout_in_sec¶

Gets the dpd_timeout_in_sec of this IPSecConnectionTunnel. DPD timeout in seconds.

Returns:	The dpd_timeout_in_sec of this IPSecConnectionTunnel.
Return type:	int

encryption_domain_config¶

Gets the encryption_domain_config of this IPSecConnectionTunnel.

Returns:	The encryption_domain_config of this IPSecConnectionTunnel.
Return type:	oci.core.models.EncryptionDomainConfig

id¶

[Required] Gets the id of this IPSecConnectionTunnel. The `OCID`__ of the tunnel.

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

ike_version¶

Gets the ike_version of this IPSecConnectionTunnel. Internet Key Exchange protocol version.

Allowed values for this property are: “V1”, “V2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The ike_version of this IPSecConnectionTunnel.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this IPSecConnectionTunnel. The tunnel’s lifecycle state.

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

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

nat_translation_enabled¶

Gets the nat_translation_enabled of this IPSecConnectionTunnel. By default (the AUTO setting), IKE sends packets with a source and destination port set to 500, and when it detects that the port used to forward packets has changed (most likely because a NAT device is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.

The ENABLED option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.

The DISABLED option directs IKE to completely refuse to negotiate NAT-T even if it senses there may be a NAT device in use.

.

Allowed values for this property are: “ENABLED”, “DISABLED”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The nat_translation_enabled of this IPSecConnectionTunnel.
Return type:	str

oracle_can_initiate¶

Gets the oracle_can_initiate of this IPSecConnectionTunnel. Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests.

Allowed values for this property are: “INITIATOR_OR_RESPONDER”, “RESPONDER_ONLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The oracle_can_initiate of this IPSecConnectionTunnel.
Return type:	str

phase_one_details¶

Gets the phase_one_details of this IPSecConnectionTunnel.

Returns:	The phase_one_details of this IPSecConnectionTunnel.
Return type:	oci.core.models.TunnelPhaseOneDetails

phase_two_details¶

Gets the phase_two_details of this IPSecConnectionTunnel.

Returns:	The phase_two_details of this IPSecConnectionTunnel.
Return type:	oci.core.models.TunnelPhaseTwoDetails

routing¶

Gets the routing of this IPSecConnectionTunnel. The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing).

Allowed values for this property are: “BGP”, “STATIC”, “POLICY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The routing of this IPSecConnectionTunnel.
Return type:	str

status¶

Gets the status of this IPSecConnectionTunnel. The status of the tunnel based on IPSec protocol characteristics.

Allowed values for this property are: “UP”, “DOWN”, “DOWN_FOR_MAINTENANCE”, “PARTIAL_UP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this IPSecConnectionTunnel.
Return type:	str

time_created¶

Gets the time_created of this IPSecConnectionTunnel. The date and time the IPSec tunnel was created, in the format defined by `RFC3339`__.

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

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

time_status_updated¶

Gets the time_status_updated of this IPSecConnectionTunnel. When the status of the IPSec tunnel last changed, in the format defined by `RFC3339`__.

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

Returns:	The time_status_updated of this IPSecConnectionTunnel.
Return type:	datetime

vpn_ip¶

Gets the vpn_ip of this IPSecConnectionTunnel. The IP address of the Oracle VPN headend for the connection.

Example: 203.0.113.21

Returns:	The vpn_ip of this IPSecConnectionTunnel.
Return type:	str