8.7.1 backupsystem (backing up the JP1/AO system)
Description
This command backs up the configuration and database information of JP1/AO to store the data in the specified folder.
Syntax
backupsystem /dir backup-data-path [/auto]
Arguments
- /dir backup-data-path
-
This option specifies the absolute or relative path to an empty folder in which backup data is collected and stored. A folder in the local disk drive can only be specified. We recommend that you use a path that has 50 or fewer characters.
- /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
-
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
-
Back up the data of JP1/Base before performing the backup with this command.
-
This command does not back up the following files (manual backup, as necessary, is required).
-
SSL server certificate file for HTTPS connection
-
Private key file for HTTPS connection
-
Private key file for public key authentication
-
-
If you do not specify the /auto option, then make sure that the JP1/AO services are not running before executing this command.
If the services are still running, execute the hcmdssrv command with the /stop option to stop the services.
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. |
11 |
The specified folder is not empty. |
14 |
You do not have permission to execute the command. |
100 |
Performing the backup failed. |
101 |
Starting or stopping the service failed. |
103 |
An access to the scheduler database failed. |
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 back up data in the specified backup folder:
backupsystem /dir "C:\Users\Backup" /auto
Related topics
-
Topic Backup and recovery in the manual Job Management Partner 1/Base User's Guide
-
Topic Property file (config_user.properties) in the Job Management Partner 1/Automatic Operation Configuration Guide