IPSecConnectionTunnel¶

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

Bases: object

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

Attributes

`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.
`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.
`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.
`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.
`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.

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”

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.

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’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

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

routing¶

Gets the routing of this IPSecConnectionTunnel. The type of routing used for this tunnel (either BGP dynamic routing or static 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 connection 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 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 Oracle’s VPN headend.

Example: 203.0.113.21

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