1.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] [/noCommonConf]
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.
- /noCommonConf
-
Specify this option to reduce the backup processing time. If you specify this option, the Common Component configuration file is not backed up.
Note that the restoresystem command does not use the Common Component configuration file.
Located in
- In Windows:
JP1/AO-installation-folder\bin
- In Linux:
/opt/jp1ao/bin
Execute permission
Execute the command as a user with Administrator or root permissions. If a user without Administrator or root permissions executes the command, a message appears asking the user to elevate the permission level.
Remarks
-
Make sure that the backup folder has a sufficient free space. The required free space is as follows:
Total size of the files to be backed up * 2 * 1.2+20 MB
As a measure of total size of the files to be backed up, total capacity of each folder below.#1
Total size of the files to be backed up is required as the free space of the temporary file when the restoresystem command is executed.
Table 1‒11: Windows non-cluster configuration Product name
Folder
JP1/AO
All the files and folders in JP1/AO-installation-folder\conf
All the files and folders in JP1/AO-installation-folder\contents
All the files and folders in JP1/AO-installation-folder\system
All the files and folders in JP1/AO-installation-folder\data
All the files and folders in JP1/AO-installation-folder\develop
Common Component
All the files and folders in system-drive\Program Files\Hitachi\HiCommand\database#2
Table 1‒12: Windows cluster configuration Product name
Folder
JP1/AO
All the files and folders in shared-folder-name\jp1ao\conf
All the files and folders in shared-folder-name\jp1ao\contents
All the files and folders in shared-folder-name\jp1ao\system
All the files and folders in shared-folder-name\jp1ao\data
All the files and folders in shared-folder-name\jp1ao\develop
Common Component
All the files and folders in shared-folder-name\Base64\database
Table 1‒13: Linux non-cluster configuration Product name
Folder
JP1/AO
All the files and folders in /opt/jp1ao/conf
All the files and folders in /var/opt/jp1ao/contents
All the files and folders in /var/opt/jp1ao/data
All the files and folders in /var/opt/jp1ao/develop
All the files and folders in /opt/jp1ao/system
Common Component
All the files and folders in /var/opt/HiCommand/database
Table 1‒14: Linux cluster configuration Product name
Folder
JP1/AO
All the files and folders in shared-folder-name/jp1ao/conf
All the files and folders in shared-folder-name/jp1ao/contents
All the files and folders in shared-folder-name/jp1ao/data
All the files and folders in shared-folder-name/jp1ao/develop
All the files and folders in shared-folder-name/jp1ao/system
Common Component
All the files and folders in shared-folder-name/Base64/database
- #1:
- If the Hitachi Command Suite products are installed, in addition to this backup Hitachi Command Suite product files and folders.
- #2:
- If you change the JP1/AO database installation folder, it changes the system-drive\Program Files\Hitachi\HiCommand\database path.
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
Cluster service control command that was created (in a Linux cluster configuration)
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 hcmds64srv 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 database failed. |
255 |
The command execution has been interrupted due to an error other than the above. |
Example
The following example shows how to use the command to back up, in Windows, data in the specified backup folder (C:\Users\Backup):