Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateIPSecConnectionDetails

Properties

compartmentId

compartmentId: string

The OCID of the compartment to contain 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 you provide here must correspond to the value for cpeLocalIdentifierType.

If you don't provide a value, 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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm#nat).

Example IP address: `10.0.3.3`

Example hostname: `cpe.example.com`

Optional cpeLocalIdentifierType

cpeLocalIdentifierType: CpeLocalIdentifierType

The type of identifier for your CPE device. The value you provide here must correspond to the value for 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: `{\"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: `{\"Department\": \"Finance\"}`

staticRoutes

staticRoutes: Array<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 IPSecConnection.

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: `10.0.1.0/24`

Example: `2001:db8::/32`

Optional tunnelConfiguration

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

Functions

getDeserializedJsonObj

getJsonObj