Backup or Restore Databases

Use the tasks in this section to backup or restore the OCSDM server application and reporting databases.

Backup Command Options

Use the following command line options when issuing the backup script in the following sections to specify your database and backup destination:

--all —(Default) Backs up the core database and all reporting databases. This flag is used if no other is entered.

--core —Backs up the core database only.

-d —Specifies the directory to store the backed up file.

--excludePlugins —Exclude archived Plugin zip files from the resulting backup file. By default, the resulting backup file contains all product plugin installation zip files which were previously uploaded to OCSDM. You can override this behavior by entering this command.

-ep —Same as the --excludePlugins command line option above.

--report —Backs up the reporting oracle database and repository.

--ocsdmdw —Backs up the ocsdmdw oracle database.

Note:

You are prompted to select the backup directory upon running a backup script. The default directory can be found at: <Installation directory>/../DatabaseBackup

Backup Databases on a Shutdown Server

The following sections describe how to backup the application database on an OCSDM server that is shutdown (cold backup).

Note:

You must have system administrator privileges on the server to do a database backup.

The OCSDM database and a separate database for reporting (if you are using Oracle Communications Report Manager with OCSDM) runs on each cluster node. During a typical database backup, the backup for each of these database is done on the master node and the backup file is stored on the node running the backup only.

Shut Down the Session Delivery Manager Server

You can shut down the existing Oracle Communications Session Delivery Manager software version running on your system to install a new version of the software, restore a database or apply a software patch. If you are upgrading an OCSDM cluster, use these steps to shut down each server node in the cluster.

Login to your server as the nncentral user.
Navigate to the OCSDM installation bin directory.
For example:
```
cd /<sdm-install-directory>/AcmePacket/NNC<version>/bin
```
Run the shutdownnnc.sh script. By default, the shutdownnnc.sh script detects whether the existing installation is a standalone or clustered system and prompts you with the option to shut down the entire cluster if no flag options are provided.
Note:
However, You can script an option ahead of time by adding -local for single nodes and -cluster to shutdown an entire cluster.
```
./shutdownnnc.sh
Shutdown back-end server
Do you wish to shut down the entire cluster (Yes/No)? Yes
```

Backup the Database on the Shutdown Server

Use this task to do a backup the application database (Core DB), Oracle reporting database, and OCSDMDW reporting database on the shut down OCSDM server (cold backup) to a local directory path.

If you are using Oracle Communications Report Manager, you must shut down the Oracle BI Publisher database instance and Oracle Report Manager database instance (OCSDMDW) before you do the cold backup of the database. See the Report Manager Administrator Operations chapter in the Oracle Communications Report Manager Installation Guide for more information about stopping these database instances.
Login to the server as the nncentral user.
Change to the bin directory. For example:
```
cd /home/nncentral/AcmePacket/NNC8x/bin/
```
Enter the backupdbcold.sh script.

Note:
The backupdbcold.sh -- help script provides all of the arguments that you can use.
```
./backupdbcold.sh
```
- You can use the following arguments with this script:
  - -d —Use this argument to select a local directory that you want to store backup archives. For example:
```
./backupdbcold.sh -d/home/nncentral/AcmePacket/<Directory>/NNC8x_ColdBackup_yyyy_mm_dd_<number>_all.tar
```
  - -a, --all — Use this argument to run all backups and store them as a single archive.
```
./backupdbcold.sh --all
```
  - -c --core — Use this argument to backup the core application database and store it as an individual archive.
```
./backupdbcold.sh --core
```
  - -r --report — Use this argument to backup the reporting Oracle database and repository and store as an individual archive.
```
./backupdbcold.sh --report
```
  - -o --ocsdmdw — Use this argument to backup the (Oracle Communications Session Delivery Manager Data Warehouse (OCSDMDW) database and store as an individual archive.
```
./backupdbcold.sh --ocsdmdw
```
  - -ep, --excludePlugins —Use this argument to exclude archived plugin zip files from the resulting backup file. By default, the resulting backup file contains all product plugin installation zip files which were previously uploaded to OCSDM. You can override this behavior by entering this command.
```
./backupdbcold.sh --excludePlugins
```
After the script runs, the output displays a section called Backup Results. The output shows if the core OCSDM application database and reporting databases are successfully backed up to the default DatabaseBackup directory. The following example shows the directory on which the application database file was backed up:
```
/home/nncentral/AcmePacket/DatabaseBackup/NNC8x_ColdBackup_yyyy_mm_dd_<number>_all.tar
```
Note:
If you do not have reporting configured on the OCSDM server, the output shows that the reporting databases failed to be backed up.
Execute the startnnc.sh script.

Note:
With the introduction of Oracle Communications Session Delivery Manager, Release 8.0, you must select one server to start in the cluster only. Once this server is started and operational, you can start the other server(s) in the cluster.
```
./startnnc.sh
```
The console displays the number of services started. After all services have started, the system is ready for use. Do not attempt to log in until the console has indicated that the web servers are up.
If you are using Oracle Communications Report Manager and have shut down the Oracle BI Publisher database instance and Oracle Report Manager database instance (OCSDMDW), you must start them again. See the Report Manager Administrator Operations chapter in the Oracle Communications Report Manager Installation Guide for more information about starting these database instances.

The OCSDM plugin service always tries to synchronize itself with other cluster nodes when the server starts. This allows a node that was previously down, become current if it missed an upload, or an uninstall event.

Next Steps

Select Tools, and view the Heartbeat Summary table to check OCSDM cluster member node processes.
Begin using OCSDM. Use your web browser to navigate to the server login page by entering the host name or IP address, and port number in the web browser navigation bar. For example:
```
http://example.com:8080
```
In the login page, enter the administrator login name and password that you configured in the Configure User Account Passwords section.

Backup Databases on a Running Server

Use this task to do a backup the application database (Core DB), Oracle reporting database, and OCSDMDW reporting database on the OCSDM server that is running (hot backup) to a local directory path.

Note:

Before you backup databases on the OCSDM server, ensure that you have system administrator privileges, and contact users to minimize or prevent them from using OCSDM during the backup.

Login to the server as the nncentral user.
Change to the bin directory. For example:
```
cd /home/nncentral/AcmePacket/NNC8x/bin/
```
Enter the backupdbhot.sh script to backup the application and reporting databases.

Note:
The backupdbhot.sh -- help script provides all of the arguments that you can use.
```
./backupdbhot.sh
```
- You can use the following arguments with this script:
  - -d —Use this argument to select a local directory that you want to store backup archives. For example:
```
./backupdbhot.sh -d/home/nncentral/AcmePacket/<Directory>/NNC8x_HotBackup_yyyy_mm_dd_<number>_all.tar
```
  - -a, --all — Use this argument to run all backups and store them as a single archive.
```
./backupdbhot.sh --all
```
  - -c --core — Use this argument to backup the core application database and store it as an individual archive.
```
./backupdbhot.sh --core
```
  - -r --report — Use this argument to backup the reporting Oracle database and repository and store as an individual archive.
```
./backupdbhot.sh --report
```
  - -o --ocsdmdw — Use this argument to backup the (Oracle Communications Session Delivery Manager Data Warehouse (OCSDMDW) database and store as an individual archive.
```
./backupdbhot.sh --ocsdmdw
```
  - -ep, --excludePlugins —Use this argument to exclude archived plugin zip files from the resulting backup file. By default, the resulting backup file contains all product plugin installation zip files which were previously uploaded to OCSDM. You can override this behavior by entering this command.
```
./backupdbhot.sh --excludePlugins
```
After the script runs, the output displays a section called Backup Results. The output shows if the core OCSDM application database and reporting databases are successfully backed up to the default DatabaseBackup directory. The OCSDM plugin service always tries to synchronize itself with other cluster nodes when the server starts. This allows a node that was previously down, become current if it missed an upload, or an uninstall event.The following example shows the directory on which the application database file was backed up:
```
/home/nncentral/AcmePacket/DatabaseBackup/NNC8x_HotBackup_yyyy_mm_dd_<number>_all.tar
```
Note:
If you do not have reporting configured on the OCSDM server, the output shows that the reporting databases failed to be backed up.

Next Steps

Select Health Monitor, and view the Heartbeat Summary table to check OCSDM cluster member node processes.
Begin using OCSDM. Use your web browser to navigate to the server login page by entering the host name or IP address, and port number in the web browser navigation bar. For example:
```
http://example.com:8080
```
In the login page, enter the administrator login name and password that you configured in the Configure User Account Passwords section.

Restore Databases

Use this task if you need to restore the application and reporting databases on your OCSDM system or cluster.

Change to the bin directory. For example:

cd /home/nncentral/AcmePacket/NNC<version>/bin

Execute the shutdownnnc.sh script. By default, the shutdownnnc.sh script detects whether the existing installation is a standalone or clustered system and prompts you with the option to shut down the entire cluster if no flag options are provided.
Note:
You can script an option ahead of time by adding -local for single nodes and -cluster to shutdown an entire cluster.
```
./shutdownnnc.sh
Shutdown back-end server
Do you wish to shut down the entire cluster (Yes/No)? Yes
```
If you want to perform a backup of the application or reporting databases on the running OCSDM server (hot backup), see the Backup the Database on a Running Server section for more information, and skip to step 5.

Note:
As of release 8.2.1, the current database and target database must have the same value for R226 compliance. Attempting to restore the OCSDM, where current and target databases have different R226 compliance values, results in the SDM being in an inconsistent state. To ensure you retain the values from the current database, it is important to execute a database backup prior to beginning the restoration process. Note that you cannot change the R226 compliance value without a complete reinstallation.
If you want to perform a backup of the application or reporting databases on a shut down server (cold backup) see the Backup the Database on a Shutdown Server for more information, and skip to step 5.
If you need to restore the application database only (you are not using the reporting databases) on your OCSDM system, enter the restoredb.sh script followed by the directory in which the backup application database is stored. For example:
```
./restoredb.sh -f/home/nncentral/AcmePacket/NNC8x/bin/NNC<version>_Backup_2017_04_19.tar.gz
```
If you need to restore the application database and the reporting databases on your OCSDM system, enter the restoredb.sh script followed by the directory in which the backup application database is stored, and specify the Oracle reporting database password and OCSDMDW reporting database password:
```
./restoredb.sh -f/home/nncentral/AcmePacket/NNC8x/bin/NNC<version>_Backup_2017_04_19.tar.gz -z my_report_db_password -y my_ocsdmdw_db_password
```
If you are using Oracle Communications Report Manager and have shut down the Oracle BI Publisher database instance and Oracle Report Manager database instance (OCSDMDW), you must restart them. See the Report Manager Administrator Operations chapter in the Oracle Communications Report Manager Installation Guide for more information about starting these database instances.
Execute the startnnc.sh script. For example:
```
./startnnc.sh
```
The console displays the number of services started. After all services have started, the system is ready for use. Do not attempt to log in until the console has indicated that the web servers are up.

Next Steps

Select Tools, Health Monitor and view the Heartbeat Summary table to check OCSDM cluster member node processes.
Begin using OCSDM. Use your web browser to navigate to the server login page by entering the host name or IP address, and port number in the web browser navigation bar. For example:
```
http://example.com:8080
```
In the login page, enter the administrator login name and password that you configured in the Configure User Account Passwords section.
After the server starts (after the restoration of its databases), it attempts to synchronize all plugins installed on the local file system again. Select Tools, Plugin Management in the OCSDM GUI to ensure that all plugins are working properly in the Element Manager Plugins table.