1 Introduction
This document describes how to create a manual backup of a particular type (User Data or System Data), as defined in the backup manager, to be stored in a particular directory of the user file system.
IPWorks Backup and Restore Framework Participant (BRFP) is the User Data type in backup manager. For more detail, refer to Backup and Restore.
IPWorks supports to create a backup with MySQL data – IPWorks User Data complete backup.
IPWorks also supports to create a backup without MySQL data – IPWorks User Data partial backup.
- Note:
- The user needs to first check the storage capacity, then create backups.
1.1 Prerequisites
This section describes the prerequisites, which must be fulfilled before using the procedure.
1.1.1 Conditions
The following conditions must apply:
- The backup type is known: System Data or User Data.
- No other backup operation (create, delete, restore, and so forth) is in progress. If an operation is in progress, wait until it is completed before creating a backup.
- The backup type is known.
- The backup name is known.
- An Ericsson Command-Line Interface (ECLI) session in Exec mode is in progress.
- For IPWorks complete backup, make sure that the NDB is working normally. Otherwise, the backup operation fails.
- Only the system administrator can perform the operation.
2 Procedure
2.1 Create System Backup
To create a manual system backup, do the following:
- Navigate to the BrMBackupManager managed object, for example:
>dn ManagedElement=<Node Name>,SystemFunctions=1,BrM=1,BrmBackupManager=SYSTEM_DATA
- Start the manual backup operation.
BrmBackupManager=SYSTEM_DATA>createBackup <Backup Name>
- Note:
-
- The <Backup Name> can be a maximum of 50 characters. The alphanumeric, dash, and underscore characters are supported.
- To cancel the creation of a manual backup, type cancelCurrentAction.
- Verify that the backup was created.
BrmBackupManager=SYSTEM_DATA>show
Type show until result=SUCCESS is displayed in the progress report. After a backup is successfully created, the progress report shows the following:
actionName="CREATE" additionalInfo[] "Create Backup for <Backup Name>: Succeeded result=SUCCESS resultInfo="<Backup Name> was created successfully."
You can check the backup files by the command cd /cluster/brf/backup.
If an error occurs during the execution of the operation, attribute reportProgress shows result=FAILURE and resultInfo shows the cause of the failure.
For more information on the progress report, refer to View Progress Report.
2.2 Create User Backup
To create a manual user backup, do the following:
- Navigate to the BrMBackupManager managed object, for example:
>dn ManagedElement=<Node Name>,SystemFunctions=1,BrM=1,BrmBackupManager=USER_DATA
- Start the backup operation:
- Create a backup that does not include MySQL data, for
example:
(BrmBackupManager=USER_DATA)>createBackup --name "testBackup_20150616"
- Create a backup that includes MySQL data, for example:
(BrmBackupManager=USER_DATA)>createBackup --name "ndb_testBackup_20150616"
- Note:
-
- Regarding the backup name, if the backup includes MySQL data, the string "ndb" (not case sensitive) MUST be added in the backup name, for example "ndb_testBackup"; If the backup doesn't include MySQL data, the string "ndb" (not case sensitive) MUST not be added in the backup name, for example, "testBackup".
- The backup name can have up to 50 characters. Alphanumeric, dash, and underscore characters are supported.
The system returns output true or false.
- Create a backup that does not include MySQL data, for
example:
- Verify that the backup was created:
(BrmBackupManager=USER_DATA)>show -v
- Note:
- Since this is a long-running operation, it can be required to enter the command several times until the final operation result is shown in the progress report.
After a backup is successfully created, the progress report shows the following:
actionName="CREATE" additionalInfo "Create Backup for ndb_testBackup_20150616: Succeeded" progressInfo="" progressPercentage=100 result=SUCCESS resultInfo="ndb_testBackup_20150616 was created successfully." state=FINISHEDYou can check the backup files by the command cd /cluster/ipwbrf/backup/.
If an error occurs during the execution of the operation, attribute reportProgress shows result=FAILURE and resultInfo shows the cause of the failure.
For more information on the progress report, refer to View Progress Report.

Contents