Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateCpeDetails

Properties

compartmentId

compartmentId: string

The OCID of the compartment to contain the CPE.

Optional cpeDeviceShapeId

cpeDeviceShapeId: undefined | string

The OCID of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call {@link #updateCpe(UpdateCpeRequest) updateCpe} later to provide a value. For a list of possible values, see {@link #listCpeDeviceShapes(ListCpeDeviceShapesRequest) listCpeDeviceShapes}.

For more information about generating CPE device configuration content, 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. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

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

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

ipAddress

ipAddress: string

The public IP address of the on-premises router.

Example: {@code 203.0.113.2}

Optional isPrivate

isPrivate: undefined | false | true

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

Functions

getDeserializedJsonObj

getJsonObj