8.7.6 restoresystem (restoring the JP1/AO system)

Description

This command restores the backup data, such as the configuration and database information of JP1/AO, obtained by the backupsystem command.

The following list shows the data restored when the command is executed:

• Tasks^#

• Debug tasks^#

• Task histories

• Services

• Debug services

• Service templates

• Users

• User groups

• Resource groups

• Connection destination definitions

• Shared service properties

• Various definition files

#

In restored tasks and debug tasks, some of the detailed information, such as the progress and list of steps, is deleted. In addition, the status of those tasks is changed after restoration as follows.

Table 8‒12: Status of tasks and debug tasks at backup time and after restoration

Status of tasks and debug tasks at backup time	Status of tasks and debug tasks after restoration
Waiting	Canceled (The end date and time of the tasks and debug tasks are set to the date and time of restoration.)
Holding
In Progress	Failed
Waiting for Response
Abnormal Detection
Terminated
Completed	Completed
Failed	Failed
Canceled	Canceled

Syntax

restoresystem
     /dir backup-data-path
     /jp1user JP1-user-name
     [/auto]

Arguments

/dir backup-data-path

This option specifies the absolute or relative path to the backup folder that stores the backup data specified in the backupsystem command.

/jp1user JP1-user-name

This option specifies the JP1 user name that had already been registered when the data was backed up.

/auto

This option causes the command to automatically start and stop the services and databases of JP1/AO and the Hitachi Command Suite products. If this option is omitted, the services and databases of JP1/AO and the Hitachi Command Suite products are not automatically started and stopped.

If you want to use this option in a cluster environment, services registered with the cluster software must be offline.

Located in

JP1/AO-installation-folder\bin

Execute permission

Execute the command as a user with Administrator permissions. If a user without Administrator permissions executes the command, a message appears asking the user to elevate the permission level.

Remarks

• Executing this command creates a temporary file. For this reason, make sure that the folder in which backup files are stored has a sufficient free space. The required free space is as follows:

  Total size of the files to be backed up + 20 MB

• Restore the data of JP1/Base before performing the restoration with this command.

• This command does not restore the files below. Manually set the following files again if necessary:

  • SSL server certificate file for HTTPS connection

  • Private key file for HTTPS connection

  • Private key file for public key authentication

  Place the files for HTTPS connection in a location defined in the httpsd.conf file, and place the file for public key authentication in a location defined in the property file (config_user.peroperties).

• If you do not specify the /auto option, then make sure that JP1/AO services are not running before executing this command.

  If these services are still running, execute the hcmdssrv command with the /stop option to stop the services.

• If a JP1 user name other than the user name already registered when the data was backed up is specified for the /jp1user option, set the specified JP1 user after restoration. You can do this by changing the values for JP1 user name and JP1 user password in the Service Share Properties view to those of the JP1 user specified in the command.

• Be careful if the JP1/AO installation path includes half-width space characters. If there is a file or folder whose path is the same as the string before the first space character in that path, the restoresystem command will fail with return code 114. If this happens, move that file or folder to a different path, re-install JP1/AO, and then execute the restoresystem command again.

  For example, assume that JP1/AO is installed in C:\Program Files (x86)\HITACHI\JP1AO. In this case, the restoresystem command will fail if there is a file or folder whose path is C:\Program.

• In the restored tasks and debug tasks, the following operations cannot be selected:

  • Retry the Task From the Failed Step

  • Retry the Task From the Step After the Failed Step

• In the restored tasks and debug tasks, the progress and status of the step are not displayed.

Return code

The following table lists the return codes from the command.

Return code	Description
0	The command succeeded.
1	The argument is invalid.
2	The command execution has been interrupted.
3	The service status is invalid.
4	One of the other commands is running.
7	An invalid path is specified.
9	The specified path does not exist.
10	The specified path is not accessible.
14	You do not have permission to execute the command.
110	Performing the restoration failed.
111	Starting or stopping the service failed.
113	The backup file is invalid.
114	An access to the scheduler database failed.
116	The specified JP1 user does not have permission to set up the task-processing engine.
255	The command execution has been interrupted due to an error other than the above.

Example

The following command shows an example of how to restore data in the specified backup folder:

restoresystem /dir C:\Users\Backup /jp1user JP1_AO_Admin /auto

Related topics

• 8.7.1 backupsystem (backing up the JP1/AO system)

• Topic Backup and recovery in the Job Management Partner 1/Base User's Guide

• 8.3 Valid characters for arguments in a command

• Topic Properties file (config_user.properties) in the Job Management Partner 1/Automatic Operation Configuration Guide

To Page Top