com.oracle.bmc.core.model

Class IPSecConnection

java.lang.Object

com.oracle.bmc.core.model.IPSecConnection

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class IPSecConnection
extends Object

A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up an IPSec VPN.

Important:* Each tunnel in an IPSec connection can use either static routing or BGP dynamic routing (see the IPSecConnectionTunnel object’s routing attribute). Originally only static routing was supported and every IPSec connection was required to have at least one static route configured. To maintain backward compatibility in the API when support for BPG dynamic routing was introduced, the API accepts an empty list of static routes if you configure both of the IPSec tunnels to use BGP dynamic routing. If you switch a tunnel’s routing from BGP to STATIC, you must first ensure that the IPSec connection is configured with at least one valid CIDR block static route. Oracle uses the IPSec connection’s static routes when routing a tunnel’s traffic only if that tunnel’s routing attribute = STATIC. Otherwise the static routes are ignored.

For more information about the workflow for setting up an IPSec connection, see IPSec VPN.

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.

Note: Objects should always be created or deserialized using the IPSecConnection.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the IPSecConnection.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IPSecConnection.Builder
static class	IPSecConnection.CpeLocalIdentifierType The type of identifier for your CPE device.
static class	IPSecConnection.LifecycleState The IPSec connection’s current state.

Constructor Summary

Constructors

Constructor and Description
IPSecConnection(String compartmentId, String cpeId, Map<String,Map<String,Object>> definedTags, String displayName, String drgId, Map<String,String> freeformTags, String id, IPSecConnection.LifecycleState lifecycleState, String cpeLocalIdentifier, IPSecConnection.CpeLocalIdentifierType cpeLocalIdentifierType, List<String> staticRoutes, Date timeCreated) Deprecated.

Method Summary

Modifier and Type	Method and Description
static IPSecConnection.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCompartmentId() The OCID of the compartment containing the IPSec connection.
String	getCpeId() The OCID of the Cpe object.
String	getCpeLocalIdentifier() Your identifier for your CPE device.
IPSecConnection.CpeLocalIdentifierType	getCpeLocalIdentifierType() The type of identifier for your CPE device.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name.
String	getDrgId() The OCID of the DRG.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The IPSec connection’s Oracle ID (OCID).
IPSecConnection.LifecycleState	getLifecycleState() The IPSec connection’s current state.
List<String>	getStaticRoutes() Static routes to the CPE.
Date	getTimeCreated() The date and time the IPSec connection was created, in the format defined by RFC3339.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPSecConnection

@ConstructorProperties(value={"compartmentId","cpeId","definedTags","displayName","drgId","freeformTags","id","lifecycleState","cpeLocalIdentifier","cpeLocalIdentifierType","staticRoutes","timeCreated"})
 @Deprecated
public IPSecConnection(String compartmentId,
                                                                                                                                                                                                                                                String cpeId,
                                                                                                                                                                                                                                                Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                String displayName,
                                                                                                                                                                                                                                                String drgId,
                                                                                                                                                                                                                                                Map<String,String> freeformTags,
                                                                                                                                                                                                                                                String id,
                                                                                                                                                                                                                                                IPSecConnection.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                String cpeLocalIdentifier,
                                                                                                                                                                                                                                                IPSecConnection.CpeLocalIdentifierType cpeLocalIdentifierType,
                                                                                                                                                                                                                                                List<String> staticRoutes,
                                                                                                                                                                                                                                                Date timeCreated)

Deprecated.

Method Detail

builder

public static IPSecConnection.Builder builder()

Create a new builder.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the IPSec connection.

getCpeId

public String getCpeId()

The OCID of the Cpe object.

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

getDrgId

public String getDrgId()

The OCID of the DRG.

getFreeformTags

public Map<String,String> getFreeformTags()

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\"}

getId

public String getId()

The IPSec connection’s Oracle ID (OCID).

getLifecycleState

public IPSecConnection.LifecycleState getLifecycleState()

The IPSec connection’s current state.

getCpeLocalIdentifier

public String getCpeLocalIdentifier()

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 here must correspond to the value for cpeLocalIdentifierType.

If you don’t provide a value when creating the IPSec connection, 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

getCpeLocalIdentifierType

public IPSecConnection.CpeLocalIdentifierType getCpeLocalIdentifierType()

The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.

getStaticRoutes

public List<String> getStaticRoutes()

Static routes to the CPE. The 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.

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

getTimeCreated

public Date getTimeCreated()

The date and time the IPSec connection was created, in the format defined by RFC3339.

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

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object