Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Cpe

An object you create when setting up a Site-to-Site VPN between your on-premises network and VCN. The {@code Cpe} is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the Site-to-Site VPN IPSec connection. For more information, see Overview of the Networking Service.

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

Optional cpeDeviceShapeId

cpeDeviceShapeId: undefined | string

The OCID of the CPE's device type. The Networking service maintains a general list of CPE device types (for example, Cisco ASA). For each type, Oracle provides CPE configuration content that can help a network engineer configure the CPE. The OCID uniquely identifies the type of device. To get the OCIDs for the device types on the list, see {@link #listCpeDeviceShapes(ListCpeDeviceShapesRequest) listCpeDeviceShapes}.

For information about how to generate CPE configuration content for a CPE device type, see:

{@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} * {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} * {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent} * {@link #getTunnelCpeDeviceConfig(GetTunnelCpeDeviceConfigRequest) getTunnelCpeDeviceConfig}

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.

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 CPE's Oracle ID (OCID).

ipAddress

ipAddress: string

The public IP address of the on-premises router.

Optional isPrivate

isPrivate: undefined | false | true

Indicates whether this CPE is of type {@code private} or not.

Optional timeCreated

timeCreated: Date

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

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

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Cpe): object

getJsonObj

  • getJsonObj(obj: Cpe): object