Class CreateIPSecConnectionDetails

Inheritance

object

CreateIPSecConnectionDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.VnmonitoringService.Models

Assembly: OCI.DotNetSDK.Vnmonitoring.dll

Syntax

public class CreateIPSecConnectionDetails

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 to contain 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 you provide here must correspond to the value for `cpeLocalIdentifierType`. If you don't provide a value, 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 you provide here must correspond to the value for cpeLocalIdentifierType.
If you don't provide a value, 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(StringEnumConverter))]
public CreateIPSecConnectionDetails.CpeLocalIdentifierTypeEnum? CpeLocalIdentifierType { get; set; }

Property Value

Type	Description
CreateIPSecConnectionDetails.CpeLocalIdentifierTypeEnum?	The type of identifier for your CPE device. The value you provide 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. Example: {"foo-namespace": {"bar-key": "value"}}

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>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

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. A static route's 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. For more information, see the important note in {@link IPSecConnection}. 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. A static route's 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. For more information, see the important note in {@link IPSecConnection}.
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

TunnelConfiguration

Declaration

[JsonProperty(PropertyName = "tunnelConfiguration")]
public List<CreateIPSecConnectionTunnelDetails> TunnelConfiguration { get; set; }

Property Value

Type	Description
List<CreateIPSecConnectionTunnelDetails>	Information for creating the individual tunnels in the IPSec connection. You can provide a maximum of 2 `tunnelConfiguration` objects in the array (one for each of the two tunnels).

TunnelCount

Declaration

[JsonProperty(PropertyName = "tunnelCount")]
public int? TunnelCount { get; set; }

Property Value

Type	Description
int?	The count of tunnels in the IPsec connection. This value should be equal to the number of `tunnelConfiguration` objects specified in the `CreateIPSecConnection` request.