9.6 npdatabackup command (back up environment)
Description
This command backs up environments for Navigation Platform.
This command can be executed only in the execution environment and the editing environment. Do not execute this command in the development environment.
This command must be executed while the system is stopped.
The following table lists and describes the data that can be backed up by this command.
No. |
Data |
Storage location |
---|---|---|
1 |
Data for Operational Contents |
backup-directory\contents.zip |
2 |
List of data for Operational Contents |
backup-directory\contentslist.txt |
3 |
Static files used in Operational Contents |
backup-directory\HNP\PP\uCPSB\httpsd\htdocs |
4 |
Settings files related to Navigation Platform (such as property files) |
backup-directory\HNP\conf |
Dashboard function access user management file |
||
5 |
Information about the Navigation Platform installation directory path |
backup-directory\installpath.txt |
6 |
Navigation Platform version information |
backup-directory\HNP\sysconf\ucnpversion.properties |
7 |
User Plugins and settings files# |
backup-directory\plugin_files |
8 |
User authentication settings files |
backup-directory\auth_conf\PP\uCPF\conf\Repository.xml |
backup-directory\auth_conf\PP\uCPSB\manager\conf\ua.conf |
Format
npdatabackupΔbackup-directory-path
You can specify an absolute path or a relative path for the directory. We recommend that you specify a path that is shorter than the Navigation Platform installation directory because if a specified path is too long, processing might fail.
Use backslashes (\) for the delimiters. If a path contains a single-byte space, enclose the entire path in double quotation marks ("). In addition to these symbols, the only other symbols permitted in directory paths are single-byte colons (:) and single-byte periods (.) that indicate relative paths.
Notes:
-
You must specify for the backup destination an empty directory with at least 30 MB of free space. If you use the following files, also include the sizes of those files when you allocate the space:
-
If static files are used in Operational Contents
Space for the files under Navigation-Platform-installation-directory\PP\uCPSB\httpsd\htdocs
-
If User Plugins are used
Space for the files under Navigation-Platform-installation-directory\plugin_files
-
-
This command uses the folder specified in the TMP environment variable as the work folder during execution. Allocate for the folder specified in the TMP environment variable at least 550 MB of free space.
-
Specify a drive other than a network drive in the backup directory path.
-
A short name cannot be used for a backup directory path.
-
When the command terminates normally (return code is 0), Navigation Platform remains stopped. You must execute the npstart command (start) to start Navigation Platform.
-
After the backup processing has been completed, do not change the contents or attributes of the directories and files in the backup directory. If any are changed, environment restoration processing cannot be guaranteed.
-
Before you move backup data, compress it by using a tool that can retain attributes and empty directories.
Return value
Return value |
Description |
---|---|
0 |
Navigation Platform environment backup processing was successful. |
1 |
Navigation Platform environment backup processing failed. |
2 |
A lock error occurred on the command. |
9 |
An execution permission error occurred. |
Example
This example assumes that the backup directory is C:\temp\backupdata:
> Navigation-Platform-installation-directory\bin\npdatabackup C:\temp\backupdata