Class 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 {@link 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 Site-to-Site VPN Overview.
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.

Inheritance

object

IPSecConnection

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Models

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class IPSecConnection

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the IPSec connection.

Remarks

Required

CpeId

Declaration

[Required(ErrorMessage = "CpeId is required.")]
[JsonProperty(PropertyName = "cpeId")]
public string CpeId { get; set; }

Property Value

Type	Description
string	The OCID of the {@link Cpe} object.

Remarks

Required

CpeLocalIdentifier

Declaration

[JsonProperty(PropertyName = "cpeLocalIdentifier")]
public string CpeLocalIdentifier { get; set; }

Property Value

Type Description

Type	Description
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 `cpeLocalIdentifierType`. If you don't provide a value when creating the IPSec connection, the `ipAddress` attribute for the {@link 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`

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 cpeLocalIdentifierType.
If you don't provide a value when creating the IPSec connection, the ipAddress attribute for the {@link 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

CpeLocalIdentifierType

Declaration

[JsonProperty(PropertyName = "cpeLocalIdentifierType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public IPSecConnection.CpeLocalIdentifierTypeEnum? CpeLocalIdentifierType { get; set; }

Property Value

Type	Description
IPSecConnection.CpeLocalIdentifierTypeEnum?	The type of identifier for your CPE device. The value here must correspond to the value for `cpeLocalIdentifier`.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

DrgId

Declaration

[Required(ErrorMessage = "DrgId is required.")]
[JsonProperty(PropertyName = "drgId")]
public string DrgId { get; set; }

Property Value

Type	Description
string	The OCID of the DRG.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The IPSec connection's Oracle ID (OCID).

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public IPSecConnection.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
IPSecConnection.LifecycleStateEnum?	The IPSec connection's current state.

Remarks

Required

StaticRoutes

Declaration

[Required(ErrorMessage = "StaticRoutes is required.")]
[JsonProperty(PropertyName = "staticRoutes")]
public List<string> StaticRoutes { get; set; }

Property Value

Type	Description
List<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. Example: 10.0.1.0/24

Type

Description

List<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.
Example: 10.0.1.0/24

Remarks

Required

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TransportType

Declaration

[JsonProperty(PropertyName = "transportType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public IPSecConnection.TransportTypeEnum? TransportType { get; set; }

Property Value

Type	Description
IPSecConnection.TransportTypeEnum?	The transport type used for the IPSec connection.