Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IPSecConnection

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 a Site-to-Site VPN.

*Important:** Each tunnel in an IPSec connection can use either static routing or BGP dynamic routing (see the IPSecConnectionTunnel object's {@code 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 {@code BGP} to {@code 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 {@code routing} attribute = {@code STATIC}. Otherwise the static routes are ignored.

For more information about the workflow for setting up an IPSec connection, see [Site-to-Site VPN Overview](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm).

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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the IPSec connection.

cpeId

cpeId: string

The OCID of the Cpe object.

Optional cpeLocalIdentifier

cpeLocalIdentifier: undefined | string

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 {@code cpeLocalIdentifierType}.

If you don't provide a value when creating the IPSec connection, the {@code ipAddress} attribute for the Cpe object specified by {@code cpeId} is used as the {@code cpeLocalIdentifier}.

For information about why you'd provide this value, see [If Your CPE Is Behind a NAT Device](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm#nat).

Example IP address: {@code 10.0.3.3}

Example hostname: {@code cpe.example.com}

Optional cpeLocalIdentifierType

cpeLocalIdentifierType: CpeLocalIdentifierType

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

Optional definedTags

definedTags: undefined | object

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

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

Optional displayName

displayName: undefined | string

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

drgId

drgId: string

The OCID of the DRG.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The IPSec connection's Oracle ID (OCID).

lifecycleState

lifecycleState: LifecycleState

The IPSec connection's current state.

staticRoutes

staticRoutes: Array<string>

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. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

Example: {@code 10.0.1.0/24}

Example: {@code 2001:db8::/32}

Optional timeCreated

timeCreated: Date

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

Example: {@code 2016-08-25T21:10:29.600Z}

Optional transportType

transportType: TransportType

The transport type used for the IPSec connection.

Functions

getDeserializedJsonObj

getJsonObj