How do I back up the main database from a CLI?

Purpose

Perform this procedure to initiate an on-demand main database backup using CLI. You can perform only a full database backup from a CLI. To perform a partial backup, see How do I back up the main database from the client GUI?.

CAUTION 

CAUTION

Service Disruption

The disk partition that is to contain the database backup must have sufficient space for the database backup file set, or system performance may be compromised.

Ensure that the backup directory is at least five times as large as the expected database backup size. For more information, contact technical support or see the NSP Planning Guide.

Note: The NFM-P backs up the Oracle encryption wallet during a database backup, and restores the wallet during a database restore. In a redundant deployment, the NFM-P automatically replicates the encryption wallet from the primary to the standby database after the standby database reinstantiation.

Note: If the NFM-P system is not part of a shared-mode NSP deployment, a main database backup performed using the NFM-P client GUI also backs up the local Neo4j and PostgreSQL databases; a backup performed from a CLI does not.

Note: During a database backup, the performance of GUI or XML API operations may be affected. It is recommended that you perform a database backup only during a period of low NFM-P activity.

Steps
 
1 

Log in as the root user on the main database station.

Note: In a redundant NFM-P system, you must log in to the primary database station.

2 

Open a console window.

3 
CAUTION 

CAUTION

Data Loss

Before the NFM-P performs a database backup, it deletes the contents of the specified backup directory.

Ensure that the backup directory that you specify in this step does not contain files that you need to retain.

CAUTION 

CAUTION

Data Loss

The backup directory path must not include the main database installation directory, or data loss may occur.

Ensure that the directory path does not include /opt/nsp/nfmp/db.

Note: The Oracle management user requires read and write permissions on the backup directory. The user and group names are specified during database installation; the default is ‘oracle’ in the ‘dba’ group.

Perform one of the following.

  1. Enter the following to back up the database without using file compression:

    # sambackupDb backup_directory ↵

    where backup_directory is the absolute path of the directory that is to contain the database backup file set

  2. Enter the following to back up the database using file compression:

    # sambackupDb backup_directory compress ↵

    where backup_directory is the absolute path of the directory that is to contain the database backup file set

Note: Depending on the database size, a backup may take considerable time.

The database backup begins, and messages like the following are displayed as the backup progresses:

Backup log is /opt/nsp/nfmp/db/install/NFM-P_Main_Database.backup.yyyy.mm.dd-hh.mm.ss.stdout.txt

<date time> working..

<date time> Performing Step 1 of 4 - Initializing ..

<date time> Performing Step 2 of 4 - Backup archive logs ..

<date time> Performing Step 3 of 4 - Backup the database ...........

<date time> Performing Step 4 of 4 - Finalizing  .....

The following is displayed when the backup is complete:

<date time> Database backup was successful

DONE

4 

When the backup is complete, close the console window.

The database backup creates the following summary file in the same directory as the backup files:

BACKUP_SUMMARY.INFO

The summary file contains detailed backup information that includes the backup completion time, and the name and size of each backup file.

End of steps