Data Source: oci_database_db_systems
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
data "oci_database_db_systems" "test_db_systems" {
#Required
compartment_id = var.compartment_id
#Optional
availability_domain = var.db_system_availability_domain
backup_id = oci_database_backup.test_backup.id
display_name = var.db_system_display_name
state = var.db_system_state
}
Argument Reference
The following arguments are supported:
availability_domain- (Optional) A filter to return only resources that match the given availability domain exactly.backup_id- (Optional) 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.compartment_id- (Required) The compartment OCID.display_name- (Optional) A filter to return only resources that match the entire display name given. The match is not case sensitive.state- (Optional) A filter to return only resources that match the given lifecycle state exactly.
Attributes Reference
The following attributes are exported:
db_systems- The list of db_systems.
DbSystem Reference
The following attributes are exported:
availability_domain- The name of the availability domain that the DB system is located in.backup_network_nsg_ids- 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- The OCID of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.Subnet Restriction: See the subnet restrictions information for subnetId.
cluster_name- 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- The OCID of the compartment.cpu_core_count- The number of CPU cores enabled on the DB system.data_collection_options- Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.is_diagnostics_events_enabled- 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 theUpdateVmClusterorupdateCloudVmClusterAPI.is_health_monitoring_enabled- 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 theUpdateVmCluster,UpdateCloudVmClusterorupdateDbsystemAPI.is_incident_logs_enabled- 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 theUpdateVmCluster,updateCloudVmClusterorupdateDbsystemAPI.
data_storage_percentage- 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- 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- The Oracle Database edition that applies to all the databases on the DB system.db_system_options- The DB system options.storage_management- The storage option used in DB system. ASM - Automatic storage management LVM - Logical Volume management
defined_tags- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.disk_redundancy- The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.display_name- The user-friendly name for the DB system. The name does not have to be unique.domain- The domain name for the DB system.fault_domains- List of the Fault Domains in which this DB system is provisioned.freeform_tags- 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- The hostname for the DB system.id- The OCID of the DB system.kms_key_id- The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.last_maintenance_run_id- The OCID of the last maintenance run.last_patch_history_entry_id- The OCID of the last patch history. This value is updated as soon as a patch operation starts.license_model- The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.lifecycle_details- Additional information about the current lifecycle state.listener_port- The port number configured for the listener on the DB system.maintenance_window- The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.custom_action_timeout_in_mins- 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_week- Days during the week when maintenance should be performed.name- Name of the day of the week.
hours_of_day- 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- If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.is_monthly_patching_enabled- If true, enables the monthly patching option.lead_time_in_weeks- 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- Months during the year when maintenance should be performed.name- Name of the month of the year.
patching_mode- Cloud Exadata infrastructure node patching method, either “ROLLING” or “NONROLLING”. Default value is ROLLING.IMPORTANT: Non-rolling infrastructure patching involves system down time. See Oracle-Managed Infrastructure Maintenance Updates for more information.
preference- The maintenance window scheduling preference.weeks_of_month- 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.
memory_size_in_gbs- Memory allocated to the DB system, in gigabytes.next_maintenance_run_id- The OCID of the next maintenance run.node_count- The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.nsg_ids- 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- The most recent OS Patch Version applied on the DB system.point_in_time_data_disk_clone_timestamp- 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.reco_storage_size_in_gb- 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- The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.scan_dns_record_id- The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.scan_ip_ids- The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.Note: For a single-node DB system, this list is empty.
shape- 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_db_system_id- The OCID of the DB system.sparse_diskgroup- True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. Only applied for Exadata shape.ssh_public_keys- The public key portion of one or more key pairs used for SSH access to the DB system.state- The current state of the DB system.storage_volume_performance_mode- The block storage volume performance level. Valid values areBALANCEDandHIGH_PERFORMANCE. See Block Volume Performance for more information.subnet_id- The OCID of the subnet the DB system is associated with.Subnet Restrictions:
- For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16⁄28.
- For Exadata and virtual machine 2-node RAC DB systems, do not use a subnet that overlaps with 192.168.128.0/20.
These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.
time_created- The date and time the DB system was created.time_zone- The time zone of the DB system. For details, see DB System Time Zones.version- The Oracle Database version of the DB system.vip_ids- The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.Note: For a single-node DB system, this list is empty.
zone_id- The OCID of the zone the DB system is associated with.