Manage Database Management for Base Database Service Resources

This article describes the procedure to enable, edit, and disable Database Management for Base Database Service resources.

The following topics are covered in this article:

Prerequisites

You must perform the following tasks before enabling Database Management for your databases.

Required IAM Policy

To use Oracle Cloud Infrastructure, you must be granted security access in a policy by an administrator. This access is required whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you get a message that you don’t have permission or are unauthorized, verify with your administrator what type of access you have and which compartment to work in.

For administrators: The policy in Let database admins manage Oracle Cloud database systems lets the specified group do everything with databases and related Database resources.

If you're new to policies, see Getting Started with Policies and Common Policies. If you want to dig deeper into writing policies for databases, see Details for the Database Service.

Use the API

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

Use the following APIs for managing Database Management:

  • enableDatabaseManagement
  • disableDatabaseManagement
  • updateDatabaseManagement

For the complete list of APIs for the Database service, see Database Service API.

Related Topics

Enable Database Management for a Database

Note:

You can also enable Database Management for a database from the Database Management Administration page. For more information, see Enable Database Management for Oracle Cloud Databases.

Perform the following steps to enable Database Management for a database using the Console:

  1. On the DB Systems list page, select the DB system that contains the database that you want to work with. If you need help finding the list page or the DB system, see List the DB Systems.
  2. On the Databases tab, select the database that you want to work with.
  3. On the Database information tab, under the Associated Services section, check the status of Database Management.
  4. If the Database Management is displayed as Not Enabled, perform the following steps to enable Database Management.
  5. Select Enable.
  6. In the Enable Diagnostics & Management page, in the Database information section, enter the following details.
    • Database type: Read-only. Type of the database.
    • Database system: Read-only. Compartment in which the database is located.
    • Database home: Read-only. Database home of the database.
    • Database name: Read-only. Name of the database.
    • Select from one of the following options:
      • Enable Diagnostics & Management for CDB and all PDBs.
      • Enable Diagnostics & Management for CDB only.
    • Service name: The unique service name of the database. A default unique name is displayed, which can be changed if required.
    • Protocol: Select either the TCP or TCPS protocol to connect to the database. By default, the TCP protocol is selected.

      Note:

      If Oracle Data Guard is enabled after Database Management was enabled for a DB system using the TCPS protocol, then TCPS will have to be reconfigured. Enabling Oracle Data Guard is causing TCPS configuration to be overwritten, and it's recommended that TCPS is configured on a DB system after enabling Oracle Data Guard.

      Note:

      Database Management currently does not support Oracle Data Guard configuration, and Database Management features are not available for standby databases.
    • Port: Specify the port number. If TCP is selected in the Protocol field, then port number 1521 is displayed by default, and you can change it if required. You can select the port number from a range of 1 to 65535.
    • Database wallet secret: This field is only displayed if TCPS is selected in the Protocol field.

      Select the secret that contains the database wallet from the drop-down list. If an existing database wallet secret is not available, then select Create new secret... in the drop-down list. The Create database wallet secret panel is displayed, and you can create a new secret. For information on database wallets and creating a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database wallet is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  7. In the Specify credentials for the connection section, provide the following details.
    • Database user name: Enter the database user name.
    • Database user password secret:

      Select the secret that contains the database user password from the drop-down list. If the compartment in which the secret resides is different from the compartment displayed, then select Change compartment and select another compartment. If an existing secret with the database user password is not available, then select Create new secret... in the drop-down list. The Create password secret panel is displayed, and you can create a new secret. For information on database monitoring user credentials and saving the database user password as a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database user password is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  8. In the Select connection mode section, select the private endpoint that will act as a representation of Database Management in the VCN in which the database can be accessed. You can choose the private endpoint from a different compartment as well. You must ensure that the appropriate Database Management private endpoint is available. Here are the two types of Database Management private endpoints:
    • Private endpoint for single-instance databases in the DB systems.
    • Private endpoint for RAC databases in the DB system.
    • If a Database Management private endpoint is not available, then you must create one. For information on how to create a private endpoint, see Create a Database Management Private Endpoint.
  9. In the Management options section, choose between the following options.
    • Full management: This includes fleet management, advanced Performance Hub, and other SKU features along with basic management capabilities.
    • Basic management: This includes basic monitoring metrics and the ASH Analytics and SQL Monitoring features in Performance Hub for databases.

    For more information on Database Management options, see the About Management Options section in Enable Database Management for Oracle Cloud Databases.

  10. Select Enable Diagnostics & Management.
  11. A confirmation message with a link to the Work requests section on the Database information page is displayed. Select the link to monitor the progress of the work request.
  12. On the Database information tab, under the Associated Services section, verify if the status of Database Management is enabled.

If you encounter issues when enabling Database Management, to know about likely causes and solutions, see Issues Encountered When Enabling Database Management for Oracle Cloud Databases.

Edit Database Management for a Database

Perform the following steps to edit Database Management settings for a database using the Console:

  1. On the DB Systems list page, select the DB system that contains the database that you want to work with. If you need help finding the list page or the DB system, see List the DB Systems.
  2. On the Databases tab, select the database that you want to work with.
  3. On the Database information tab, under the Associated Services section, check the status of Database Management.
  4. If the Database Management is displayed as enabled, perform the following steps to edit Database Management.
  5. Select Edit.
  6. In the Enable Diagnostics & Management page, in the Database information section, enter the following details.
    • Database type: Read-only. Type of the database.
    • Database system: Read-only. Compartment in which the database is located.
    • Database home: Read-only. Database home of the database.
    • Database name: Read-only. Name of the database.
    • Select from one of the following options:
      • Enable Diagnostics & Management for CDB and all PDBs.
      • Enable Diagnostics & Management for CDB only.
    • Service name: The unique service name of the database. A default unique name is displayed, which can be changed if required.
    • Protocol: Select either the TCP or TCPS protocol to connect to the database. By default, the TCP protocol is selected.

      Note:

      If Oracle Data Guard is enabled after Database Management was enabled for a DB system using the TCPS protocol, then TCPS will have to be reconfigured. Enabling Oracle Data Guard is causing TCPS configuration to be overwritten, and it's recommended that TCPS is configured on a DB system after enabling Oracle Data Guard.

      Note:

      Database Management currently does not support Oracle Data Guard configuration, and Database Management features are not available for standby databases.
    • Port: Specify the port number. If TCP is selected in the Protocol field, then port number 1521 is displayed by default, and you can change it if required. You can select the port number from a range of 1 to 65535.
    • Database wallet secret: This field is only displayed if TCPS is selected in the Protocol field.

      Select the secret that contains the database wallet from the drop-down list. If an existing database wallet secret is not available, then select Create new secret... in the drop-down list. The Create database wallet secret panel is displayed, and you can create a new secret. For information on database wallets and creating a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database wallet is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  7. In the Specify credentials for the connection section, provide the following details.
    • Database user name: Enter the database user name.
    • Database user password secret:

      Select the secret that contains the database user password from the drop-down list. If the compartment in which the secret resides is different from the compartment displayed, then select Change compartment and select another compartment. If an existing secret with the database user password is not available, then select Create new secret... in the drop-down list. The Create password secret panel is displayed, and you can create a new secret. For information on database monitoring user credentials and saving the database user password as a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database user password is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  8. In the Select connection mode section, select the private endpoint that will act as a representation of Database Management in the VCN in which the database can be accessed. You can choose the private endpoint from a different compartment as well. You must ensure that the appropriate Database Management private endpoint is available. Here are the two types of Database Management private endpoints:
    • Private endpoint for single-instance databases in the DB systems.
    • Private endpoint for RAC databases in the DB system.
    • If a Database Management private endpoint is not available, then you must create one. For information on how to create a private endpoint, see Create a Database Management Private Endpoint.
  9. In the Management options section, choose between the following options.
    • Full management: This includes fleet management, advanced Performance Hub, and other SKU features along with basic management capabilities.
    • Basic management: This includes basic monitoring metrics and the ASH Analytics and SQL Monitoring features in Performance Hub for databases.

    For more information on Database Management options, see the About Management Options section in Enable Database Management for Oracle Cloud Databases.

  10. Select Save Changes.
  11. A confirmation message with a link to the Work requests section on the Database information page is displayed. Select the link to monitor the progress of the work request.
  12. On the Database information tab, under the Associated Services section, verify if the status of Database Management is enabled.

If you encounter issues when enabling Database Management, to know about likely causes and solutions, see Issues Encountered When Enabling Database Management for Oracle Cloud Databases.

Disable Database Management for a Database

Perform the following steps to disable Database Management for a database using the Console:

  1. On the DB Systems list page, select the DB system that contains the database that you want to work with. If you need help finding the list page or the DB system, see List the DB Systems.
  2. On the Databases tab, select the database that you want to work with.
  3. On the Database information tab, under the Associated Services section, check the status of Database Management.
  4. If the Database Management is displayed as enabled, then select Disable to disable Database Management.
  5. A confirmation message with a link to the Work requests section on the Database information page is displayed. Select the link to monitor the progress of the work request.
  6. On the Database information tab, under the Associated Services section, verify if the status of Database Management is disabled.

Enable Database Management for a Pluggable Database

Note:

You can also enable Database Management for a database from the Database Management Administration page. For more information, see Enable Database Management for Oracle Cloud Databases.

Prerequisites

Procedure

Perform the following steps to enable Database Management for pluggable databases using the Console:

  1. On the DB Systems list page, select the DB system that contains the pluggable database that you want to work with. If you need help finding the list page or the DB system, see List the DB Systems.
  2. On the Databases tab, select the database that contains the pluggable database that you want to work with.
  3. On the Pluggable Databases tab, select the pluggable database that you want to work with.
  4. On the Database information tab, under the Associated Services section, check the status of Database Management.
  5. If the Database Management is displayed as Not Enabled, perform the following steps to enable Database Management.
  6. Select Enable.
  7. In the Enable Diagnostics & Management page, in the Database information section, enter the following details.
    • Database type: Read-only. Type of the database.
    • Database system: Read-only. Compartment in which the database is located.
    • Database home: Read-only. Database home of the database.
    • Database name: Read-only. Name of the database.
    • Select from one of the following options:
      • Enable Diagnostics & Management for CDB and all PDBs.
      • Enable Diagnostics & Management for CDB only.
    • Service name: The unique service name of the database. A default unique name is displayed, which can be changed if required.
    • Protocol: Select either the TCP or TCPS protocol to connect to the database. By default, the TCP protocol is selected.

      Note:

      If Oracle Data Guard is enabled after Database Management was enabled for a DB system using the TCPS protocol, then TCPS will have to be reconfigured. Enabling Oracle Data Guard is causing TCPS configuration to be overwritten, and it's recommended that TCPS is configured on a DB system after enabling Oracle Data Guard.

      Note:

      Database Management currently does not support Oracle Data Guard configuration, and Database Management features are not available for standby databases.
    • Port: Specify the port number. If TCP is selected in the Protocol field, then port number 1521 is displayed by default, and you can change it if required. You can select the port number from a range of 1 to 65535.
    • Database wallet secret: This field is only displayed if TCPS is selected in the Protocol field.

      Select the secret that contains the database wallet from the drop-down list. If an existing database wallet secret is not available, then select Create new secret... in the drop-down list. The Create database wallet secret panel is displayed, and you can create a new secret. For information on database wallets and creating a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database wallet is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  8. In the Specify credentials for the connection section, provide the following details.
    • Database user name: Enter the database user name.
    • Database user password secret:

      Select the secret that contains the database user password from the drop-down list. If the compartment in which the secret resides is different from the compartment displayed, then select Change compartment and select another compartment. If an existing secret with the database user password is not available, then select Create new secret... in the drop-down list. The Create password secret panel is displayed, and you can create a new secret. For information on database monitoring user credentials and saving the database user password as a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database user password is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  9. In the Select connection mode section, select the private endpoint that will act as a representation of Database Management in the VCN in which the database can be accessed. You can choose the private endpoint from a different compartment as well. You must ensure that the appropriate Database Management private endpoint is available. Here are the two types of Database Management private endpoints:
    • Private endpoint for single-instance databases in the DB systems.
    • Private endpoint for RAC databases in the DB system.
    • If a Database Management private endpoint is not available, then you must create one. For information on how to create a private endpoint, see Create a Database Management Private Endpoint.
  10. Select Enable Diagnostics & Management.
  11. A confirmation message with a link to the Work requests section on the Database information page is displayed. Select the link to monitor the progress of the work request.
  12. On the Database information tab, under the Associated Services section, verify if the status of Database Management is enabled.

If you encounter issues when enabling Database Management, to know about likely causes and solutions, see Issues Encountered When Enabling Database Management for Oracle Cloud Databases.

Edit Database Management for a Pluggable Database

Perform the following steps to edit Database Management for pluggable databases using the Console:

  1. On the DB Systems list page, select the DB system that contains the pluggable database that you want to work with. If you need help finding the list page or the DB system, see List the DB Systems.
  2. On the Databases tab, select the database that contains the pluggable database that you want to work with.
  3. On the Pluggable Databases tab, select the pluggable database that you want to work with.
  4. On the Database information tab, under the Associated Services section, check the status of Database Management.
  5. If the Database Management is displayed as enabled, perform the following steps to edit Database Management.
  6. Select Edit.
  7. In the Enable Diagnostics & Management page, in the Database information section, enter the following details.
    • Database type: Read-only. Type of the database.
    • Database system: Read-only. Compartment in which the database is located.
    • Database home: Read-only. Database home of the database.
    • Database name: Read-only. Name of the database.
    • Select from one of the following options:
      • Enable Diagnostics & Management for CDB and all PDBs.
      • Enable Diagnostics & Management for CDB only.
    • Service name: The unique service name of the database. A default unique name is displayed, which can be changed if required.
    • Protocol: Select either the TCP or TCPS protocol to connect to the database. By default, the TCP protocol is selected.

      Note:

      If Oracle Data Guard is enabled after Database Management was enabled for a DB system using the TCPS protocol, then TCPS will have to be reconfigured. Enabling Oracle Data Guard is causing TCPS configuration to be overwritten, and it's recommended that TCPS is configured on a DB system after enabling Oracle Data Guard.

      Note:

      Database Management currently does not support Oracle Data Guard configuration, and Database Management features are not available for standby databases.
    • Port: Specify the port number. If TCP is selected in the Protocol field, then port number 1521 is displayed by default, and you can change it if required. You can select the port number from a range of 1 to 65535.
    • Database wallet secret: This field is only displayed if TCPS is selected in the Protocol field.

      Select the secret that contains the database wallet from the drop-down list. If an existing database wallet secret is not available, then select Create new secret... in the drop-down list. The Create database wallet secret panel is displayed, and you can create a new secret. For information on database wallets and creating a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database wallet is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  8. In the Specify credentials for the connection section, provide the following details.
    • Database user name: Enter the database user name.
    • Database user password secret:

      Select the secret that contains the database user password from the drop-down list. If the compartment in which the secret resides is different from the compartment displayed, then select Change compartment and select another compartment. If an existing secret with the database user password is not available, then select Create new secret... in the drop-down list. The Create password secret panel is displayed, and you can create a new secret. For information on database monitoring user credentials and saving the database user password as a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      If the Database Management (dpd) service policy that grants Database Management the permission to read the secret that contains the database user password is not created, then the 'System policies are required..' message is displayed. You can select Add policy to view and automatically create the service policy. For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  9. In the Select connection mode section, select the private endpoint that will act as a representation of Database Management in the VCN in which the database can be accessed. You can choose the private endpoint from a different compartment as well. You must ensure that the appropriate Database Management private endpoint is available. Here are the two types of Database Management private endpoints:
    • Private endpoint for single-instance databases in the DB systems.
    • Private endpoint for RAC databases in the DB system.
    • If a Database Management private endpoint is not available, then you must create one. For information on how to create a private endpoint, see Create a Database Management Private Endpoint.
  10. Select Save Changes.
  11. A confirmation message with a link to the Work requests section on the Database information page is displayed. Select the link to monitor the progress of the work request.
  12. On the Database information tab, under the Associated Services section, verify if the status of Database Management is enabled.

If you encounter issues when enabling Database Management, to know about likely causes and solutions, see Issues Encountered When Enabling Database Management for Oracle Cloud Databases.

Disable Database Management for a Pluggable Database

Perform the following steps to disable Database Management for pluggable databases using the Console:

  1. On the DB Systems list page, select the DB system that contains the pluggable database that you want to work with. If you need help finding the list page or the DB system, see List the DB Systems.
  2. On the Databases tab, select the database that contains the pluggable database that you want to work with.
  3. On the Pluggable Databases tab, select the pluggable database that you want to work with.
  4. On the Database information tab, under the Associated Services section, check the status of Database Management.
  5. If the Database Management is displayed as Enabled, perform the following steps to disable Database Management.
  6. Select Disable.
  7. A confirmation message with a link to the Work requests section on the Database information page is displayed. Select the link to monitor the progress of the work request.
  8. On the Database information tab, under the Associated Services section, verify if the status of Database Management is Disabled.