Skip to main content
BlueXP backup and recovery
All cloud providers
  • Amazon Web Services
  • Google Cloud
  • Microsoft Azure
  • All cloud providers

Install SnapCenter Plug-in for Oracle and add database hosts

Contributors netapp-soumikd netapp-nsriram

You should install the SnapCenter Plug-in for Oracle on each of the Oracle database hosts, add the database hosts, and discover the databases on the host to assign policies and create backups.

  • If SSH is enabled for the database host, you can install the plug-in using one of the methods:

    • Install the plug-in and add host from the UI using SSH option. Learn more.

    • Install the plug-in using script and add host from the UI using manual option. Learn more.

  • If SSH is disabled, install the plug-in manually and add host from the UI using manual option. Learn more.

Prerequisites

Before adding the host, you should ensure that the prerequisites are met.

  • You should have created the working environment and the Connector.

  • Ensure that the Connector has connectivity to the Oracle database hosts.

    For information on how to resolve the connectivity issue, refer to Failed to validate connectivity from BlueXP connector host to application database host.

    When the connector is lost or if you have created a new connector, you should associate the connector with the existing application resources. For instructions to update the Connector, see Update the Connector Details.

  • Ensure that the BlueXP user has the “Account Admin” role.

  • Ensure that non root (sudo) account is present on the application host for data protection operations.

  • Ensure that either Java 11 (64-bit) Oracle Java or OpenJDK is installed on each of the Oracle database hosts and the JAVA_HOME variable is set appropriately.

  • Ensure that the Connector has the communication enabled to the SSH port (default: 22) if SSH based installation is performed.

  • Ensure that the Connector has the communication enabled to plug-in port (default: 8145) for the data protection operations to work.

  • Ensure that the you have the latest version of plug-in is installed. To upgrade the plug-in, refer to Upgrade SnapCenter Plug-in for Oracle Database.

Add host from UI using SSH option

Steps

  1. In the BlueXP UI, click Protection > Backup and recovery > Applications.

    If you have already added a host and want to add another host, click Applications > Manage Databases > Add and then proceed with step 5.

  2. Click Discover Applications.

  3. Select Cloud Native and click Next.

    A service account (SnapCenter-account-<accountid>) with SnapCenter System role is created to perform scheduled data protection operations for all the users in this account.
    The service account (SnapCenter-account-<accountid>) is used to run the scheduled backup operations. You should never delete the service account.
    You can view the service account by clicking Account > Manage Account > Members.

  4. Select Oracle as the application type.

  5. In the Host details page, perform the following:

    1. Select Using SSH.

    2. Specify the FQDN or IP address of the host where you want to install the plug-in.

      Ensure that the Connector can communicate with the database host using the FQDN or IP address.

    3. Specify the non-root(sudo) user using which the plug-in package will be copied to the host.

      Root user is not supported.

    4. Specify the SSH and plug-in port.

      Default SSH port is 22 and the plug-in port is 8145.

      You can close the SSH port on the application host after installing the plug-in. The SSH port is not required for any data protection operations.

    5. Select the Connector.

    6. (Optional) If key less authentication is not enabled between the Connector and the host, you should specify the SSH private key that will be used to communicate with the host.

      Note The SSH private key is not stored anywhere in the application and is not used for any other operations.

    7. Click Next.

  6. In the Configuration page, perform the following:

    1. Configure sudo access for the SnapCenter user in the Oracle database host by logging in to the Linux machine running Oracle database.

    2. Copy the text displayed in BlueXP UI.

    3. Create the /etc/sudoers.d/snapcenter file on the Linux machine and paste the copied text.

    4. In the BlueXP UI, select the checkbox and click Next.

  7. Review the details and click Discover Applications.

    • After the plug-in is installed, the discovery operation starts.

    • After completing the discovery operation, all the databases on the host are displayed. If OS authentication is disabled for the database, click Configure to enable database authentication. For more information, refer to Configure Oracle database credentials.

    • Click Settings and select Hosts to view all the hosts.

    • Click Settings and select Policies to view the pre-canned policies. Review the pre-canned policies and you can either edit them to meet your requirement or create a new policy.

Add host from UI using manual option and install the plug-in using script

Configure SSH key based authentication for the Oracle host non-root user account and perform the following steps to install the plug-in.

Before you begin

Ensure that the SSH connection to the Connector is enabled.

Steps

  1. In the BlueXP UI, click Protection > Backup and recovery > Applications.

  2. Click Discover Applications.

  3. Select Cloud Native and click Next.

    A service account (SnapCenter-account-<accountid>) with SnapCenter System role is created to perform scheduled data protection operations for all the users in this account.
    The service account (SnapCenter-account-<accountid>) is used to run the scheduled backup operations. You should never delete the service account.
    You can view the service account by clicking Account > Manage Account > Members.

  4. Select Oracle as the application type.

  5. In the Host details page, perform the following:

    1. Select Manual.

    2. Specify the FQDN or IP address of the host where the plug-in is installed.

      Ensure that the Connector can communicate with the database host using the FQDN or IP address.

    3. Specify the plug-in port.

      Default port is 8145.

    4. Specify the non-root (sudo) user using which the plug-in package will be copied to the host.

    5. Select the Connector.

    6. Select the check box to confirm that the plug-in is installed on the host.

    7. Click Next.

  6. In the Configuration page, perform the following:

    1. Configure sudo access for the SnapCenter user in the Oracle database host by logging in to the Linux machine running Oracle database.

    2. Copy the text displayed in BlueXP UI.

    3. Create the /etc/sudoers.d/snapcenter file on the Linux machine and paste the copied text.

    4. In the BlueXP UI, select the checkbox and click Next.

  7. Log into the Connector VM.

  8. Install the plug-in using the script provided in the Connector.
    sudo /var/lib/docker/volumes/service-manager-2_cloudmanager_scs_cloud_volume/_data/scripts/linux_plugin_copy_and_install.sh --host <plugin_host> --username <host_user_name> --sshkey <host_ssh_key> --pluginport <plugin_port> --sshport <host_ssh_port>

    If you are using an older Connector, run the following command to install the plug-in.
    sudo /var/lib/docker/volumes/cloudmanager_scs_cloud_volume/_data/scripts/linux_plugin_copy_and_install.sh --host <plugin_host> --username <host_user_name> --sshkey <host_ssh_key> --pluginport <plugin_port> --sshport <host_ssh_port>

    Name Description Mandatory Default

    plugin_host

    Specifies the Oracle host

    Yes

    -

    host_user_name

    Specifies the SnapCenter user with SSH privileges on the Oracle host

    Yes

    -

    host_ssh_key

    Specifies the SSH key of the SnapCenter user and is used to connect to the Oracle host

    Yes

    -

    plugin_port

    Specifies the port used by the plug-in

    No

    8145

    host_ssh_port

    Specifies the SSH port on the Oracle host

    No

    22

    For example:

    • sudo /var/lib/docker/volumes/service-manager-2_cloudmanager_scs_cloud_volume/_data/scripts/linux_plugin_copy_and_install.sh --host 10.0.1.1 --username snapcenter --sshkey /keys/netapp-ssh.ppk

    • sudo /var/lib/docker/volumes/cloudmanager_scs_cloud_volume/_data/scripts/linux_plugin_copy_and_install.sh --host 10.0.1.1 --username snapcenter --sshkey /keys/netapp-ssh.ppk

  9. In the BlueXP UI, review the details and click Discover Applications.

    • After completing the discovery operation, all the databases on the host are displayed. If OS authentication is disabled for the database, click Configure to enable database authentication. For more information, refer to Configure Oracle database credentials.

    • Click Settings and select Hosts to view all the hosts.

    • Click Settings and select Policies to view the pre-canned policies. Review the pre-canned policies and you can either edit them to meet your requirement or create a new policy.

Add host from UI using manual option and install the plug-in manually

If SSH key based authentication is not enabled on the Oracle database host, you should perform the following manual steps to install the plug-in and then add the host from UI using manual option.

Steps

  1. In the BlueXP UI, click Protection > Backup and recovery > Applications.

  2. Click Discover Applications.

  3. Select Cloud Native and click Next.

    A service account (SnapCenter-account-<accountid>) with SnapCenter System role is created to perform scheduled data protection operations for all the users in this account.
    The service account (SnapCenter-account-<accountid>) is used to run the scheduled backup operations. You should never delete the service account.
    You can view the service account by clicking Account > Manage Account > Members.

  4. Select Oracle as the application type.

  5. In the Host details page, perform the following:

    1. Select Manual.

    2. Specify the FQDN or IP address of the host where the plug-in is installed.

      Ensure that using the FQDN or IP address, the Connector can communicate with the database host.

    3. Specify the plug-in port.

      Default port is 8145.

    4. Specify the sudo non-root (sudo) user using which the plug-in package will be copied to the host.

    5. Select the Connector.

    6. Select the check box to confirm that the plug-in is installed on the host.

    7. Click Next.

  6. In the Configuration page, perform the following:

    1. Configure sudo access for the SnapCenter user in the Oracle database host by logging in to the Linux machine running Oracle database.

    2. Copy the text displayed in BlueXP UI.

    3. Create the /etc/sudoers.d/snapcenter file on the Linux machine and paste the copied text.

    4. In the BlueXP UI, select the checkbox and click Next.

  7. Log into the Connector VM.

  8. Download the SnapCenter Linux host plug-in binary.
    sudo docker exec -it cloudmanager_scs_cloud curl -X GET 'http://127.0.0.1/deploy/downloadLinuxPlugin'

    The plug-in binary is available at: cd /var/lib/docker/volumes/service-manager[1]-2_cloudmanager_scs_cloud_volume/_data/$(sudo docker ps|grep -Po "cloudmanager_scs_cloud:.*? "|sed -e 's/ *$//'|cut -f2 -d":")/sc-linux-host-plugin

  9. Copy snapcenter_linux_host_plugin_scs.bin from the above path to /home/<non root user (sudo)>/.sc_netapp path for each of the Oracle database hosts either using scp or other alternate methods.

  10. Log into the Oracle database host using the non-root (sudo) account.

  11. Change directory to /home/<non root user>/.sc_netapp/ and run the following command to enable execute permissions for the binary.
    chmod +x snapcenter_linux_host_plugin_scs.bin

  12. Install the Oracle plug-in as a sudo SnapCenter user.
    ./snapcenter_linux_host_plugin_scs.bin -i silent -DSPL_USER=<non-root>

  13. Copy certificate.pem from <base_mount_path>/client/certificate/ path of the Connector VM to /var/opt/snapcenter/spl/etc/ on the plug-in host.

  14. Navigate to /var/opt/snapcenter/spl/etc and execute the keytool command to import the certificate.pem.
    keytool -import -alias agentcert -file certificate.pem -keystore keystore.jks -deststorepass snapcenter -noprompt

  15. Restart SPL: systemctl restart spl

  16. Validate that the plug-in is reachable from the Connector by running the below command from the Connector.
    docker exec -it cloudmanager_scs_cloud curl -ik https://<FQDN or IP of the plug-in host>:<plug-in port>/PluginService/Version --cert /config/client/certificate/certificate.pem --key /config/client/certificate/key.pem

  17. In the BlueXP UI, review the details and click Discover Applications.

    • After completing the discovery operation, all the databases on the host are displayed. If OS authentication is disabled for the database, click Configure to enable database authentication. For more information, refer to Configure Oracle database credentials.

    • Click Settings and select Hosts to view all the hosts.

    • Click Settings and select Policies to view the pre-canned policies. Review the pre-canned policies and you can either edit them to meet your requirement or create a new policy.

Configure Oracle database credentials

You should configure the database credentials that are used to perform data protection operations on Oracle databases.

Steps

  1. If OS authentication is disabled for the database, click Configure to modify database authentication.

  2. Specify the username, password, and the port details.

    If the database is residing on ASM, you should also configure the ASM settings.

    The Oracle user should have sysdba privileges and ASM user should have sysasm privileges.

  3. Click Configure.

Upgrade SnapCenter Plug-in for Oracle Database

You should upgrade the SnapCenter Plug-in for Oracle to gain access to the latest new features and enhancements. You can upgrade from the BlueXP UI or using the command line.

Before you begin

  • Ensure that there are no operations running on the host.

Steps

  1. Click Backup and recovery > Applications > Hosts.

  2. Verify if plug-in upgrade is available for any of the hosts by checking the Overall Status column.

  3. Upgrade the plug-in from UI or using the command line.

    Upgrade using UI Upgrade using command line

    1. Click icon to select the action corresponding to the host and click Upgrade Plug-in.

    2. In the Configuration page, perform the following:

      1. Configure sudo access for the SnapCenter user in the Oracle database host by logging in to the Linux machine running Oracle database.

      2. Copy the text displayed in BlueXP UI.

      3. Edit the /etc/sudoers.d/snapcenter file on the Linux machine and paste the copied text.

      4. In the BlueXP UI, select the checkbox and click Upgrade.

    1. Log in to Connector VM.

    2. Run the following script.
      sudo /var/lib/docker/volumes/service-manager-2_cloudmanager_scs_cloud_volume/_data/scripts/linux_plugin_copy_and_install.sh --host <plugin_host> --username <host_user_name> --sshkey <host_ssh_key> --pluginport <plugin_port> --sshport <host_ssh_port> --upgrade

      If you are using an older Connector, run the following command to upgrade the plug-in.
      sudo /var/lib/docker/volumes/cloudmanager_scs_cloud_volume/_data/scripts/linux_plugin_copy_and_install.sh --host <plugin_host> --username <host_user_name> --sshkey <host_ssh_key> --pluginport <plugin_port> --sshport <host_ssh_port> --upgrade