cpe_device_shapes
Creates, updates, deletes, gets or lists a cpe_device_shapes resource.
Overview​
| Name | cpe_device_shapes |
| Type | Resource |
| Id | oci.network.cpe_device_shapes |
Fields​
The following fields are returned by SELECT queries:
- get
- list
The parameters is being retrieved.
| Name | Datatype | Description |
|---|---|---|
cpeDeviceInfo | object | Basic information about a particular CPE device type. |
cpeDeviceShapeId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. This value uniquely identifies the type of CPE device. |
parameters | array | For certain CPE devices types, the customer can provide answers to questions that are specific to the device type. This attribute contains a list of those questions. The Networking service merges the answers with other information and renders a set of CPE configuration content. To provide the answers, use [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). |
template | string | A template of CPE device configuration information that will be merged with the customer's answers to the questions to render the final CPE device configuration content. Also see: * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent) * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent) * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent) |
A summary of information about a particular CPE device type. Compare with<br />[CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/).<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. This value uniquely identifies the type of CPE device. |
cpeDeviceInfo | object | Basic information about a particular CPE device type. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | cpeDeviceShapeId, region | opc-request-id | Gets the detailed information about the specified CPE device type. This might include a set of questions<br />that are specific to the particular CPE device type. The customer must supply answers to those questions<br />(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).<br />The service merges the answers with a template of other information for the CPE device type. The following<br />operations return the merged content:<br /><br /> * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)<br /> * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)<br /> * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)<br /> |
list | select | region | limit, page, opc-request-id | Lists the CPE device types that the Networking service provides CPE configuration<br />content for (example: Cisco ASA). The content helps a network engineer configure<br />the actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object.<br /><br />If you want to generate CPE configuration content for one of the returned CPE device types,<br />ensure that the [Cpe](#/en/iaas/latest/Cpe/) object's cpeDeviceShapeId attribute is set<br />to the CPE device type's [OCID](/iaas/Content/General/Concepts/identifiers.htm) (returned by this operation).<br /><br />For information about generating CPE configuration content, see these operations:<br /><br /> * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)<br /> * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)<br /> * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
cpeDeviceShapeId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
limit | integer | For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50 |
opc-request-id | string | Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
page | string | For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). |
SELECT examples​
- get
- list
Gets the detailed information about the specified CPE device type. This might include a set of questions<br />that are specific to the particular CPE device type. The customer must supply answers to those questions<br />(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).<br />The service merges the answers with a template of other information for the CPE device type. The following<br />operations return the merged content:<br /><br /> * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)<br /> * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)<br /> * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)<br />
SELECT
cpeDeviceInfo,
cpeDeviceShapeId,
parameters,
template
FROM oci.network.cpe_device_shapes
WHERE cpeDeviceShapeId = '{{ cpeDeviceShapeId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
Lists the CPE device types that the Networking service provides CPE configuration<br />content for (example: Cisco ASA). The content helps a network engineer configure<br />the actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object.<br /><br />If you want to generate CPE configuration content for one of the returned CPE device types,<br />ensure that the [Cpe](#/en/iaas/latest/Cpe/) object's cpeDeviceShapeId attribute is set<br />to the CPE device type's [OCID](/iaas/Content/General/Concepts/identifiers.htm) (returned by this operation).<br /><br />For information about generating CPE configuration content, see these operations:<br /><br /> * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)<br /> * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)<br /> * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)<br />
SELECT
id,
cpeDeviceInfo
FROM oci.network.cpe_device_shapes
WHERE region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
;