db_systems
Creates, updates, deletes, gets or lists a db_systems resource.
Overview​
| Name | db_systems |
| Type | Resource |
| Id | oci.database.db_systems |
Fields​
The following fields are returned by SELECT queries:
- get
- list
The DB system information was retrieved.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. |
availabilityDomain | string | The name of the availability domain that the DB system is located in. |
backupNetworkNsgIds | array | A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. |
backupSubnetId | string | The [OCID](/Content/General/Concepts/identifiers.htm) 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. |
clusterName | 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 | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
computeCount | integer (int32) | The number of compute servers for the DB system. |
computeModel | string | The compute model for Base Database Service. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. (ECPU, OCPU) |
cpuCoreCount | integer | The number of CPU cores enabled on the DB system. |
dataCollectionOptions | object | Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. |
dataStoragePercentage | 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. |
dataStorageSizeInGBs | integer | The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. |
databaseEdition | 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. (STANDARD_EDITION, ENTERPRISE_EDITION, ENTERPRISE_EDITION_HIGH_PERFORMANCE, ENTERPRISE_EDITION_EXTREME_PERFORMANCE, ENTERPRISE_EDITION_DEVELOPER) |
dbSystemOptions | object | The DB system options. |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
diskRedundancy | string | The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. (HIGH, NORMAL) |
displayName | string | The user-friendly name for the DB system. The name does not have to be unique. |
domain | string | The domain name for the DB system. |
faultDomains | array | List of the Fault Domains in which this DB system is provisioned. |
freeformTags | object | 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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
giSoftwareImageId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type GRID_IMAGE. |
hostname | string | The hostname for the DB system. |
iormConfigCache | object | The IORM settings of the Exadata DB system. |
kmsKeyId | string | The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. |
lastMaintenanceRunId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. |
lastPatchHistoryEntryId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. |
licenseModel | string | The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE) |
lifecycleDetails | string | Additional information about the current lifecycle state. |
lifecycleState | string | The current state of the DB system. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MIGRATED, MAINTENANCE_IN_PROGRESS, NEEDS_ATTENTION, UPGRADING) |
listenerPort | integer | The port number configured for the listener on the DB system. |
maintenanceWindow | object | The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. |
memorySizeInGBs | integer | Memory allocated to the DB system, in gigabytes. (x-default-description: null) |
nextMaintenanceRunId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. |
nodeCount | integer | The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. |
nsgIds | array | The list of [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm). |
pointInTimeDataDiskCloneTimestamp | string (date-time) | 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](https:​//tools.ietf.org/rfc/rfc3339). |
recoStorageSizeInGB | integer | The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. |
scanDnsName | string | The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system. |
scanDnsRecordId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the DB system. |
scanIpIds | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
scanIpv6Ids | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
securityAttributes | object | Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}} |
shape | 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 |
sourceDbSystemId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. |
sparseDiskgroup | boolean | True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. |
sshPublicKeys | array | The public key portion of one or more key pairs used for SSH access to the DB system. |
storageVolumePerformanceMode | string | The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. (BALANCED, HIGH_PERFORMANCE) (default: BALANCED) |
subnetId | string | The [OCID](/Content/General/Concepts/identifiers.htm) 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. |
systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
timeCreated | string (date-time) | The date and time the DB system was created. |
timeZone | string | The time zone of the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). |
version | string | The Oracle Database version of the DB system. |
vipIds | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
vipv6Ids | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
zoneId | string | The OCID of the zone the DB system is associated with. |
The Database Service supports several types of DB systems, ranging in size, price, and performance. For details about<br />each type of system, see [Bare Metal and Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm).<br /><br />Note: Deprecated for Exadata Cloud Service instances using the new [resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model).<br />To provision and manage new Exadata Cloud Service systems, use the<br />[CloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/) and [CloudVmCluster](#/en/database/latest/CloudVmCluster/).<br />See [Exadata Cloud Service](/Content/Database/Concepts/exaoverview.htm) for more information on Exadata systems.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).<br /><br />For information about access control and compartments, see<br />[Overview of the Identity Service](/Content/Identity/Concepts/overview.htm).<br /><br />For information about availability domains, see<br />[Regions and Availability Domains](/Content/General/Concepts/regions.htm).<br /><br />To get a list of availability domains, use the ListAvailabilityDomains operation<br />in the Identity Service API.<br /><br />Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. |
availabilityDomain | string | The name of the availability domain that the DB system is located in. |
backupNetworkNsgIds | array | A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems. |
backupSubnetId | string | The [OCID](/Content/General/Concepts/identifiers.htm) 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. |
clusterName | 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 | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
computeCount | integer (int32) | The number of compute servers for the DB system. |
computeModel | string | The compute model for Base Database Service. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. (ECPU, OCPU) |
cpuCoreCount | integer | The number of CPU cores enabled on the DB system. |
dataCollectionOptions | object | Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. |
dataStoragePercentage | 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. |
dataStorageSizeInGBs | integer | The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems. |
databaseEdition | 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. (STANDARD_EDITION, ENTERPRISE_EDITION, ENTERPRISE_EDITION_HIGH_PERFORMANCE, ENTERPRISE_EDITION_EXTREME_PERFORMANCE, ENTERPRISE_EDITION_DEVELOPER) |
dbSystemOptions | object | The DB system options. |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
diskRedundancy | string | The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. (HIGH, NORMAL) |
displayName | string | The user-friendly name for the DB system. The name does not have to be unique. |
domain | string | The domain name for the DB system. |
faultDomains | array | List of the Fault Domains in which this DB system is provisioned. |
freeformTags | object | 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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
giSoftwareImageId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of a grid infrastructure software image. This is a database software image of the type GRID_IMAGE. |
hostname | string | The hostname for the DB system. |
kmsKeyId | string | The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. |
lastMaintenanceRunId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last maintenance run. |
lastPatchHistoryEntryId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the last patch history. This value is updated as soon as a patch operation starts. |
licenseModel | string | The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED. (LICENSE_INCLUDED, BRING_YOUR_OWN_LICENSE) |
lifecycleDetails | string | Additional information about the current lifecycle state. |
lifecycleState | string | The current state of the DB system. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, MIGRATED, MAINTENANCE_IN_PROGRESS, NEEDS_ATTENTION, UPGRADING) |
listenerPort | integer | The port number configured for the listener on the DB system. |
maintenanceWindow | object | The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. |
memorySizeInGBs | integer | Memory allocated to the DB system, in gigabytes. (x-default-description: null) |
nextMaintenanceRunId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the next maintenance run. |
nodeCount | integer | The number of nodes in the DB system. For RAC DB systems, the value is greater than 1. |
nsgIds | array | The list of [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm). |
pointInTimeDataDiskCloneTimestamp | string (date-time) | 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](https:​//tools.ietf.org/rfc/rfc3339). |
recoStorageSizeInGB | integer | The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system. Applies only for virtual machine DB systems. |
scanDnsName | string | The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system. |
scanDnsRecordId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the DNS record for the SCAN IP addresses that are associated with the DB system. |
scanIpIds | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
scanIpv6Ids | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
securityAttributes | object | Security Attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}} |
shape | 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 |
sourceDbSystemId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system. |
sparseDiskgroup | boolean | True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured. |
sshPublicKeys | array | The public key portion of one or more key pairs used for SSH access to the DB system. |
storageVolumePerformanceMode | string | The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information. (BALANCED, HIGH_PERFORMANCE) (default: BALANCED) |
subnetId | string | The [OCID](/Content/General/Concepts/identifiers.htm) 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. |
systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
timeCreated | string (date-time) | The date and time the DB system was created. |
timeZone | string | The time zone of the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm). |
version | string | The Oracle Database version of the DB system. |
vipIds | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
vipv6Ids | array | The [OCID](/Content/General/Concepts/identifiers.htm) 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. Note: For a single-node DB system, this list is empty. |
zoneId | string | The OCID of the zone the DB system is associated with. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | dbSystemId, region | Gets information about the specified DB system.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br /> | |
list | select | compartmentId, region | limit, page, backupId, sortBy, sortOrder, lifecycleState, availabilityDomain, displayName | 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.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br /> |
launch | insert | region, compartmentId, availabilityDomain, subnetId, shape, sshPublicKeys, hostname | opc-retry-token | Creates a new DB system in the specified compartment and availability domain. The Oracle<br />Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.<br /><br />An initial database is created on the DB system based on the request parameters you provide and some default<br />options. For detailed information about default options, see [Bare metal and virtual machine DB system default options.](/Content/Database/Tasks/creatingDBsystem.htm#Default)<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br /><br />Use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure/) and [CreateCloudVmCluster](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster/) APIs to provision a new Exadata Cloud Service instance.<br /> |
update | update | dbSystemId, region | if-match | Updates the properties of the specified DB system.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br /> |
terminate | delete | dbSystemId, region | if-match | Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br /> |
change_compartment | exec | dbSystemId, region, compartmentId | opc-retry-token, opc-request-id, if-match | Moves the DB system and its dependent resources to the specified compartment.<br />For more information about moving DB systems, see<br />[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).<br /> |
migrate_exadata_db_system_resource_model | exec | dbSystemId, region | opc-request-id, if-match, opc-retry-token | Migrates the Exadata DB system to the new [Exadata resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model).<br />All related resources will be migrated.<br /> |
execute_db_system_os_patch | exec | dbSystemId, region, action | opc-retry-token, opc-request-id, if-match | Execute an operating system (OS) patch action on a DB system. Returns 202 and a work request. Some updates may require a reboot.<br /> |
upgrade_db_system | exec | dbSystemId, region, action | if-match, opc-request-id, opc-retry-token | Upgrades the operating system and grid infrastructure of the DB system.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
compartmentId | string | The compartment [OCID](/Content/General/Concepts/identifiers.htm). |
dbSystemId | string | The DB system [OCID](/Content/General/Concepts/identifiers.htm). |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
availabilityDomain | string | A filter to return only resources that match the given availability domain exactly. |
backupId | string | The [OCID](/Content/General/Concepts/identifiers.htm) 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. |
if-match | string | For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
lifecycleState | string | A filter to return only resources that match the given lifecycle state exactly. |
limit | integer | The maximum number of items to return per page. |
opc-request-id | string | Unique identifier for the request. |
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). |
page | string | The pagination token to continue listing from. |
sortBy | string | The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted. |
sortOrder | string | The sort order to use, either ascending (ASC) or descending (DESC). |
SELECT examples​
- get
- list
Gets information about the specified DB system.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br />
SELECT
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
compartmentId,
computeCount,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
databaseEdition,
dbSystemOptions,
definedTags,
diskRedundancy,
displayName,
domain,
faultDomains,
freeformTags,
giSoftwareImageId,
hostname,
iormConfigCache,
kmsKeyId,
lastMaintenanceRunId,
lastPatchHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
maintenanceWindow,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nsgIds,
pointInTimeDataDiskCloneTimestamp,
recoStorageSizeInGB,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanIpv6Ids,
securityAttributes,
shape,
sourceDbSystemId,
sparseDiskgroup,
sshPublicKeys,
storageVolumePerformanceMode,
subnetId,
systemTags,
timeCreated,
timeZone,
version,
vipIds,
vipv6Ids,
zoneId
FROM oci.database.db_systems
WHERE dbSystemId = '{{ dbSystemId }}' -- required
AND region = '{{ region }}' -- required
;
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.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br />
SELECT
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
compartmentId,
computeCount,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
databaseEdition,
dbSystemOptions,
definedTags,
diskRedundancy,
displayName,
domain,
faultDomains,
freeformTags,
giSoftwareImageId,
hostname,
kmsKeyId,
lastMaintenanceRunId,
lastPatchHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
maintenanceWindow,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nsgIds,
pointInTimeDataDiskCloneTimestamp,
recoStorageSizeInGB,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanIpv6Ids,
securityAttributes,
shape,
sourceDbSystemId,
sparseDiskgroup,
sshPublicKeys,
storageVolumePerformanceMode,
subnetId,
systemTags,
timeCreated,
timeZone,
version,
vipIds,
vipv6Ids,
zoneId
FROM oci.database.db_systems
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND backupId = '{{ backupId }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND availabilityDomain = '{{ availabilityDomain }}'
AND displayName = '{{ displayName }}'
;
INSERT examples​
- launch
- Manifest
Creates a new DB system in the specified compartment and availability domain. The Oracle<br />Database edition that you specify applies to all the databases on that DB system. The selected edition cannot be changed.<br /><br />An initial database is created on the DB system based on the request parameters you provide and some default<br />options. For detailed information about default options, see [Bare metal and virtual machine DB system default options.](/Content/Database/Tasks/creatingDBsystem.htm#Default)<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br /><br />Use the [CreateCloudExadataInfrastructure](#/en/database/latest/CloudExadataInfrastructure/CreateCloudExadataInfrastructure/) and [CreateCloudVmCluster](#/en/database/latest/CloudVmCluster/CreateCloudVmCluster/) APIs to provision a new Exadata Cloud Service instance.<br />
INSERT INTO oci.database.db_systems (
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
compartmentId,
computeCount,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dbSystemOptions,
definedTags,
displayName,
domain,
faultDomains,
freeformTags,
hostname,
initialDataStorageSizeInGB,
kmsKeyId,
kmsKeyVersionId,
nodeCount,
nsgIds,
privateIp,
privateIpV6,
securityAttributes,
shape,
source,
sparseDiskgroup,
sshPublicKeys,
storageVolumePerformanceMode,
subnetId,
timeZone,
region,
opc-retry-token
)
SELECT
'{{ availabilityDomain }}' /* required */,
'{{ backupNetworkNsgIds }}',
'{{ backupSubnetId }}',
'{{ clusterName }}',
'{{ compartmentId }}' /* required */,
{{ computeCount }},
'{{ computeModel }}',
{{ cpuCoreCount }},
'{{ dataCollectionOptions }}',
{{ dataStoragePercentage }},
'{{ dbSystemOptions }}',
'{{ definedTags }}',
'{{ displayName }}',
'{{ domain }}',
'{{ faultDomains }}',
'{{ freeformTags }}',
'{{ hostname }}' /* required */,
{{ initialDataStorageSizeInGB }},
'{{ kmsKeyId }}',
'{{ kmsKeyVersionId }}',
{{ nodeCount }},
'{{ nsgIds }}',
'{{ privateIp }}',
'{{ privateIpV6 }}',
'{{ securityAttributes }}',
'{{ shape }}' /* required */,
'{{ source }}',
{{ sparseDiskgroup }},
'{{ sshPublicKeys }}' /* required */,
'{{ storageVolumePerformanceMode }}',
'{{ subnetId }}' /* required */,
'{{ timeZone }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
compartmentId,
computeCount,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
databaseEdition,
dbSystemOptions,
definedTags,
diskRedundancy,
displayName,
domain,
faultDomains,
freeformTags,
giSoftwareImageId,
hostname,
iormConfigCache,
kmsKeyId,
lastMaintenanceRunId,
lastPatchHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
maintenanceWindow,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nsgIds,
pointInTimeDataDiskCloneTimestamp,
recoStorageSizeInGB,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanIpv6Ids,
securityAttributes,
shape,
sourceDbSystemId,
sparseDiskgroup,
sshPublicKeys,
storageVolumePerformanceMode,
subnetId,
systemTags,
timeCreated,
timeZone,
version,
vipIds,
vipv6Ids,
zoneId
;
# Description fields are for documentation purposes
- name: db_systems
props:
- name: region
value: "{{ region }}"
description: Required parameter for the db_systems resource.
- name: availabilityDomain
value: "{{ availabilityDomain }}"
description: |
The availability domain where the DB system is located.
- name: backupNetworkNsgIds
value:
- "{{ backupNetworkNsgIds }}"
description: |
A list of the [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm). Applicable only to Exadata systems.
- name: backupSubnetId
value: "{{ backupSubnetId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the backup network subnet the DB system is associated with. Applicable only to Exadata DB systems.
**Subnet Restrictions:** See the subnet restrictions information for **subnetId**.
- name: clusterName
value: "{{ clusterName }}"
description: |
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.
- name: compartmentId
value: "{{ compartmentId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment the DB system belongs in.
- name: computeCount
value: {{ computeCount }}
description: |
The number of compute servers for the DB system.
- name: computeModel
value: "{{ computeModel }}"
description: |
The compute model for Base Database Service. This is required if using the `computeCount` parameter. If using `cpuCoreCount` then it is an error to specify `computeModel` to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy.
valid_values: ['ECPU', 'OCPU']
- name: cpuCoreCount
value: {{ cpuCoreCount }}
description: |
The number of CPU cores to enable for a bare metal or Exadata DB system or AMD VMDB Systems. The valid values depend on the specified shape:
- BM.DenseIO1.36 - Specify a multiple of 2, from 2 to 36.
- BM.DenseIO2.52 - Specify a multiple of 2, from 2 to 52.
- Exadata.Base.48 - Specify a multiple of 2, from 0 to 48.
- Exadata.Quarter1.84 - Specify a multiple of 2, from 22 to 84.
- Exadata.Half1.168 - Specify a multiple of 4, from 44 to 168.
- Exadata.Full1.336 - Specify a multiple of 8, from 88 to 336.
- Exadata.Quarter2.92 - Specify a multiple of 2, from 0 to 92.
- Exadata.Half2.184 - Specify a multiple of 4, from 0 to 184.
- Exadata.Full2.368 - Specify a multiple of 8, from 0 to 368.
- VM.Standard.E4.Flex - Specify any thing from 1 to 64.
This parameter is not used for INTEL virtual machine DB systems because virtual machine DB systems have a set number of cores for each shape.
For information about the number of cores for a virtual machine DB system shape, see [Virtual Machine DB Systems](/Content/Database/Concepts/overview.htm#virtualmachine)
- name: dataCollectionOptions
description: |
Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
value:
isDiagnosticsEventsEnabled: {{ isDiagnosticsEventsEnabled }}
isHealthMonitoringEnabled: {{ isHealthMonitoringEnabled }}
isIncidentLogsEnabled: {{ isIncidentLogsEnabled }}
- name: dataStoragePercentage
value: {{ dataStoragePercentage }}
description: |
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).
Specify 80 or 40. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.
- name: dbSystemOptions
description: |
The DB system options.
value:
storageManagement: "{{ storageManagement }}"
- name: definedTags
value: "{{ definedTags }}"
description: |
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
- name: displayName
value: "{{ displayName }}"
description: |
The user-friendly name for the DB system. The name does not have to be unique.
- name: domain
value: "{{ domain }}"
description: |
A domain name used for the DB system. If the Oracle-provided Internet and VCN
Resolver is enabled for the specified subnet, the domain name for the subnet is used
(do not provide one). Otherwise, provide a valid DNS domain name. Hyphens (-) are not permitted.
- name: faultDomains
value:
- "{{ faultDomains }}"
description: |
A Fault Domain is a grouping of hardware and infrastructure within an availability domain.
Fault Domains let you distribute your instances so that they are not on the same physical
hardware within a single availability domain. A hardware failure or maintenance
that affects one Fault Domain does not affect DB systems in other Fault Domains.
If you do not specify the Fault Domain, the system selects one for you. To change the Fault
Domain for a DB system, terminate it and launch a new DB system in the preferred Fault Domain.
If the node count is greater than 1, you can specify which Fault Domains these nodes will be distributed into.
The system assigns your nodes automatically to the Fault Domains you specify so that
no Fault Domain contains more than one node.
To get a list of Fault Domains, use the
[ListFaultDomains](#/en/identity/latest/FaultDomain/ListFaultDomains) operation in the
Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
- name: freeformTags
value: "{{ freeformTags }}"
description: |
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](/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
- name: hostname
value: "{{ hostname }}"
description: |
The hostname for the DB system. The hostname must begin with an alphabetic character, and
can contain alphanumeric characters and hyphens (-). The maximum length of the hostname is 16 characters for bare metal and virtual machine DB systems, and 12 characters for Exadata DB systems.
The maximum length of the combined hostname and domain is 63 characters.
**Note:** The hostname must be unique within the subnet. If it is not unique,
the DB system will fail to provision.
- name: initialDataStorageSizeInGB
value: {{ initialDataStorageSizeInGB }}
description: |
Size (in GB) of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume. By default this will be set to 256.
- name: kmsKeyId
value: "{{ kmsKeyId }}"
description: |
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- name: kmsKeyVersionId
value: "{{ kmsKeyVersionId }}"
description: |
The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.
- name: nodeCount
value: {{ nodeCount }}
description: |
The number of nodes to launch for a virtual machine DB system. Specify either 1 or 2. By default this will be set to 1.
- name: nsgIds
value:
- "{{ nsgIds }}"
description: |
The list of [OCIDs](/Content/General/Concepts/identifiers.htm) 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](/Content/Network/Concepts/securityrules.htm).
- name: privateIp
value: "{{ privateIp }}"
description: |
A private IP address of your choice. Must be an available IP address within the subnet's CIDR.
If you don't specify a value, Oracle automatically assigns a private IP address from the subnet.
- name: privateIpV6
value: "{{ privateIpV6 }}"
description: |
A private IPv6 address of your choice. Must be an available IP address within the subnet's CIDR.
If you don't specify a value and the subnet is dual stack, Oracle automatically assigns a private IPv6 address from the subnet.
- name: securityAttributes
value: "{{ securityAttributes }}"
description: |
Security Attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`
- name: shape
value: "{{ shape }}"
description: |
The shape of the DB system. The shape determines resources allocated 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, memory, and storage
To get a list of shapes, use the [ListDbSystemShapes](#/en/database/latest/DbSystemShapeSummary/ListDbSystemShapes) operation.
- name: source
value: "{{ source }}"
description: |
The source of the database:
Use `NONE` for creating a new database. Use `DB_BACKUP` for creating a new database by restoring from a backup. Use `DATABASE` for creating
a new database from an existing database, including archive redo log data. The default is `NONE`.
valid_values: ['NONE', 'DB_BACKUP', 'DATABASE', 'DB_SYSTEM', 'DATAGUARD']
default: NONE
- name: sparseDiskgroup
value: {{ sparseDiskgroup }}
description: |
If true, Sparse Diskgroup is configured for Exadata dbsystem. If False, Sparse diskgroup is not configured.
- name: sshPublicKeys
value:
- "{{ sshPublicKeys }}"
description: |
The public key portion of the key pair to use for SSH access to the DB system. Multiple public keys can be provided. The length of the combined keys cannot exceed 40,000 characters.
- name: storageVolumePerformanceMode
value: "{{ storageVolumePerformanceMode }}"
description: |
The block storage volume performance level. Valid values are `BALANCED` and `HIGH_PERFORMANCE`. See [Block Volume Performance](/Content/Block/Concepts/blockvolumeperformance.htm) for more information.
valid_values: ['BALANCED', 'HIGH_PERFORMANCE']
default: BALANCED
- name: subnetId
value: "{{ subnetId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) 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 the backup subnet.
- name: timeZone
value: "{{ timeZone }}"
description: |
The time zone to use for the DB system. For details, see [DB System Time Zones](/Content/Database/References/timezones.htm).
- name: opc-retry-token
value: "{{ opc-retry-token }}"
description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
UPDATE examples​
- update
Updates the properties of the specified DB system.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br />
UPDATE oci.database.db_systems
SET
backupNetworkNsgIds = '{{ backupNetworkNsgIds }}',
computeCount = {{ computeCount }},
computeModel = '{{ computeModel }}',
cpuCoreCount = {{ cpuCoreCount }},
dataCollectionOptions = '{{ dataCollectionOptions }}',
dataStorageSizeInGBs = {{ dataStorageSizeInGBs }},
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}',
licenseModel = '{{ licenseModel }}',
maintenanceWindowDetails = '{{ maintenanceWindowDetails }}',
nsgIds = '{{ nsgIds }}',
securityAttributes = '{{ securityAttributes }}',
shape = '{{ shape }}',
sshPublicKeys = '{{ sshPublicKeys }}',
version = '{{ version }}'
WHERE
dbSystemId = '{{ dbSystemId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
availabilityDomain,
backupNetworkNsgIds,
backupSubnetId,
clusterName,
compartmentId,
computeCount,
computeModel,
cpuCoreCount,
dataCollectionOptions,
dataStoragePercentage,
dataStorageSizeInGBs,
databaseEdition,
dbSystemOptions,
definedTags,
diskRedundancy,
displayName,
domain,
faultDomains,
freeformTags,
giSoftwareImageId,
hostname,
iormConfigCache,
kmsKeyId,
lastMaintenanceRunId,
lastPatchHistoryEntryId,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
maintenanceWindow,
memorySizeInGBs,
nextMaintenanceRunId,
nodeCount,
nsgIds,
pointInTimeDataDiskCloneTimestamp,
recoStorageSizeInGB,
scanDnsName,
scanDnsRecordId,
scanIpIds,
scanIpv6Ids,
securityAttributes,
shape,
sourceDbSystemId,
sparseDiskgroup,
sshPublicKeys,
storageVolumePerformanceMode,
subnetId,
systemTags,
timeCreated,
timeZone,
version,
vipIds,
vipv6Ids,
zoneId;
DELETE examples​
- terminate
Terminates a DB system and permanently deletes it and any databases running on it, and any storage volumes attached to it. The database data is local to the DB system and will be lost when the system is terminated. Oracle recommends that you back up any data in the DB system prior to terminating it.<br /><br />Note: Deprecated for Exadata Cloud Service systems. Use the [new resource model APIs](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model) instead.<br /><br />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](/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.<br />
DELETE FROM oci.database.db_systems
WHERE dbSystemId = '{{ dbSystemId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;
Lifecycle Methods​
- change_compartment
- migrate_exadata_db_system_resource_model
- execute_db_system_os_patch
- upgrade_db_system
Moves the DB system and its dependent resources to the specified compartment.<br />For more information about moving DB systems, see<br />[Moving Database Resources to a Different Compartment](/Content/Database/Concepts/databaseoverview.htm#moveRes).<br />
EXEC oci.database.db_systems.change_compartment
@dbSystemId='{{ dbSystemId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;
Migrates the Exadata DB system to the new [Exadata resource model](/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model).<br />All related resources will be migrated.<br />
EXEC oci.database.db_systems.migrate_exadata_db_system_resource_model
@dbSystemId='{{ dbSystemId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}',
@opc-retry-token='{{ opc-retry-token }}'
;
Execute an operating system (OS) patch action on a DB system. Returns 202 and a work request. Some updates may require a reboot.<br />
EXEC oci.database.db_systems.execute_db_system_os_patch
@dbSystemId='{{ dbSystemId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
@@json=
'{
"action": "{{ action }}",
"dbNodeId": "{{ dbNodeId }}"
}'
;
Upgrades the operating system and grid infrastructure of the DB system.<br />
EXEC oci.database.db_systems.upgrade_db_system
@dbSystemId='{{ dbSystemId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}',
@opc-request-id='{{ opc-request-id }}',
@opc-retry-token='{{ opc-retry-token }}'
@@json=
'{
"action": "{{ action }}",
"isSnapshotRetentionDaysForceUpdated": {{ isSnapshotRetentionDaysForceUpdated }},
"newGiVersion": "{{ newGiVersion }}",
"newOsVersion": "{{ newOsVersion }}",
"snapshotRetentionPeriodInDays": {{ snapshotRetentionPeriodInDays }}
}'
;