1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getCpes
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.Core.getCpes

Get Started
oci logo
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Cpes in Oracle Cloud Infrastructure Core service.

    Lists the customer-premises equipment objects (CPEs) in the specified compartment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCpes = oci.Core.getCpes({
    compartmentId: compartmentId,
});

    import pulumi
import pulumi_oci as oci

test_cpes = oci.Core.get_cpes(compartment_id=compartment_id)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetCpes(ctx, &core.GetCpesArgs{
			CompartmentId: compartmentId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCpes = Oci.Core.GetCpes.Invoke(new()
    {
        CompartmentId = compartmentId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetCpesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testCpes = CoreFunctions.getCpes(GetCpesArgs.builder()
            .compartmentId(compartmentId)
            .build());

    }
}

    variables:
  testCpes:
    fn::invoke:
      function: oci:Core:getCpes
      arguments:
        compartmentId: ${compartmentId}

    Using getCpes

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCpes(args: GetCpesArgs, opts?: InvokeOptions): Promise<GetCpesResult>
function getCpesOutput(args: GetCpesOutputArgs, opts?: InvokeOptions): Output<GetCpesResult>
    def get_cpes(compartment_id: Optional[str] = None,
             filters: Optional[Sequence[GetCpesFilter]] = None,
             opts: Optional[InvokeOptions] = None) -> GetCpesResult
def get_cpes_output(compartment_id: Optional[pulumi.Input[str]] = None,
             filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetCpesFilterArgs]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetCpesResult]
    func GetCpes(ctx *Context, args *GetCpesArgs, opts ...InvokeOption) (*GetCpesResult, error)
func GetCpesOutput(ctx *Context, args *GetCpesOutputArgs, opts ...InvokeOption) GetCpesResultOutput

    > Note: This function is named GetCpes in the Go SDK.

    public static class GetCpes 
{
    public static Task<GetCpesResult> InvokeAsync(GetCpesArgs args, InvokeOptions? opts = null)
    public static Output<GetCpesResult> Invoke(GetCpesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCpesResult> getCpes(GetCpesArgs args, InvokeOptions options)
public static Output<GetCpesResult> getCpes(GetCpesArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Core/getCpes:getCpes
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    Filters List<GetCpesFilter>
    CompartmentId string
    The OCID of the compartment.
    Filters []GetCpesFilter
    compartmentId String
    The OCID of the compartment.
    filters List<GetCpesFilter>
    compartmentId string
    The OCID of the compartment.
    filters GetCpesFilter[]
    compartmentId String
    The OCID of the compartment.
    filters List<Property Map>

    getCpes Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing the CPE.
    Cpes List<GetCpesCpe>
    The list of cpes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters List<GetCpesFilter>
    CompartmentId string
    The OCID of the compartment containing the CPE.
    Cpes []GetCpesCpe
    The list of cpes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Filters []GetCpesFilter
    compartmentId String
    The OCID of the compartment containing the CPE.
    cpes List<GetCpesCpe>
    The list of cpes.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<GetCpesFilter>
    compartmentId string
    The OCID of the compartment containing the CPE.
    cpes GetCpesCpe[]
    The list of cpes.
    id string
    The provider-assigned unique ID for this managed resource.
    filters GetCpesFilter[]
    compartment_id str
    The OCID of the compartment containing the CPE.
    cpes Sequence[GetCpesCpe]
    The list of cpes.
    id str
    The provider-assigned unique ID for this managed resource.
    filters Sequence[GetCpesFilter]
    compartmentId String
    The OCID of the compartment containing the CPE.
    cpes List<Property Map>
    The list of cpes.
    id String
    The provider-assigned unique ID for this managed resource.
    filters List<Property Map>

    Supporting Types

    GetCpesCpe

    CompartmentId string
    The OCID of the compartment.
    CpeDeviceShapeId 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 ListCpeDeviceShapes.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    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"}
    Id string
    The CPE's Oracle ID (OCID).
    IpAddress string
    The public IP address of the on-premises router.
    IsPrivate bool
    Indicates whether this CPE is of type private or not.
    TimeCreated string
    The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the compartment.
    CpeDeviceShapeId 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 ListCpeDeviceShapes.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    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"}
    Id string
    The CPE's Oracle ID (OCID).
    IpAddress string
    The public IP address of the on-premises router.
    IsPrivate bool
    Indicates whether this CPE is of type private or not.
    TimeCreated string
    The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment.
    cpeDeviceShapeId 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 ListCpeDeviceShapes.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    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"}
    id String
    The CPE's Oracle ID (OCID).
    ipAddress String
    The public IP address of the on-premises router.
    isPrivate Boolean
    Indicates whether this CPE is of type private or not.
    timeCreated String
    The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the compartment.
    cpeDeviceShapeId 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 ListCpeDeviceShapes.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    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"}
    id string
    The CPE's Oracle ID (OCID).
    ipAddress string
    The public IP address of the on-premises router.
    isPrivate boolean
    Indicates whether this CPE is of type private or not.
    timeCreated string
    The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the compartment.
    cpe_device_shape_id str
    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 ListCpeDeviceShapes.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    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"}
    id str
    The CPE's Oracle ID (OCID).
    ip_address str
    The public IP address of the on-premises router.
    is_private bool
    Indicates whether this CPE is of type private or not.
    time_created str
    The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment.
    cpeDeviceShapeId 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 ListCpeDeviceShapes.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    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"}
    id String
    The CPE's Oracle ID (OCID).
    ipAddress String
    The public IP address of the on-premises router.
    isPrivate Boolean
    Indicates whether this CPE is of type private or not.
    timeCreated String
    The date and time the CPE was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    GetCpesFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate