Oracle Cloud Infrastructure v2.32.0, Apr 24 25

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.Database.getDbServers

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testDbServers = oci.Database.getDbServers({
    compartmentId: compartmentId,
    exadataInfrastructureId: testExadataInfrastructure.id,
    displayName: dbServerDisplayName,
    state: dbServerState,
});

import pulumi
import pulumi_oci as oci

test_db_servers = oci.Database.get_db_servers(compartment_id=compartment_id,
    exadata_infrastructure_id=test_exadata_infrastructure["id"],
    display_name=db_server_display_name,
    state=db_server_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.GetDbServers(ctx, &database.GetDbServersArgs{
			CompartmentId:           compartmentId,
			ExadataInfrastructureId: testExadataInfrastructure.Id,
			DisplayName:             pulumi.StringRef(dbServerDisplayName),
			State:                   pulumi.StringRef(dbServerState),
		}, 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 testDbServers = Oci.Database.GetDbServers.Invoke(new()
    {
        CompartmentId = compartmentId,
        ExadataInfrastructureId = testExadataInfrastructure.Id,
        DisplayName = dbServerDisplayName,
        State = dbServerState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetDbServersArgs;
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 testDbServers = DatabaseFunctions.getDbServers(GetDbServersArgs.builder()
            .compartmentId(compartmentId)
            .exadataInfrastructureId(testExadataInfrastructure.id())
            .displayName(dbServerDisplayName)
            .state(dbServerState)
            .build());

    }
}

variables:
  testDbServers:
    fn::invoke:
      function: oci:Database:getDbServers
      arguments:
        compartmentId: ${compartmentId}
        exadataInfrastructureId: ${testExadataInfrastructure.id}
        displayName: ${dbServerDisplayName}
        state: ${dbServerState}

Using getDbServers

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.

TypeScript
Python
Go
C#
Java
YAML

function getDbServers(args: GetDbServersArgs, opts?: InvokeOptions): Promise<GetDbServersResult>
function getDbServersOutput(args: GetDbServersOutputArgs, opts?: InvokeOptions): Output<GetDbServersResult>

def get_db_servers(compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   exadata_infrastructure_id: Optional[str] = None,
                   filters: Optional[Sequence[_database.GetDbServersFilter]] = None,
                   state: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDbServersResult
def get_db_servers_output(compartment_id: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   exadata_infrastructure_id: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetDbServersFilterArgs]]]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDbServersResult]

func GetDbServers(ctx *Context, args *GetDbServersArgs, opts ...InvokeOption) (*GetDbServersResult, error)
func GetDbServersOutput(ctx *Context, args *GetDbServersOutputArgs, opts ...InvokeOption) GetDbServersResultOutput

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

public static class GetDbServers 
{
    public static Task<GetDbServersResult> InvokeAsync(GetDbServersArgs args, InvokeOptions? opts = null)
    public static Output<GetDbServersResult> Invoke(GetDbServersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDbServersResult> getDbServers(GetDbServersArgs args, InvokeOptions options)
public static Output<GetDbServersResult> getDbServers(GetDbServersArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Database/getDbServers:getDbServers
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The compartment OCID.
ExadataInfrastructureId string: The OCID of the ExadataInfrastructure.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters List<GetDbServersFilter>
State string: A filter to return only resources that match the given lifecycle state exactly.

CompartmentId string: The compartment OCID.
ExadataInfrastructureId string: The OCID of the ExadataInfrastructure.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters []GetDbServersFilter
State string: A filter to return only resources that match the given lifecycle state exactly.

compartmentId String: The compartment OCID.
exadataInfrastructureId String: The OCID of the ExadataInfrastructure.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<GetDbServersFilter>
state String: A filter to return only resources that match the given lifecycle state exactly.

compartmentId string: The compartment OCID.
exadataInfrastructureId string: The OCID of the ExadataInfrastructure.
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters GetDbServersFilter[]
state string: A filter to return only resources that match the given lifecycle state exactly.

compartment_id str: The compartment OCID.
exadata_infrastructure_id str: The OCID of the ExadataInfrastructure.
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Sequence[database.GetDbServersFilter]
state str: A filter to return only resources that match the given lifecycle state exactly.

compartmentId String: The compartment OCID.
exadataInfrastructureId String: The OCID of the ExadataInfrastructure.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<Property Map>
state String: A filter to return only resources that match the given lifecycle state exactly.

getDbServers Result

The following output properties are available:

CompartmentId string: The OCID of the compartment.
DbServers List<GetDbServersDbServer>: The list of db_servers.
ExadataInfrastructureId string: The OCID of the Exadata infrastructure.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: The user-friendly name for the Db server. The name does not need to be unique.
Filters List<GetDbServersFilter>
State string: The current state of the Db server.

CompartmentId string: The OCID of the compartment.
DbServers []GetDbServersDbServer: The list of db_servers.
ExadataInfrastructureId string: The OCID of the Exadata infrastructure.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: The user-friendly name for the Db server. The name does not need to be unique.
Filters []GetDbServersFilter
State string: The current state of the Db server.

compartmentId String: The OCID of the compartment.
dbServers List<GetDbServersDbServer>: The list of db_servers.
exadataInfrastructureId String: The OCID of the Exadata infrastructure.
id String: The provider-assigned unique ID for this managed resource.
displayName String: The user-friendly name for the Db server. The name does not need to be unique.
filters List<GetDbServersFilter>
state String: The current state of the Db server.

compartmentId string: The OCID of the compartment.
dbServers GetDbServersDbServer[]: The list of db_servers.
exadataInfrastructureId string: The OCID of the Exadata infrastructure.
id string: The provider-assigned unique ID for this managed resource.
displayName string: The user-friendly name for the Db server. The name does not need to be unique.
filters GetDbServersFilter[]
state string: The current state of the Db server.

compartment_id str: The OCID of the compartment.
db_servers Sequence[database.GetDbServersDbServer]: The list of db_servers.
exadata_infrastructure_id str: The OCID of the Exadata infrastructure.
id str: The provider-assigned unique ID for this managed resource.
display_name str: The user-friendly name for the Db server. The name does not need to be unique.
filters Sequence[database.GetDbServersFilter]
state str: The current state of the Db server.

compartmentId String: The OCID of the compartment.
dbServers List<Property Map>: The list of db_servers.
exadataInfrastructureId String: The OCID of the Exadata infrastructure.
id String: The provider-assigned unique ID for this managed resource.
displayName String: The user-friendly name for the Db server. The name does not need to be unique.
filters List<Property Map>
state String: The current state of the Db server.

Supporting Types

GetDbServersDbServer

AutonomousVirtualMachineIds List<string>: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
AutonomousVmClusterIds List<string>: The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
CompartmentId string: The compartment OCID.
ComputeModel string: The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
CpuCoreCount int: The number of CPU cores enabled on the Db server.
DbNodeIds List<string>: The OCID of the Db nodes associated with the Db server.
DbNodeStorageSizeInGbs int: The allocated local node storage in GBs on the Db server.
DbServerPatchingDetails List<GetDbServersDbServerDbServerPatchingDetail>: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
ExadataInfrastructureId string: The OCID of the ExadataInfrastructure.
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 OCID of the Exacc Db server.
LifecycleDetails string: Additional information about the current lifecycle state.
MaxCpuCount int: The total number of CPU cores available.
MaxDbNodeStorageInGbs int: The total local node storage available in GBs.
MaxMemoryInGbs int: The total memory available in GBs.
MemorySizeInGbs int: The allocated memory in GBs on the Db server.
Shape string: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
State string: A filter to return only resources that match the given lifecycle state exactly.
TimeCreated string: The date and time that the Db Server was created.
VmClusterIds List<string>: The OCID of the VM Clusters associated with the Db server.

AutonomousVirtualMachineIds []string: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
AutonomousVmClusterIds []string: The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
CompartmentId string: The compartment OCID.
ComputeModel string: The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
CpuCoreCount int: The number of CPU cores enabled on the Db server.
DbNodeIds []string: The OCID of the Db nodes associated with the Db server.
DbNodeStorageSizeInGbs int: The allocated local node storage in GBs on the Db server.
DbServerPatchingDetails []GetDbServersDbServerDbServerPatchingDetail: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
ExadataInfrastructureId string: The OCID of the ExadataInfrastructure.
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 OCID of the Exacc Db server.
LifecycleDetails string: Additional information about the current lifecycle state.
MaxCpuCount int: The total number of CPU cores available.
MaxDbNodeStorageInGbs int: The total local node storage available in GBs.
MaxMemoryInGbs int: The total memory available in GBs.
MemorySizeInGbs int: The allocated memory in GBs on the Db server.
Shape string: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
State string: A filter to return only resources that match the given lifecycle state exactly.
TimeCreated string: The date and time that the Db Server was created.
VmClusterIds []string: The OCID of the VM Clusters associated with the Db server.

autonomousVirtualMachineIds List<String>: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
autonomousVmClusterIds List<String>: The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
compartmentId String: The compartment OCID.
computeModel String: The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
cpuCoreCount Integer: The number of CPU cores enabled on the Db server.
dbNodeIds List<String>: The OCID of the Db nodes associated with the Db server.
dbNodeStorageSizeInGbs Integer: The allocated local node storage in GBs on the Db server.
dbServerPatchingDetails List<GetDbServersDbServerDbServerPatchingDetail>: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
exadataInfrastructureId String: The OCID of the ExadataInfrastructure.
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 OCID of the Exacc Db server.
lifecycleDetails String: Additional information about the current lifecycle state.
maxCpuCount Integer: The total number of CPU cores available.
maxDbNodeStorageInGbs Integer: The total local node storage available in GBs.
maxMemoryInGbs Integer: The total memory available in GBs.
memorySizeInGbs Integer: The allocated memory in GBs on the Db server.
shape String: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
state String: A filter to return only resources that match the given lifecycle state exactly.
timeCreated String: The date and time that the Db Server was created.
vmClusterIds List<String>: The OCID of the VM Clusters associated with the Db server.

autonomousVirtualMachineIds string[]: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
autonomousVmClusterIds string[]: The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
compartmentId string: The compartment OCID.
computeModel string: The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
cpuCoreCount number: The number of CPU cores enabled on the Db server.
dbNodeIds string[]: The OCID of the Db nodes associated with the Db server.
dbNodeStorageSizeInGbs number: The allocated local node storage in GBs on the Db server.
dbServerPatchingDetails GetDbServersDbServerDbServerPatchingDetail[]: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
exadataInfrastructureId string: The OCID of the ExadataInfrastructure.
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 OCID of the Exacc Db server.
lifecycleDetails string: Additional information about the current lifecycle state.
maxCpuCount number: The total number of CPU cores available.
maxDbNodeStorageInGbs number: The total local node storage available in GBs.
maxMemoryInGbs number: The total memory available in GBs.
memorySizeInGbs number: The allocated memory in GBs on the Db server.
shape string: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
state string: A filter to return only resources that match the given lifecycle state exactly.
timeCreated string: The date and time that the Db Server was created.
vmClusterIds string[]: The OCID of the VM Clusters associated with the Db server.

autonomous_virtual_machine_ids Sequence[str]: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
autonomous_vm_cluster_ids Sequence[str]: The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
compartment_id str: The compartment OCID.
compute_model str: The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
cpu_core_count int: The number of CPU cores enabled on the Db server.
db_node_ids Sequence[str]: The OCID of the Db nodes associated with the Db server.
db_node_storage_size_in_gbs int: The allocated local node storage in GBs on the Db server.
db_server_patching_details Sequence[database.GetDbServersDbServerDbServerPatchingDetail]: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
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.
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
exadata_infrastructure_id str: The OCID of the ExadataInfrastructure.
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 OCID of the Exacc Db server.
lifecycle_details str: Additional information about the current lifecycle state.
max_cpu_count int: The total number of CPU cores available.
max_db_node_storage_in_gbs int: The total local node storage available in GBs.
max_memory_in_gbs int: The total memory available in GBs.
memory_size_in_gbs int: The allocated memory in GBs on the Db server.
shape str: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
state str: A filter to return only resources that match the given lifecycle state exactly.
time_created str: The date and time that the Db Server was created.
vm_cluster_ids Sequence[str]: The OCID of the VM Clusters associated with the Db server.

autonomousVirtualMachineIds List<String>: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
autonomousVmClusterIds List<String>: The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
compartmentId String: The compartment OCID.
computeModel String: The compute model of the Autonomous Database. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.
cpuCoreCount Number: The number of CPU cores enabled on the Db server.
dbNodeIds List<String>: The OCID of the Db nodes associated with the Db server.
dbNodeStorageSizeInGbs Number: The allocated local node storage in GBs on the Db server.
dbServerPatchingDetails List<Property Map>: The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
exadataInfrastructureId String: The OCID of the ExadataInfrastructure.
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 OCID of the Exacc Db server.
lifecycleDetails String: Additional information about the current lifecycle state.
maxCpuCount Number: The total number of CPU cores available.
maxDbNodeStorageInGbs Number: The total local node storage available in GBs.
maxMemoryInGbs Number: The total memory available in GBs.
memorySizeInGbs Number: The allocated memory in GBs on the Db server.
shape String: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
state String: A filter to return only resources that match the given lifecycle state exactly.
timeCreated String: The date and time that the Db Server was created.
vmClusterIds List<String>: The OCID of the VM Clusters associated with the Db server.

GetDbServersDbServerDbServerPatchingDetail

EstimatedPatchDuration int: Estimated time, in minutes, to patch one database server.
PatchingStatus string: The status of the patching operation.
TimePatchingEnded string: The time when the patching operation ended.
TimePatchingStarted string: The time when the patching operation started.

EstimatedPatchDuration int: Estimated time, in minutes, to patch one database server.
PatchingStatus string: The status of the patching operation.
TimePatchingEnded string: The time when the patching operation ended.
TimePatchingStarted string: The time when the patching operation started.

estimatedPatchDuration Integer: Estimated time, in minutes, to patch one database server.
patchingStatus String: The status of the patching operation.
timePatchingEnded String: The time when the patching operation ended.
timePatchingStarted String: The time when the patching operation started.

estimatedPatchDuration number: Estimated time, in minutes, to patch one database server.
patchingStatus string: The status of the patching operation.
timePatchingEnded string: The time when the patching operation ended.
timePatchingStarted string: The time when the patching operation started.

estimated_patch_duration int: Estimated time, in minutes, to patch one database server.
patching_status str: The status of the patching operation.
time_patching_ended str: The time when the patching operation ended.
time_patching_started str: The time when the patching operation started.

estimatedPatchDuration Number: Estimated time, in minutes, to patch one database server.
patchingStatus String: The status of the patching operation.
timePatchingEnded String: The time when the patching operation ended.
timePatchingStarted String: The time when the patching operation started.

GetDbServersFilter

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.

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

pulumi/pulumi-oci

oci.Database.getDbServers

On this page

On this page

Example Usage

Using getDbServers

getDbServers Result

Supporting Types

GetDbServersDbServer

GetDbServersDbServerDbServerPatchingDetail

GetDbServersFilter

Package Details

On this page

On this page