Register an Oracle On-Premises Database

You can use the Oracle On-Premises Databases wizard to register an Oracle On-Premises database as an Oracle Data Safe target database.

Note:

Be sure to complete the preregistration tasks before using the wizard and the post registration tasks after using the wizard.

Preregistration Tasks for an Oracle On-Premises Database

The following table lists the preregistration tasks.

Task Number	Task	Link to Instructions
1	In Oracle Cloud Infrastructure Identity and Access Management (IAM), obtain permissions to register your target database.	Permissions to Register an On-Premises Oracle Database with Oracle Data Safe
2	Create an Oracle Data Safe service account on your target database and grant it Oracle Data Safe roles. Create the service account as the SYS user.	Create an Oracle Data Safe Service Account on Your Target Database Grant Roles to the Oracle Data Safe Service Account on Your Target Database
3	(Optional) If you plan to connect to the target database via an Oracle Data Safe private endpoint and want to configure a TLS connection, create a wallet or certificate.	Create a Wallet or Certificates for a TLS Connection.

Run the On-Premises Oracle Databases Wizard

This is the on-premises Oracle Database registration workflow in the wizard:

Step 1: Target Information

1. On the Overview page in the Oracle Data Safe service, find the Register Oracle On-Premises Databases tile and click Start Wizard.

   The wizard displays the Data Safe Target Information form.

2. At DATA SAFE TARGET DISPLAY NAME, enter a target display name that is meaningful to you. Data Safe uses this name in its reports. All characters are accepted. The maximum number of characters is 255.
3. At COMPARTMENT, use the drop-down menu to select the compartment where you want to store the target database.
4. (Optional) In the DESCRIPTION field, add a description that is meaningful to you.
5. At DATABASE SERVICE NAME, enter the service name of the PDB or CDB.
6. Perform this step if you did not already granted roles to the database user in the preregistration tasks.

   Click Download Privilege Script and save the datasafe_privileges.sql script to your computer. The script includes instructions on how to use it to grant privileges to the Oracle Data Safe service account on your target database. You should also refer to the preregistration task Grant Roles to the Oracle Data Safe Service on a Non-Autonomous Database for some additional details.

7. At DATABASE USERNAME and DATABASE PASSWORD, enter the name and password of the user you created in the preregistration tasks. If the user name is mixed case, enclose it in double-quotes (" "). Oracle Data Safe uses this account to connect to the target database.
8. Click Next.

Step 2: Connectivity Option

In this step, choose either an on-premises connector or Oracle Data Safe private endpoint for the connection to the target database.

If you have FastConnect or VPN Connect set up between your on-premises network and a virtual cloud network (VCN) in Oracle Cloud Infrastructure, you can register an on-premises Oracle database with Oracle Data Safe by using an Oracle Data Safe private endpoint.

1. At Choose a connectivity option click either On-Premises Connector or Private Endpoint.

   Note:

   If you select Private Endpoint, then if the database is configured with a private IP address and an Oracle Data Safe private endpoint is already configured for the VCN of the database, that private endpoint is automatically selected. (You can have only one Oracle Data Safe private endpoint per VCN.)
2. At TCP/TLS, select the network protocol.
   If you select the TLS and choose Private Endpoint, then you are presented with two options: One way TLS and Mutual TLS. If you select One way TLS, then do the following:

   • Upload the TrustStore of your database in the format of PEM file, PKCS#12 wallet, or JKS wallet and optionally, enter the wallet password. This file is required whether client authentication is enabled or disabled on your target database.

   If you select Mutual TLS, then do the following:

   • Upload the TrustStore of your database in the format of PEM file, PKCS#12 wallet, or JKS wallet and enter the wallet password. This file is required whether client authentication is enabled or disabled on your target database.
   • When client authentication is enabled on your target database, upload the KeyStore of your database in the format of PEM file, PKCS#12 wallet, or JKS wallet. This file is not required when client authentication is disabled.
   If you select TCP at TCP/TLS, you are not prompted for any additional details.
3. At Database IP address, enter the IP address of the database. If there are multiple IP addresses, use commas with no spaces to separate them.
4. At Database port number, enter the port number of your database listener.
5. If you chose On-Premises Connector in Step 1, then at Do you want to use an existing on-premises connector?, click Yes or No. If you select Yes, then from Select on-premises connector, use the drop-down menu to select the on-premises connector that you want to use. If you select No, the wizard prompts for basic information it needs to create a new on-premises connector for the target database.
   If instead you chose Private Endpoint in Step 1, then at Do you want to use an existing private endpoint?, click Yes or No. If you select Yes, then from Select private endpoint, use the drop-down menu to select the private endpoint that you want to use. The private endpoint needs to be in a VCN that can access your on-premises database. If you select No, the wizard prompts for basic information it needs to create a new private endpoint for the target database.
   At Compartment use the drop-down menu to select the compartment where you want to store the on-premises connector or private endpoint. At Name, provide a name of your choice. At Description you can opt to enter a description.
6. Click Next.

Step 3: Select Peer Database

If you're registering an Active Data Guard associated database then you can add the standby databases at this step. If you're not registering an Active Data Guard associated database, then skip this step by clicking Next.

1. Click Add row on the Add additional Data Guard peer database(s) (Optional) page.

   It is also possible to register standby databases after the primary database has been registered. See Manage Peer Databases Associated with a Registered Active Data Guard Primary Database for more information.

2. Enter the following information for the peer databases:
   • Peer display name
   • Database service name
   • Database IP address
   • Database port number
   • TCP/TLS
3. Add more peer databases by clicking Add row.
4. Click Next.

   If you selected Private Endpoint in Step 1, the wizard proceeds to Step 4: Add security rules.

   If you selected On-Premises Connector in Step 1, the wizard takes you directly to Step 5: Review and submit.

Step 4: Add Security Rule

An egress rule is required if you configure an on-premises target database registration to use an Oracle Data Safe private endpoint. The egress rule allows the Oracle Data Safe private endpoint (from any port) to send requests to the database IP address(es) on the database's port.

An ingress rule is not needed in the Oracle Data Safe configuration for a on on-premises target database. If you already created the necessary egress rule, you can choose to skip this step.

See Also:

For more information about security lists and network security groups, see Access and Security in the Oracle Cloud Infrastructure documentation.

1. At Do you want to add the security rules now?, select either Yes or No.
   If you select No, you can then click Next to bypass the egress rule selection and proceed to Step 5: Review and Submit. You can configure the egress rule later in the Oracle Cloud Infrastructure console (under Networking). Note that the target database remains inactive in Oracle Data Safe until the egress rule is configured either in the Oracle Data Safe wizard or on the Oracle Cloud Infrastructure Console.
2. If you select Yes, then at Add egress security rule to, select either Security list or Network security group.
3. Select the Security List or Network Security Group to which you want to add the egress rule.

   Note:

   There will be an additional egress rule for each peer database that you have added as well.
4. Click Next to go to Step 5: Review and Submit.

Step 5: Review and Submit

In this step, the wizard displays the configuration you entered in Step 1: Target Database Information, Step 2: Connectivity Option, and Step 3: Security Rules.

To change any of these settings, click the Edit button on the right side of the corresponding tile.

1. Review the information on this page.
2. Click the checkbox, I ACKNOWLEDGE THAT CHARGES MAY APPLY FOR THIS ON-PREMISES TARGET DATABASE.
3. If all of the settings are correct, click Register. If not, click Previous to return to any of the earlier steps, or click Cancel.

Step 6: Registration Progress

After you click Register in Step 4: Review and Submit, Oracle Data Safe creates the configuration and registers the target database. The next and final step in the wizard is to monitor the registration progress. The tasks required are listed and processed one-by-one.

Important:

Do not click the Close button in the wizard, sign out of OCI, or close the browser tab until the wizard shows that all of the tasks listed are resolved. If you close prematurely, then the information for all of the tasks that have not yet been completed is lost and the target database is not registered.

After You Submit the Registration

The wizard presents the Target Database Details page when the registration submission is finished. On this page, you can again review the registration details. The wizard displays the NEEDS_ATTENTION icon if a task must be performed or corrected before the process is complete. A hint message indicates the pending task. You can make the necessary changes in the tabs that are available. When you save your changes, the UPDATING icon is displayed. If there is no further work to do, the registration completes.

Post Registration Tasks for an Oracle On-Premises Database

The following table lists tasks that you need to complete after you run the Oracle On-Premises Database wizard.

Task Number	Task	Link to Instructions
1	(If you are using an Oracle Data Safe on-premises connector) Download the install bundle for the on-premises connector and then install the on-premises connector on a host machine on your network.	Create an Oracle Data Safe On-Premises Connector
2	(If you are using a TLS connection and an Oracle Data Safe on-premises connector) Configure a TLS connection between the on-premises connector and your target database.	Configure a TLS Connection Between the On-Premises Connector on Your Host Machine and Your Oracle Database
3	(Optional) Change which features are allowed for the Oracle Data Safe service account on your target database by granting/revoking roles from the account. You need to be the SYS user.	Grant Roles to the Oracle Data Safe Service Account on Your Target Database
4	(Optional) Grant users access to Oracle Data Safe features with the target database by configuring policies in Oracle Cloud Infrastructure Identity and Access Management.	Create IAM Policies for Oracle Data Safe Users
5	Make sure to allow ingress traffic to your target database from the Oracle Data Safe private endpoint or Oracle Data Safe on-premises connector.	(none)
6	(If you are using an on-premises connector) Note: Oracle Recommendation: Ensure that only the on-premises client can connect to your on-premises Oracle database by specifying in sqlnet.ora parameter called INVITED_NODES the clients that are allowed to access your database.	TCP.INVITED_NODES(Oracle Database Net Services Reference guide)