9.7 npdatarestore command (restore environment)
Description
This command restores environments for Navigation Platform using the data that was backed up by the npdatabackup command (back up environment). Execute this command while the system is stopped.
This command can be executed only in the execution environment and the editing environment. Do not execute this command in the development environment.
The Navigation Platform version used during restoration must be the same as the Navigation Platform version used during backup.
When this command is executed, existing data is deleted or overwritten and replaced with the data that was backed up by the npdatabackup command. For details about the data that is backed up by the npdatabackup command, see Table 9-3 Data that is backed up.
- Data that is not restored by the npdatarestore command
-
The settings files for User Plugins and user authentication are not restored by this command because they need to be synchronized with other systems.
In addition, the files required by User Plugins that have been acquired separately and the data such as databases in the system that are linked with user programs cannot be restored by this command. If necessary, restore the data synchronously with the User Plugins.
Format
npdatarestoreΔbackup-data-storage-directory-path
We recommend that you use the backup directory specified during execution of the npdatabackup command as is as the backup data storage directory (restoration source directory).
You can specify for the directory an absolute path or a relative path. We recommend that you specify a path that is shorter than the Navigation Platform installation directory because if the 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:
-
The required amount of free space in the restoration environment depends on the number and contents of Operational Contents. If static files are used in the Operational Contents, you will have to allocate an amount of free space that is equal to or greater than the sizes of the directories under Navigation-Platform-installation-directory\PP\uCPSB\httpsd\htdocs.
-
Do not specify a network drive in the restoration source directory path.
-
A short name cannot be used for the restoration source directory path.
-
An error will occur if the directory specified as the restoration source contains data that has not been acquired by the npdatabackup command.
-
The version, revision, and restricted code of Navigation Platform must be the same for the restoration processing as they were for the backup processing.
You can determine the version information during backup processing by checking backup-directory\HNP\sysconf\ucnpversion.properties.
-
The Navigation Platform installation directory during backup processing must be the same as during restoration processing.
You can determine the installation directory when the backup data was acquired by checking backup-directory\installpath.txt.
-
Navigation Platform starts automatically when this command terminates normally (return code is 0), so there is no need to execute the npstart command (start).
-
If the Navigation Platform version has been upgraded, the npdatarestore command cannot be used to restore from the backup data that was acquired before the Navigation Platform version was upgraded because the version used to acquire the backup differs from the version of the restoration destination. In such a case, see 3.6.5 Upgrade procedure and then restore the backup data.
-
Navigation Platform starts when this command is executed. For details, see the notes in 5.1.1 Using commands to start Navigation Platform (system).
Return value
Return value |
Description |
---|---|
0 |
Navigation Platform environment restoration processing was successful. |
1 |
Navigation Platform environment restoration processing failed. |
2 |
A lock error occurred on the command. |
9 |
An execution permission error occurred. |
- Note:
-
The return value is undefined if the command is terminated by a cause beyond the command's control (such as when the command is terminated forcibly by pressing the Ctrl key and the C key at the same time).
Example
This example assumes that the restoration source directory is C:\temp\backupdata:
> Navigation-Platform-installation-directory\bin\npdatarestore C:\temp\backupdata