Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. getDbSystems
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.Database.getDbSystems

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides the list of Db Systems in Oracle Cloud Infrastructure Database service.

Lists the DB systems in the specified compartment. You can specify a backupId to list only the DB systems that support creating a database using this backup in this compartment.

Note: Deprecated for Exadata Cloud Service systems. Use the new resource model APIs instead.

For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See Switching an Exadata DB System to the New Resource Model and APIs for details on converting existing Exadata DB systems to the new resource model.

Example Usage

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

const testDbSystems = oci.Database.getDbSystems({
    compartmentId: compartmentId,
    availabilityDomain: dbSystemAvailabilityDomain,
    backupId: testBackup.id,
    displayName: dbSystemDisplayName,
    state: dbSystemState,
});
Copy
import pulumi
import pulumi_oci as oci

test_db_systems = oci.Database.get_db_systems(compartment_id=compartment_id,
    availability_domain=db_system_availability_domain,
    backup_id=test_backup["id"],
    display_name=db_system_display_name,
    state=db_system_state)
Copy
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.GetDbSystems(ctx, &database.GetDbSystemsArgs{
			CompartmentId:      compartmentId,
			AvailabilityDomain: pulumi.StringRef(dbSystemAvailabilityDomain),
			BackupId:           pulumi.StringRef(testBackup.Id),
			DisplayName:        pulumi.StringRef(dbSystemDisplayName),
			State:              pulumi.StringRef(dbSystemState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDbSystems = Oci.Database.GetDbSystems.Invoke(new()
    {
        CompartmentId = compartmentId,
        AvailabilityDomain = dbSystemAvailabilityDomain,
        BackupId = testBackup.Id,
        DisplayName = dbSystemDisplayName,
        State = dbSystemState,
    });

});
Copy
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.GetDbSystemsArgs;
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 testDbSystems = DatabaseFunctions.getDbSystems(GetDbSystemsArgs.builder()
            .compartmentId(compartmentId)
            .availabilityDomain(dbSystemAvailabilityDomain)
            .backupId(testBackup.id())
            .displayName(dbSystemDisplayName)
            .state(dbSystemState)
            .build());

    }
}
Copy
variables:
  testDbSystems:
    fn::invoke:
      function: oci:Database:getDbSystems
      arguments:
        compartmentId: ${compartmentId}
        availabilityDomain: ${dbSystemAvailabilityDomain}
        backupId: ${testBackup.id}
        displayName: ${dbSystemDisplayName}
        state: ${dbSystemState}
Copy

Using getDbSystems

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 getDbSystems(args: GetDbSystemsArgs, opts?: InvokeOptions): Promise<GetDbSystemsResult>
function getDbSystemsOutput(args: GetDbSystemsOutputArgs, opts?: InvokeOptions): Output<GetDbSystemsResult>
Copy
def get_db_systems(availability_domain: Optional[str] = None,
                   backup_id: Optional[str] = None,
                   compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   filters: Optional[Sequence[_database.GetDbSystemsFilter]] = None,
                   state: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDbSystemsResult
def get_db_systems_output(availability_domain: Optional[pulumi.Input[str]] = None,
                   backup_id: Optional[pulumi.Input[str]] = None,
                   compartment_id: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_database.GetDbSystemsFilterArgs]]]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDbSystemsResult]
Copy
func GetDbSystems(ctx *Context, args *GetDbSystemsArgs, opts ...InvokeOption) (*GetDbSystemsResult, error)
func GetDbSystemsOutput(ctx *Context, args *GetDbSystemsOutputArgs, opts ...InvokeOption) GetDbSystemsResultOutput
Copy

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

public static class GetDbSystems 
{
    public static Task<GetDbSystemsResult> InvokeAsync(GetDbSystemsArgs args, InvokeOptions? opts = null)
    public static Output<GetDbSystemsResult> Invoke(GetDbSystemsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDbSystemsResult> getDbSystems(GetDbSystemsArgs args, InvokeOptions options)
public static Output<GetDbSystemsResult> getDbSystems(GetDbSystemsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Database/getDbSystems:getDbSystems
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The compartment OCID.
AvailabilityDomain string
A filter to return only resources that match the given availability domain exactly.
BackupId string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
DisplayName string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters Changes to this property will trigger replacement. List<GetDbSystemsFilter>
State string
A filter to return only resources that match the given lifecycle state exactly.
CompartmentId This property is required. string
The compartment OCID.
AvailabilityDomain string
A filter to return only resources that match the given availability domain exactly.
BackupId string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
DisplayName string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters Changes to this property will trigger replacement. []GetDbSystemsFilter
State string
A filter to return only resources that match the given lifecycle state exactly.
compartmentId This property is required. String
The compartment OCID.
availabilityDomain String
A filter to return only resources that match the given availability domain exactly.
backupId String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
displayName String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. List<GetDbSystemsFilter>
state String
A filter to return only resources that match the given lifecycle state exactly.
compartmentId This property is required. string
The compartment OCID.
availabilityDomain string
A filter to return only resources that match the given availability domain exactly.
backupId string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
displayName string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. GetDbSystemsFilter[]
state string
A filter to return only resources that match the given lifecycle state exactly.
compartment_id This property is required. str
The compartment OCID.
availability_domain str
A filter to return only resources that match the given availability domain exactly.
backup_id str
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
display_name str
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. Sequence[database.GetDbSystemsFilter]
state str
A filter to return only resources that match the given lifecycle state exactly.
compartmentId This property is required. String
The compartment OCID.
availabilityDomain String
A filter to return only resources that match the given availability domain exactly.
backupId String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
displayName String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Changes to this property will trigger replacement. List<Property Map>
state String
A filter to return only resources that match the given lifecycle state exactly.

getDbSystems Result

The following output properties are available:

CompartmentId string
The OCID of the compartment.
DbSystems List<GetDbSystemsDbSystem>
The list of db_systems.
Id string
The provider-assigned unique ID for this managed resource.
AvailabilityDomain string
The name of the availability domain that the DB system is located in.
BackupId string
DisplayName string
The user-friendly name for the DB system. The name does not have to be unique.
Filters List<GetDbSystemsFilter>
State string
The current state of the DB system.
CompartmentId string
The OCID of the compartment.
DbSystems []GetDbSystemsDbSystem
The list of db_systems.
Id string
The provider-assigned unique ID for this managed resource.
AvailabilityDomain string
The name of the availability domain that the DB system is located in.
BackupId string
DisplayName string
The user-friendly name for the DB system. The name does not have to be unique.
Filters []GetDbSystemsFilter
State string
The current state of the DB system.
compartmentId String
The OCID of the compartment.
dbSystems List<GetDbSystemsDbSystem>
The list of db_systems.
id String
The provider-assigned unique ID for this managed resource.
availabilityDomain String
The name of the availability domain that the DB system is located in.
backupId String
displayName String
The user-friendly name for the DB system. The name does not have to be unique.
filters List<GetDbSystemsFilter>
state String
The current state of the DB system.
compartmentId string
The OCID of the compartment.
dbSystems GetDbSystemsDbSystem[]
The list of db_systems.
id string
The provider-assigned unique ID for this managed resource.
availabilityDomain string
The name of the availability domain that the DB system is located in.
backupId string
displayName string
The user-friendly name for the DB system. The name does not have to be unique.
filters GetDbSystemsFilter[]
state string
The current state of the DB system.
compartment_id str
The OCID of the compartment.
db_systems Sequence[database.GetDbSystemsDbSystem]
The list of db_systems.
id str
The provider-assigned unique ID for this managed resource.
availability_domain str
The name of the availability domain that the DB system is located in.
backup_id str
display_name str
The user-friendly name for the DB system. The name does not have to be unique.
filters Sequence[database.GetDbSystemsFilter]
state str
The current state of the DB system.
compartmentId String
The OCID of the compartment.
dbSystems List<Property Map>
The list of db_systems.
id String
The provider-assigned unique ID for this managed resource.
availabilityDomain String
The name of the availability domain that the DB system is located in.
backupId String
displayName String
The user-friendly name for the DB system. The name does not have to be unique.
filters List<Property Map>
state String
The current state of the DB system.

Supporting Types

GetDbSystemsDbSystem

AvailabilityDomain This property is required. string
A filter to return only resources that match the given availability domain exactly.
BackupNetworkNsgIds This property is required. List<string>
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
BackupSubnetId This property is required. string
The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
ClusterName This property is required. string
The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
CompartmentId This property is required. string
The compartment OCID.
CpuCoreCount This property is required. int
The number of CPU cores enabled on the DB system.
DataCollectionOptions This property is required. List<GetDbSystemsDbSystemDataCollectionOption>
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
DataStoragePercentage This property is required. int
The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
DataStorageSizeInGb This property is required. int
The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Required for VMDBs.
DatabaseEdition This property is required. string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DbHomes This property is required. List<GetDbSystemsDbSystemDbHome>
DbSystemOptions This property is required. List<GetDbSystemsDbSystemDbSystemOption>
The DB system options.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DiskRedundancy This property is required. string
The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
Domain This property is required. string
The domain name for the DB system.
FaultDomains This property is required. List<string>
List of the Fault Domains in which this DB system is provisioned.
FreeformTags This property is required. 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"}
Hostname This property is required. string
The hostname for the DB system.
Id This property is required. string
The OCID of the DB system.
IormConfigCaches This property is required. List<GetDbSystemsDbSystemIormConfigCach>
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LastMaintenanceRunId This property is required. string
The OCID of the last maintenance run.
LastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
LicenseModel This property is required. string
The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
ListenerPort This property is required. int
The port number configured for the listener on the DB system.
MaintenanceWindowDetails This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDetail>
MaintenanceWindows This property is required. List<GetDbSystemsDbSystemMaintenanceWindow>
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
MemorySizeInGbs This property is required. int
Memory allocated to the DB system, in gigabytes.
NextMaintenanceRunId This property is required. string
The OCID of the next maintenance run.
NodeCount This property is required. int
The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
NsgIds This property is required. List<string>
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
OsVersion This property is required. string
The most recent OS Patch Version applied on the DB system.
PointInTimeDataDiskCloneTimestamp This property is required. string
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
PrivateIp This property is required. string
PrivateIpV6 This property is required. string
RecoStorageSizeInGb This property is required. int
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
ScanDnsName This property is required. string
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanDnsRecordId This property is required. string
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanIpIds This property is required. List<string>
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
ScanIpv6ids This property is required. List<string>
The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
SecurityAttributes This property is required. Dictionary<string, string>
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
Shape This property is required. string
The shape of the DB system. The shape determines resources to allocate to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, storage, and memory
Source This property is required. string
SourceDbSystemId This property is required. string
The OCID of the DB system.
SparseDiskgroup This property is required. bool
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape.
SshPublicKeys This property is required. List<string>
The public key portion of one or more key pairs used for SSH access to the DB system.
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
StorageVolumePerformanceMode This property is required. string
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.
SubnetId This property is required. string
The OCID of the subnet the DB system is associated with.
TimeCreated This property is required. string
The date and time the DB system was created.
TimeZone This property is required. string
The time zone of the DB system. For details, see DB System Time Zones.
Version This property is required. string
The Oracle Database version of the DB system.
VipIds This property is required. List<string>
The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
Vipv6ids This property is required. List<string>
The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
ZoneId This property is required. string
The OCID of the zone the DB system is associated with.
AvailabilityDomain This property is required. string
A filter to return only resources that match the given availability domain exactly.
BackupNetworkNsgIds This property is required. []string
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
BackupSubnetId This property is required. string
The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
ClusterName This property is required. string
The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
CompartmentId This property is required. string
The compartment OCID.
CpuCoreCount This property is required. int
The number of CPU cores enabled on the DB system.
DataCollectionOptions This property is required. []GetDbSystemsDbSystemDataCollectionOption
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
DataStoragePercentage This property is required. int
The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
DataStorageSizeInGb This property is required. int
The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Required for VMDBs.
DatabaseEdition This property is required. string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
DbHomes This property is required. []GetDbSystemsDbSystemDbHome
DbSystemOptions This property is required. []GetDbSystemsDbSystemDbSystemOption
The DB system options.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DiskRedundancy This property is required. string
The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
Domain This property is required. string
The domain name for the DB system.
FaultDomains This property is required. []string
List of the Fault Domains in which this DB system is provisioned.
FreeformTags This property is required. 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"}
Hostname This property is required. string
The hostname for the DB system.
Id This property is required. string
The OCID of the DB system.
IormConfigCaches This property is required. []GetDbSystemsDbSystemIormConfigCach
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LastMaintenanceRunId This property is required. string
The OCID of the last maintenance run.
LastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
LicenseModel This property is required. string
The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
ListenerPort This property is required. int
The port number configured for the listener on the DB system.
MaintenanceWindowDetails This property is required. []GetDbSystemsDbSystemMaintenanceWindowDetail
MaintenanceWindows This property is required. []GetDbSystemsDbSystemMaintenanceWindow
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
MemorySizeInGbs This property is required. int
Memory allocated to the DB system, in gigabytes.
NextMaintenanceRunId This property is required. string
The OCID of the next maintenance run.
NodeCount This property is required. int
The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
NsgIds This property is required. []string
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
OsVersion This property is required. string
The most recent OS Patch Version applied on the DB system.
PointInTimeDataDiskCloneTimestamp This property is required. string
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
PrivateIp This property is required. string
PrivateIpV6 This property is required. string
RecoStorageSizeInGb This property is required. int
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
ScanDnsName This property is required. string
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanDnsRecordId This property is required. string
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
ScanIpIds This property is required. []string
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
ScanIpv6ids This property is required. []string
The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
SecurityAttributes This property is required. map[string]string
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
Shape This property is required. string
The shape of the DB system. The shape determines resources to allocate to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, storage, and memory
Source This property is required. string
SourceDbSystemId This property is required. string
The OCID of the DB system.
SparseDiskgroup This property is required. bool
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape.
SshPublicKeys This property is required. []string
The public key portion of one or more key pairs used for SSH access to the DB system.
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
StorageVolumePerformanceMode This property is required. string
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.
SubnetId This property is required. string
The OCID of the subnet the DB system is associated with.
TimeCreated This property is required. string
The date and time the DB system was created.
TimeZone This property is required. string
The time zone of the DB system. For details, see DB System Time Zones.
Version This property is required. string
The Oracle Database version of the DB system.
VipIds This property is required. []string
The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
Vipv6ids This property is required. []string
The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
ZoneId This property is required. string
The OCID of the zone the DB system is associated with.
availabilityDomain This property is required. String
A filter to return only resources that match the given availability domain exactly.
backupNetworkNsgIds This property is required. List<String>
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
backupSubnetId This property is required. String
The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
clusterName This property is required. String
The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
compartmentId This property is required. String
The compartment OCID.
cpuCoreCount This property is required. Integer
The number of CPU cores enabled on the DB system.
dataCollectionOptions This property is required. List<GetDbSystemsDbSystemDataCollectionOption>
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
dataStoragePercentage This property is required. Integer
The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
dataStorageSizeInGb This property is required. Integer
The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Required for VMDBs.
databaseEdition This property is required. String
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
dbHomes This property is required. List<GetDbSystemsDbSystemDbHome>
dbSystemOptions This property is required. List<GetDbSystemsDbSystemDbSystemOption>
The DB system options.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
diskRedundancy This property is required. String
The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
displayName This property is required. String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
domain This property is required. String
The domain name for the DB system.
faultDomains This property is required. List<String>
List of the Fault Domains in which this DB system is provisioned.
freeformTags This property is required. 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"}
hostname This property is required. String
The hostname for the DB system.
id This property is required. String
The OCID of the DB system.
iormConfigCaches This property is required. List<GetDbSystemsDbSystemIormConfigCach>
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lastMaintenanceRunId This property is required. String
The OCID of the last maintenance run.
lastPatchHistoryEntryId This property is required. String
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
licenseModel This property is required. String
The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
listenerPort This property is required. Integer
The port number configured for the listener on the DB system.
maintenanceWindowDetails This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDetail>
maintenanceWindows This property is required. List<GetDbSystemsDbSystemMaintenanceWindow>
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memorySizeInGbs This property is required. Integer
Memory allocated to the DB system, in gigabytes.
nextMaintenanceRunId This property is required. String
The OCID of the next maintenance run.
nodeCount This property is required. Integer
The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
nsgIds This property is required. List<String>
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
osVersion This property is required. String
The most recent OS Patch Version applied on the DB system.
pointInTimeDataDiskCloneTimestamp This property is required. String
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
privateIp This property is required. String
privateIpV6 This property is required. String
recoStorageSizeInGb This property is required. Integer
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
scanDnsName This property is required. String
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanDnsRecordId This property is required. String
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIpIds This property is required. List<String>
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scanIpv6ids This property is required. List<String>
The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
securityAttributes This property is required. Map<String,String>
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
shape This property is required. String
The shape of the DB system. The shape determines resources to allocate to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, storage, and memory
source This property is required. String
sourceDbSystemId This property is required. String
The OCID of the DB system.
sparseDiskgroup This property is required. Boolean
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape.
sshPublicKeys This property is required. List<String>
The public key portion of one or more key pairs used for SSH access to the DB system.
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
storageVolumePerformanceMode This property is required. String
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.
subnetId This property is required. String
The OCID of the subnet the DB system is associated with.
timeCreated This property is required. String
The date and time the DB system was created.
timeZone This property is required. String
The time zone of the DB system. For details, see DB System Time Zones.
version This property is required. String
The Oracle Database version of the DB system.
vipIds This property is required. List<String>
The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids This property is required. List<String>
The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zoneId This property is required. String
The OCID of the zone the DB system is associated with.
availabilityDomain This property is required. string
A filter to return only resources that match the given availability domain exactly.
backupNetworkNsgIds This property is required. string[]
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
backupSubnetId This property is required. string
The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
clusterName This property is required. string
The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
compartmentId This property is required. string
The compartment OCID.
cpuCoreCount This property is required. number
The number of CPU cores enabled on the DB system.
dataCollectionOptions This property is required. GetDbSystemsDbSystemDataCollectionOption[]
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
dataStoragePercentage This property is required. number
The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
dataStorageSizeInGb This property is required. number
The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Required for VMDBs.
databaseEdition This property is required. string
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
dbHomes This property is required. GetDbSystemsDbSystemDbHome[]
dbSystemOptions This property is required. GetDbSystemsDbSystemDbSystemOption[]
The DB system options.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
diskRedundancy This property is required. string
The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
displayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
domain This property is required. string
The domain name for the DB system.
faultDomains This property is required. string[]
List of the Fault Domains in which this DB system is provisioned.
freeformTags This property is required. {[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"}
hostname This property is required. string
The hostname for the DB system.
id This property is required. string
The OCID of the DB system.
iormConfigCaches This property is required. GetDbSystemsDbSystemIormConfigCach[]
kmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. string
lastMaintenanceRunId This property is required. string
The OCID of the last maintenance run.
lastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
licenseModel This property is required. string
The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
lifecycleDetails This property is required. string
Additional information about the current lifecycle state.
listenerPort This property is required. number
The port number configured for the listener on the DB system.
maintenanceWindowDetails This property is required. GetDbSystemsDbSystemMaintenanceWindowDetail[]
maintenanceWindows This property is required. GetDbSystemsDbSystemMaintenanceWindow[]
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memorySizeInGbs This property is required. number
Memory allocated to the DB system, in gigabytes.
nextMaintenanceRunId This property is required. string
The OCID of the next maintenance run.
nodeCount This property is required. number
The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
nsgIds This property is required. string[]
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
osVersion This property is required. string
The most recent OS Patch Version applied on the DB system.
pointInTimeDataDiskCloneTimestamp This property is required. string
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
privateIp This property is required. string
privateIpV6 This property is required. string
recoStorageSizeInGb This property is required. number
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
scanDnsName This property is required. string
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanDnsRecordId This property is required. string
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIpIds This property is required. string[]
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scanIpv6ids This property is required. string[]
The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
securityAttributes This property is required. {[key: string]: string}
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
shape This property is required. string
The shape of the DB system. The shape determines resources to allocate to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, storage, and memory
source This property is required. string
sourceDbSystemId This property is required. string
The OCID of the DB system.
sparseDiskgroup This property is required. boolean
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape.
sshPublicKeys This property is required. string[]
The public key portion of one or more key pairs used for SSH access to the DB system.
state This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
storageVolumePerformanceMode This property is required. string
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.
subnetId This property is required. string
The OCID of the subnet the DB system is associated with.
timeCreated This property is required. string
The date and time the DB system was created.
timeZone This property is required. string
The time zone of the DB system. For details, see DB System Time Zones.
version This property is required. string
The Oracle Database version of the DB system.
vipIds This property is required. string[]
The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids This property is required. string[]
The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zoneId This property is required. string
The OCID of the zone the DB system is associated with.
availability_domain This property is required. str
A filter to return only resources that match the given availability domain exactly.
backup_network_nsg_ids This property is required. Sequence[str]
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
backup_subnet_id This property is required. str
The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
cluster_name This property is required. str
The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
compartment_id This property is required. str
The compartment OCID.
cpu_core_count This property is required. int
The number of CPU cores enabled on the DB system.
data_collection_options This property is required. Sequence[database.GetDbSystemsDbSystemDataCollectionOption]
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
data_storage_percentage This property is required. int
The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
data_storage_size_in_gb This property is required. int
The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Required for VMDBs.
database_edition This property is required. str
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
db_homes This property is required. Sequence[database.GetDbSystemsDbSystemDbHome]
db_system_options This property is required. Sequence[database.GetDbSystemsDbSystemDbSystemOption]
The DB system options.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
disk_redundancy This property is required. str
The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
display_name This property is required. str
A filter to return only resources that match the entire display name given. The match is not case sensitive.
domain This property is required. str
The domain name for the DB system.
fault_domains This property is required. Sequence[str]
List of the Fault Domains in which this DB system is provisioned.
freeform_tags This property is required. 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"}
hostname This property is required. str
The hostname for the DB system.
id This property is required. str
The OCID of the DB system.
iorm_config_caches This property is required. Sequence[database.GetDbSystemsDbSystemIormConfigCach]
kms_key_id This property is required. str
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id This property is required. str
last_maintenance_run_id This property is required. str
The OCID of the last maintenance run.
last_patch_history_entry_id This property is required. str
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
license_model This property is required. str
The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
lifecycle_details This property is required. str
Additional information about the current lifecycle state.
listener_port This property is required. int
The port number configured for the listener on the DB system.
maintenance_window_details This property is required. Sequence[database.GetDbSystemsDbSystemMaintenanceWindowDetail]
maintenance_windows This property is required. Sequence[database.GetDbSystemsDbSystemMaintenanceWindow]
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memory_size_in_gbs This property is required. int
Memory allocated to the DB system, in gigabytes.
next_maintenance_run_id This property is required. str
The OCID of the next maintenance run.
node_count This property is required. int
The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
nsg_ids This property is required. Sequence[str]
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
os_version This property is required. str
The most recent OS Patch Version applied on the DB system.
point_in_time_data_disk_clone_timestamp This property is required. str
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
private_ip This property is required. str
private_ip_v6 This property is required. str
reco_storage_size_in_gb This property is required. int
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
scan_dns_name This property is required. str
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scan_dns_record_id This property is required. str
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scan_ip_ids This property is required. Sequence[str]
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scan_ipv6ids This property is required. Sequence[str]
The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
security_attributes This property is required. Mapping[str, str]
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
shape This property is required. str
The shape of the DB system. The shape determines resources to allocate to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, storage, and memory
source This property is required. str
source_db_system_id This property is required. str
The OCID of the DB system.
sparse_diskgroup This property is required. bool
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape.
ssh_public_keys This property is required. Sequence[str]
The public key portion of one or more key pairs used for SSH access to the DB system.
state This property is required. str
A filter to return only resources that match the given lifecycle state exactly.
storage_volume_performance_mode This property is required. str
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.
subnet_id This property is required. str
The OCID of the subnet the DB system is associated with.
time_created This property is required. str
The date and time the DB system was created.
time_zone This property is required. str
The time zone of the DB system. For details, see DB System Time Zones.
version This property is required. str
The Oracle Database version of the DB system.
vip_ids This property is required. Sequence[str]
The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids This property is required. Sequence[str]
The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zone_id This property is required. str
The OCID of the zone the DB system is associated with.
availabilityDomain This property is required. String
A filter to return only resources that match the given availability domain exactly.
backupNetworkNsgIds This property is required. List<String>
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to. Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.
backupSubnetId This property is required. String
The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
clusterName This property is required. String
The cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
compartmentId This property is required. String
The compartment OCID.
cpuCoreCount This property is required. Number
The number of CPU cores enabled on the DB system.
dataCollectionOptions This property is required. List<Property Map>
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
dataStoragePercentage This property is required. Number
The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems. Required for BMDBs.
dataStorageSizeInGb This property is required. Number
The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. Required for VMDBs.
databaseEdition This property is required. String
The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require ENTERPRISE_EDITION_EXTREME_PERFORMANCE.
dbHomes This property is required. List<Property Map>
dbSystemOptions This property is required. List<Property Map>
The DB system options.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
diskRedundancy This property is required. String
The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
displayName This property is required. String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
domain This property is required. String
The domain name for the DB system.
faultDomains This property is required. List<String>
List of the Fault Domains in which this DB system is provisioned.
freeformTags This property is required. 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"}
hostname This property is required. String
The hostname for the DB system.
id This property is required. String
The OCID of the DB system.
iormConfigCaches This property is required. List<Property Map>
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lastMaintenanceRunId This property is required. String
The OCID of the last maintenance run.
lastPatchHistoryEntryId This property is required. String
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
licenseModel This property is required. String
The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
listenerPort This property is required. Number
The port number configured for the listener on the DB system.
maintenanceWindowDetails This property is required. List<Property Map>
maintenanceWindows This property is required. List<Property Map>
The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
memorySizeInGbs This property is required. Number
Memory allocated to the DB system, in gigabytes.
nextMaintenanceRunId This property is required. String
The OCID of the next maintenance run.
nodeCount This property is required. Number
The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
nsgIds This property is required. List<String>
The list of OCIDs for the network security groups (NSGs) to which this resource belongs. Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions:

  • A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.
osVersion This property is required. String
The most recent OS Patch Version applied on the DB system.
pointInTimeDataDiskCloneTimestamp This property is required. String
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.
privateIp This property is required. String
privateIpV6 This property is required. String
recoStorageSizeInGb This property is required. Number
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems.
scanDnsName This property is required. String
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanDnsRecordId This property is required. String
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIpIds This property is required. List<String>
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system. SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
scanIpv6ids This property is required. List<String>
The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system. SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.
securityAttributes This property is required. Map<String>
Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}
shape This property is required. String
The shape of the DB system. The shape determines resources to allocate to the DB system.

  • For virtual machine shapes, the number of CPU cores and memory
  • For bare metal and Exadata shapes, the number of CPU cores, storage, and memory
source This property is required. String
sourceDbSystemId This property is required. String
The OCID of the DB system.
sparseDiskgroup This property is required. Boolean
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape.
sshPublicKeys This property is required. List<String>
The public key portion of one or more key pairs used for SSH access to the DB system.
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
storageVolumePerformanceMode This property is required. String
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.
subnetId This property is required. String
The OCID of the subnet the DB system is associated with.
timeCreated This property is required. String
The date and time the DB system was created.
timeZone This property is required. String
The time zone of the DB system. For details, see DB System Time Zones.
version This property is required. String
The Oracle Database version of the DB system.
vipIds This property is required. List<String>
The OCID of the virtual IPv4 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 is reassigned to another active node in the cluster.
vipv6ids This property is required. List<String>
The OCID of the virtual IPv6 (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
zoneId This property is required. String
The OCID of the zone the DB system is associated with.

GetDbSystemsDbSystemDataCollectionOption

IsDiagnosticsEventsEnabled This property is required. bool
Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
IsHealthMonitoringEnabled This property is required. bool
Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
IsIncidentLogsEnabled This property is required. bool
Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.
IsDiagnosticsEventsEnabled This property is required. bool
Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
IsHealthMonitoringEnabled This property is required. bool
Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
IsIncidentLogsEnabled This property is required. bool
Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.
isDiagnosticsEventsEnabled This property is required. Boolean
Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled This property is required. Boolean
Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled This property is required. Boolean
Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.
isDiagnosticsEventsEnabled This property is required. boolean
Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled This property is required. boolean
Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled This property is required. boolean
Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.
is_diagnostics_events_enabled This property is required. bool
Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
is_health_monitoring_enabled This property is required. bool
Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
is_incident_logs_enabled This property is required. bool
Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.
isDiagnosticsEventsEnabled This property is required. Boolean
Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. Enabling diagnostic collection allows you to receive Events service notifications for guest VM issues. Diagnostic collection also allows Oracle to provide enhanced service and proactive support for your Exadata system. You can enable diagnostic collection during VM cluster/Cloud VM cluster provisioning. You can also disable or enable it at any time using the UpdateVmCluster or updateCloudVmCluster API.
isHealthMonitoringEnabled This property is required. Boolean
Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling health monitoring allows Oracle to collect diagnostic data and share it with its operations and support personnel. You may also receive notifications for some events. Collecting health diagnostics enables Oracle to provide proactive support and enhanced service for your system. Optionally enable health monitoring while provisioning a system. You can also disable or enable health monitoring anytime using the UpdateVmCluster, UpdateCloudVmCluster or updateDbsystem API.
isIncidentLogsEnabled This property is required. Boolean
Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. Enabling incident logs collection allows Oracle to receive Events service notifications for guest VM issues, collect incident logs and traces, and use them to diagnose issues and resolve them. Optionally enable incident logs collection while provisioning a system. You can also disable or enable incident logs collection anytime using the UpdateVmCluster, updateCloudVmCluster or updateDbsystem API.

GetDbSystemsDbSystemDbHome

CreateAsync This property is required. bool
DatabaseSoftwareImageId This property is required. string
Databases This property is required. List<GetDbSystemsDbSystemDbHomeDatabase>
DbHomeLocation This property is required. string
DbVersion This property is required. string
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
FreeformTags This property is required. 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 This property is required. string
The OCID of the DB system.
IsUnifiedAuditingEnabled This property is required. bool
LastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TimeCreated This property is required. string
The date and time the DB system was created.
CreateAsync This property is required. bool
DatabaseSoftwareImageId This property is required. string
Databases This property is required. []GetDbSystemsDbSystemDbHomeDatabase
DbHomeLocation This property is required. string
DbVersion This property is required. string
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
FreeformTags This property is required. 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 This property is required. string
The OCID of the DB system.
IsUnifiedAuditingEnabled This property is required. bool
LastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TimeCreated This property is required. string
The date and time the DB system was created.
createAsync This property is required. Boolean
databaseSoftwareImageId This property is required. String
databases This property is required. List<GetDbSystemsDbSystemDbHome>
dbHomeLocation This property is required. String
dbVersion This property is required. String
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName This property is required. String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeformTags This property is required. 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 This property is required. String
The OCID of the DB system.
isUnifiedAuditingEnabled This property is required. Boolean
lastPatchHistoryEntryId This property is required. String
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
timeCreated This property is required. String
The date and time the DB system was created.
createAsync This property is required. boolean
databaseSoftwareImageId This property is required. string
databases This property is required. GetDbSystemsDbSystemDbHomeDatabase[]
dbHomeLocation This property is required. string
dbVersion This property is required. string
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName This property is required. string
A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeformTags This property is required. {[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 This property is required. string
The OCID of the DB system.
isUnifiedAuditingEnabled This property is required. boolean
lastPatchHistoryEntryId This property is required. string
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycleDetails This property is required. string
Additional information about the current lifecycle state.
state This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
timeCreated This property is required. string
The date and time the DB system was created.
create_async This property is required. bool
database_software_image_id This property is required. str
databases This property is required. Sequence[database.GetDbSystemsDbSystemDbHomeDatabase]
db_home_location This property is required. str
db_version This property is required. str
defined_tags This property is required. 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 This property is required. str
A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeform_tags This property is required. 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 This property is required. str
The OCID of the DB system.
is_unified_auditing_enabled This property is required. bool
last_patch_history_entry_id This property is required. str
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycle_details This property is required. str
Additional information about the current lifecycle state.
state This property is required. str
A filter to return only resources that match the given lifecycle state exactly.
time_created This property is required. str
The date and time the DB system was created.
createAsync This property is required. Boolean
databaseSoftwareImageId This property is required. String
databases This property is required. List<Property Map>
dbHomeLocation This property is required. String
dbVersion This property is required. String
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
displayName This property is required. String
A filter to return only resources that match the entire display name given. The match is not case sensitive.
freeformTags This property is required. 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 This property is required. String
The OCID of the DB system.
isUnifiedAuditingEnabled This property is required. Boolean
lastPatchHistoryEntryId This property is required. String
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
timeCreated This property is required. String
The date and time the DB system was created.

GetDbSystemsDbSystemDbHomeDatabase

AdminPassword This property is required. string
BackupId This property is required. string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
BackupTdePassword This property is required. string
CharacterSet This property is required. string
ConnectionStrings This property is required. List<GetDbSystemsDbSystemDbHomeDatabaseConnectionString>
DatabaseId This property is required. string
DatabaseSoftwareImageId This property is required. string
DbBackupConfigs This property is required. List<GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfig>
DbDomain This property is required. string
DbName This property is required. string
DbUniqueName This property is required. string
DbWorkload This property is required. string
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags This property is required. 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 This property is required. string
The OCID of the DB system.
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
NcharacterSet This property is required. string
PdbName This property is required. string
PluggableDatabases This property is required. List<string>
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TdeWalletPassword This property is required. string
TimeCreated This property is required. string
The date and time the DB system was created.
TimeStampForPointInTimeRecovery This property is required. string
VaultId This property is required. string
AdminPassword This property is required. string
BackupId This property is required. string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
BackupTdePassword This property is required. string
CharacterSet This property is required. string
ConnectionStrings This property is required. []GetDbSystemsDbSystemDbHomeDatabaseConnectionString
DatabaseId This property is required. string
DatabaseSoftwareImageId This property is required. string
DbBackupConfigs This property is required. []GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfig
DbDomain This property is required. string
DbName This property is required. string
DbUniqueName This property is required. string
DbWorkload This property is required. string
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
FreeformTags This property is required. 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 This property is required. string
The OCID of the DB system.
KmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
KmsKeyVersionId This property is required. string
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
NcharacterSet This property is required. string
PdbName This property is required. string
PluggableDatabases This property is required. []string
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
TdeWalletPassword This property is required. string
TimeCreated This property is required. string
The date and time the DB system was created.
TimeStampForPointInTimeRecovery This property is required. string
VaultId This property is required. string
adminPassword This property is required. String
backupId This property is required. String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backupTdePassword This property is required. String
characterSet This property is required. String
connectionStrings This property is required. List<GetDbSystemsDbSystemDbHomeConnectionString>
databaseId This property is required. String
databaseSoftwareImageId This property is required. String
dbBackupConfigs This property is required. List<GetDbSystemsDbSystemDbHomeDbBackupConfig>
dbDomain This property is required. String
dbName This property is required. String
dbUniqueName This property is required. String
dbWorkload This property is required. String
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags This property is required. 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 This property is required. String
The OCID of the DB system.
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
ncharacterSet This property is required. String
pdbName This property is required. String
pluggableDatabases This property is required. List<String>
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
tdeWalletPassword This property is required. String
timeCreated This property is required. String
The date and time the DB system was created.
timeStampForPointInTimeRecovery This property is required. String
vaultId This property is required. String
adminPassword This property is required. string
backupId This property is required. string
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backupTdePassword This property is required. string
characterSet This property is required. string
connectionStrings This property is required. GetDbSystemsDbSystemDbHomeDatabaseConnectionString[]
databaseId This property is required. string
databaseSoftwareImageId This property is required. string
dbBackupConfigs This property is required. GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfig[]
dbDomain This property is required. string
dbName This property is required. string
dbUniqueName This property is required. string
dbWorkload This property is required. string
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags This property is required. {[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 This property is required. string
The OCID of the DB system.
kmsKeyId This property is required. string
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. string
lifecycleDetails This property is required. string
Additional information about the current lifecycle state.
ncharacterSet This property is required. string
pdbName This property is required. string
pluggableDatabases This property is required. string[]
state This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
tdeWalletPassword This property is required. string
timeCreated This property is required. string
The date and time the DB system was created.
timeStampForPointInTimeRecovery This property is required. string
vaultId This property is required. string
admin_password This property is required. str
backup_id This property is required. str
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backup_tde_password This property is required. str
character_set This property is required. str
connection_strings This property is required. Sequence[database.GetDbSystemsDbSystemDbHomeDatabaseConnectionString]
database_id This property is required. str
database_software_image_id This property is required. str
db_backup_configs This property is required. Sequence[database.GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfig]
db_domain This property is required. str
db_name This property is required. str
db_unique_name This property is required. str
db_workload This property is required. str
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeform_tags This property is required. 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 This property is required. str
The OCID of the DB system.
kms_key_id This property is required. str
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kms_key_version_id This property is required. str
lifecycle_details This property is required. str
Additional information about the current lifecycle state.
ncharacter_set This property is required. str
pdb_name This property is required. str
pluggable_databases This property is required. Sequence[str]
state This property is required. str
A filter to return only resources that match the given lifecycle state exactly.
tde_wallet_password This property is required. str
time_created This property is required. str
The date and time the DB system was created.
time_stamp_for_point_in_time_recovery This property is required. str
vault_id This property is required. str
adminPassword This property is required. String
backupId This property is required. String
The OCID of the backup. Specify a backupId to list only the DB systems or DB homes that support creating a database using this backup in this compartment.
backupTdePassword This property is required. String
characterSet This property is required. String
connectionStrings This property is required. List<Property Map>
databaseId This property is required. String
databaseSoftwareImageId This property is required. String
dbBackupConfigs This property is required. List<Property Map>
dbDomain This property is required. String
dbName This property is required. String
dbUniqueName This property is required. String
dbWorkload This property is required. String
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
freeformTags This property is required. 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 This property is required. String
The OCID of the DB system.
kmsKeyId This property is required. String
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId This property is required. String
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
ncharacterSet This property is required. String
pdbName This property is required. String
pluggableDatabases This property is required. List<String>
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
tdeWalletPassword This property is required. String
timeCreated This property is required. String
The date and time the DB system was created.
timeStampForPointInTimeRecovery This property is required. String
vaultId This property is required. String

GetDbSystemsDbSystemDbHomeDatabaseConnectionString

AllConnectionStrings This property is required. Dictionary<string, string>
CdbDefault This property is required. string
CdbIpDefault This property is required. string
AllConnectionStrings This property is required. map[string]string
CdbDefault This property is required. string
CdbIpDefault This property is required. string
allConnectionStrings This property is required. Map<String,String>
cdbDefault This property is required. String
cdbIpDefault This property is required. String
allConnectionStrings This property is required. {[key: string]: string}
cdbDefault This property is required. string
cdbIpDefault This property is required. string
all_connection_strings This property is required. Mapping[str, str]
cdb_default This property is required. str
cdb_ip_default This property is required. str
allConnectionStrings This property is required. Map<String>
cdbDefault This property is required. String
cdbIpDefault This property is required. String

GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfig

AutoBackupEnabled This property is required. bool
AutoBackupWindow This property is required. string
AutoFullBackupDay This property is required. string
AutoFullBackupWindow This property is required. string
BackupDeletionPolicy This property is required. string
BackupDestinationDetails This property is required. List<GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail>
RecoveryWindowInDays This property is required. int
RunImmediateFullBackup This property is required. bool
AutoBackupEnabled This property is required. bool
AutoBackupWindow This property is required. string
AutoFullBackupDay This property is required. string
AutoFullBackupWindow This property is required. string
BackupDeletionPolicy This property is required. string
BackupDestinationDetails This property is required. []GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail
RecoveryWindowInDays This property is required. int
RunImmediateFullBackup This property is required. bool
autoBackupEnabled This property is required. Boolean
autoBackupWindow This property is required. String
autoFullBackupDay This property is required. String
autoFullBackupWindow This property is required. String
backupDeletionPolicy This property is required. String
backupDestinationDetails This property is required. List<GetDbSystemsDbSystemDbHomeDbBackupConfigBackupDestinationDetail>
recoveryWindowInDays This property is required. Integer
runImmediateFullBackup This property is required. Boolean
autoBackupEnabled This property is required. boolean
autoBackupWindow This property is required. string
autoFullBackupDay This property is required. string
autoFullBackupWindow This property is required. string
backupDeletionPolicy This property is required. string
backupDestinationDetails This property is required. GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail[]
recoveryWindowInDays This property is required. number
runImmediateFullBackup This property is required. boolean
auto_backup_enabled This property is required. bool
auto_backup_window This property is required. str
auto_full_backup_day This property is required. str
auto_full_backup_window This property is required. str
backup_deletion_policy This property is required. str
backup_destination_details This property is required. Sequence[database.GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail]
recovery_window_in_days This property is required. int
run_immediate_full_backup This property is required. bool
autoBackupEnabled This property is required. Boolean
autoBackupWindow This property is required. String
autoFullBackupDay This property is required. String
autoFullBackupWindow This property is required. String
backupDeletionPolicy This property is required. String
backupDestinationDetails This property is required. List<Property Map>
recoveryWindowInDays This property is required. Number
runImmediateFullBackup This property is required. Boolean

GetDbSystemsDbSystemDbHomeDatabaseDbBackupConfigBackupDestinationDetail

DbrsPolicyId This property is required. string
Id This property is required. string
The OCID of the DB system.
Type This property is required. string
DbrsPolicyId This property is required. string
Id This property is required. string
The OCID of the DB system.
Type This property is required. string
dbrsPolicyId This property is required. String
id This property is required. String
The OCID of the DB system.
type This property is required. String
dbrsPolicyId This property is required. string
id This property is required. string
The OCID of the DB system.
type This property is required. string
dbrs_policy_id This property is required. str
id This property is required. str
The OCID of the DB system.
type This property is required. str
dbrsPolicyId This property is required. String
id This property is required. String
The OCID of the DB system.
type This property is required. String

GetDbSystemsDbSystemDbSystemOption

StorageManagement This property is required. string
The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
StorageManagement This property is required. string
The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
storageManagement This property is required. String
The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
storageManagement This property is required. string
The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
storage_management This property is required. str
The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
storageManagement This property is required. String
The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management

GetDbSystemsDbSystemIormConfigCach

DbPlans This property is required. List<GetDbSystemsDbSystemIormConfigCachDbPlan>
DbSystemId This property is required. string
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
Objective This property is required. string
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
DbPlans This property is required. []GetDbSystemsDbSystemIormConfigCachDbPlan
DbSystemId This property is required. string
LifecycleDetails This property is required. string
Additional information about the current lifecycle state.
Objective This property is required. string
State This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
dbPlans This property is required. List<GetDbSystemsDbSystemIormConfigCachDbPlan>
dbSystemId This property is required. String
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
objective This property is required. String
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.
dbPlans This property is required. GetDbSystemsDbSystemIormConfigCachDbPlan[]
dbSystemId This property is required. string
lifecycleDetails This property is required. string
Additional information about the current lifecycle state.
objective This property is required. string
state This property is required. string
A filter to return only resources that match the given lifecycle state exactly.
db_plans This property is required. Sequence[database.GetDbSystemsDbSystemIormConfigCachDbPlan]
db_system_id This property is required. str
lifecycle_details This property is required. str
Additional information about the current lifecycle state.
objective This property is required. str
state This property is required. str
A filter to return only resources that match the given lifecycle state exactly.
dbPlans This property is required. List<Property Map>
dbSystemId This property is required. String
lifecycleDetails This property is required. String
Additional information about the current lifecycle state.
objective This property is required. String
state This property is required. String
A filter to return only resources that match the given lifecycle state exactly.

GetDbSystemsDbSystemIormConfigCachDbPlan

DbName This property is required. string
FlashCacheLimit This property is required. string
Share This property is required. int
DbName This property is required. string
FlashCacheLimit This property is required. string
Share This property is required. int
dbName This property is required. String
flashCacheLimit This property is required. String
share This property is required. Integer
dbName This property is required. string
flashCacheLimit This property is required. string
share This property is required. number
db_name This property is required. str
flash_cache_limit This property is required. str
share This property is required. int
dbName This property is required. String
flashCacheLimit This property is required. String
share This property is required. Number

GetDbSystemsDbSystemMaintenanceWindow

CustomActionTimeoutInMins This property is required. int
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
DaysOfWeeks This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek>
Days during the week when maintenance should be performed.
HoursOfDays This property is required. List<int>
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
IsCustomActionTimeoutEnabled This property is required. bool
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
IsMonthlyPatchingEnabled This property is required. bool
If true, enables the monthly patching option.
LeadTimeInWeeks This property is required. int
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
Months This property is required. List<GetDbSystemsDbSystemMaintenanceWindowMonth>
Months during the year when maintenance should be performed.
PatchingMode This property is required. string
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
Preference This property is required. string
The maintenance window scheduling preference.
SkipRus This property is required. List<bool>
WeeksOfMonths This property is required. List<int>
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
CustomActionTimeoutInMins This property is required. int
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
DaysOfWeeks This property is required. []GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek
Days during the week when maintenance should be performed.
HoursOfDays This property is required. []int
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
IsCustomActionTimeoutEnabled This property is required. bool
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
IsMonthlyPatchingEnabled This property is required. bool
If true, enables the monthly patching option.
LeadTimeInWeeks This property is required. int
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
Months This property is required. []GetDbSystemsDbSystemMaintenanceWindowMonth
Months during the year when maintenance should be performed.
PatchingMode This property is required. string
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
Preference This property is required. string
The maintenance window scheduling preference.
SkipRus This property is required. []bool
WeeksOfMonths This property is required. []int
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
customActionTimeoutInMins This property is required. Integer
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
daysOfWeeks This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek>
Days during the week when maintenance should be performed.
hoursOfDays This property is required. List<Integer>
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
isCustomActionTimeoutEnabled This property is required. Boolean
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
isMonthlyPatchingEnabled This property is required. Boolean
If true, enables the monthly patching option.
leadTimeInWeeks This property is required. Integer
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. List<GetDbSystemsDbSystemMaintenanceWindowMonth>
Months during the year when maintenance should be performed.
patchingMode This property is required. String
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. String
The maintenance window scheduling preference.
skipRus This property is required. List<Boolean>
weeksOfMonths This property is required. List<Integer>
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
customActionTimeoutInMins This property is required. number
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
daysOfWeeks This property is required. GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek[]
Days during the week when maintenance should be performed.
hoursOfDays This property is required. number[]
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
isCustomActionTimeoutEnabled This property is required. boolean
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
isMonthlyPatchingEnabled This property is required. boolean
If true, enables the monthly patching option.
leadTimeInWeeks This property is required. number
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. GetDbSystemsDbSystemMaintenanceWindowMonth[]
Months during the year when maintenance should be performed.
patchingMode This property is required. string
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. string
The maintenance window scheduling preference.
skipRus This property is required. boolean[]
weeksOfMonths This property is required. number[]
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
custom_action_timeout_in_mins This property is required. int
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
days_of_weeks This property is required. Sequence[database.GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek]
Days during the week when maintenance should be performed.
hours_of_days This property is required. Sequence[int]
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
is_custom_action_timeout_enabled This property is required. bool
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
is_monthly_patching_enabled This property is required. bool
If true, enables the monthly patching option.
lead_time_in_weeks This property is required. int
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. Sequence[database.GetDbSystemsDbSystemMaintenanceWindowMonth]
Months during the year when maintenance should be performed.
patching_mode This property is required. str
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. str
The maintenance window scheduling preference.
skip_rus This property is required. Sequence[bool]
weeks_of_months This property is required. Sequence[int]
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
customActionTimeoutInMins This property is required. Number
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
daysOfWeeks This property is required. List<Property Map>
Days during the week when maintenance should be performed.
hoursOfDays This property is required. List<Number>
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
isCustomActionTimeoutEnabled This property is required. Boolean
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
isMonthlyPatchingEnabled This property is required. Boolean
If true, enables the monthly patching option.
leadTimeInWeeks This property is required. Number
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. List<Property Map>
Months during the year when maintenance should be performed.
patchingMode This property is required. String
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. String
The maintenance window scheduling preference.
skipRus This property is required. List<Boolean>
weeksOfMonths This property is required. List<Number>
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

GetDbSystemsDbSystemMaintenanceWindowDaysOfWeek

Name This property is required. string
Name of the month of the year.
Name This property is required. string
Name of the month of the year.
name This property is required. String
Name of the month of the year.
name This property is required. string
Name of the month of the year.
name This property is required. str
Name of the month of the year.
name This property is required. String
Name of the month of the year.

GetDbSystemsDbSystemMaintenanceWindowDetail

CustomActionTimeoutInMins This property is required. int
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
DaysOfWeeks This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek>
Days during the week when maintenance should be performed.
HoursOfDays This property is required. List<int>
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
IsCustomActionTimeoutEnabled This property is required. bool
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
IsMonthlyPatchingEnabled This property is required. bool
If true, enables the monthly patching option.
LeadTimeInWeeks This property is required. int
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
Months This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDetailMonth>
Months during the year when maintenance should be performed.
PatchingMode This property is required. string
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
Preference This property is required. string
The maintenance window scheduling preference.
SkipRus This property is required. List<bool>
WeeksOfMonths This property is required. List<int>
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
CustomActionTimeoutInMins This property is required. int
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
DaysOfWeeks This property is required. []GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek
Days during the week when maintenance should be performed.
HoursOfDays This property is required. []int
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
IsCustomActionTimeoutEnabled This property is required. bool
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
IsMonthlyPatchingEnabled This property is required. bool
If true, enables the monthly patching option.
LeadTimeInWeeks This property is required. int
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
Months This property is required. []GetDbSystemsDbSystemMaintenanceWindowDetailMonth
Months during the year when maintenance should be performed.
PatchingMode This property is required. string
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
Preference This property is required. string
The maintenance window scheduling preference.
SkipRus This property is required. []bool
WeeksOfMonths This property is required. []int
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
customActionTimeoutInMins This property is required. Integer
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
daysOfWeeks This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek>
Days during the week when maintenance should be performed.
hoursOfDays This property is required. List<Integer>
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
isCustomActionTimeoutEnabled This property is required. Boolean
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
isMonthlyPatchingEnabled This property is required. Boolean
If true, enables the monthly patching option.
leadTimeInWeeks This property is required. Integer
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. List<GetDbSystemsDbSystemMaintenanceWindowDetailMonth>
Months during the year when maintenance should be performed.
patchingMode This property is required. String
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. String
The maintenance window scheduling preference.
skipRus This property is required. List<Boolean>
weeksOfMonths This property is required. List<Integer>
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
customActionTimeoutInMins This property is required. number
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
daysOfWeeks This property is required. GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek[]
Days during the week when maintenance should be performed.
hoursOfDays This property is required. number[]
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
isCustomActionTimeoutEnabled This property is required. boolean
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
isMonthlyPatchingEnabled This property is required. boolean
If true, enables the monthly patching option.
leadTimeInWeeks This property is required. number
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. GetDbSystemsDbSystemMaintenanceWindowDetailMonth[]
Months during the year when maintenance should be performed.
patchingMode This property is required. string
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. string
The maintenance window scheduling preference.
skipRus This property is required. boolean[]
weeksOfMonths This property is required. number[]
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
custom_action_timeout_in_mins This property is required. int
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
days_of_weeks This property is required. Sequence[database.GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek]
Days during the week when maintenance should be performed.
hours_of_days This property is required. Sequence[int]
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
is_custom_action_timeout_enabled This property is required. bool
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
is_monthly_patching_enabled This property is required. bool
If true, enables the monthly patching option.
lead_time_in_weeks This property is required. int
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. Sequence[database.GetDbSystemsDbSystemMaintenanceWindowDetailMonth]
Months during the year when maintenance should be performed.
patching_mode This property is required. str
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. str
The maintenance window scheduling preference.
skip_rus This property is required. Sequence[bool]
weeks_of_months This property is required. Sequence[int]
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.
customActionTimeoutInMins This property is required. Number
Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).
daysOfWeeks This property is required. List<Property Map>
Days during the week when maintenance should be performed.
hoursOfDays This property is required. List<Number>
The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are

  • 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC
isCustomActionTimeoutEnabled This property is required. Boolean
If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.
isMonthlyPatchingEnabled This property is required. Boolean
If true, enables the monthly patching option.
leadTimeInWeeks This property is required. Number
Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.
months This property is required. List<Property Map>
Months during the year when maintenance should be performed.
patchingMode This property is required. String
Cloud Exadata infrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING.
preference This property is required. String
The maintenance window scheduling preference.
skipRus This property is required. List<Boolean>
weeksOfMonths This property is required. List<Number>
Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed.

GetDbSystemsDbSystemMaintenanceWindowDetailDaysOfWeek

Name This property is required. string
Name of the month of the year.
Name This property is required. string
Name of the month of the year.
name This property is required. String
Name of the month of the year.
name This property is required. string
Name of the month of the year.
name This property is required. str
Name of the month of the year.
name This property is required. String
Name of the month of the year.

GetDbSystemsDbSystemMaintenanceWindowDetailMonth

Name This property is required. string
Name of the month of the year.
Name This property is required. string
Name of the month of the year.
name This property is required. String
Name of the month of the year.
name This property is required. string
Name of the month of the year.
name This property is required. str
Name of the month of the year.
name This property is required. String
Name of the month of the year.

GetDbSystemsDbSystemMaintenanceWindowMonth

Name This property is required. string
Name of the month of the year.
Name This property is required. string
Name of the month of the year.
name This property is required. String
Name of the month of the year.
name This property is required. string
Name of the month of the year.
name This property is required. str
Name of the month of the year.
name This property is required. String
Name of the month of the year.

GetDbSystemsFilter

Name This property is required. string
Name of the month of the year.
Values This property is required. List<string>
Regex bool
Name This property is required. string
Name of the month of the year.
Values This property is required. []string
Regex bool
name This property is required. String
Name of the month of the year.
values This property is required. List<String>
regex Boolean
name This property is required. string
Name of the month of the year.
values This property is required. string[]
regex boolean
name This property is required. str
Name of the month of the year.
values This property is required. Sequence[str]
regex bool
name This property is required. String
Name of the month of the year.
values This property is required. 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.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci