ajsembdbbackup
- Organization of this page
Format
ajsembdbbackup [-mh logical-host-name] [-i embedded-database-practical-directory] -d data-area-name -b backup-file-storage-directory [-s] [-id embedded-database-setup-ID]
Function
Acquires the backup of the embedded database.
This command is available when the embedded database is active.
Execution privileges
In Windows: Administrators privileges
In UNIX: Superuser privileges
Storage directory
- In Windows:
-
JP1/AJS3 - Manager-installation-folder\tools\
- In UNIX:
-
/opt/jp1ajs2/tools/
Arguments
-mh logical-host-name
Specification of this option is no longer necessary. The logical host name specified by this option is ignored.
-i embedded-database-practical-directory
Specify the embedded database directory. Use an absolute path to specify the directory. In Windows, to include space characters in the specified absolute path, enclose the path in double quotation marks ("). You must specify the same directory that you specify in the -i option of the ajsembdbbuild command. In UNIX, if you omit the -i option of the ajsembdbbuild command during the setup, you can omit this option.
If you do not specify this argument, /opt/jp1ajs2/embdb/_JF0 is assumed.
This option is provided for compatibility with versions earlier than 08-00. Normally, use the -id option.
If you specify both the -i option and the -id option, the value specified for the -i option takes precedence.
-d data-area-name
Specify the data area name of the embedded database. Use an absolute path to specify the directory. In Windows, to include space characters in the specified absolute path, enclose the path in double quotation marks ("). If you have specified the embedded database directory in the -d option of the ajsembdbbuild command, specify as follows:
- In Windows
-
directory-name-specified-in-the-d-option\ajssys02
- In UNIX
-
directory-name-specified-in-the-d-option/ajssys02
If you want to operate an embedded database created by using the jajs_setup or jajs_migrate command, use the ajsembdbidlist command to check the directory that contains the embedded database. For details on the ajsembdbidlist command, see ajsembdbidlist in 2. Commands Used during Setup.
- In Windows
-
[directory-name-displayed-by-the-ajsembdbidlist-command]\dbarea\ajssys02
- In UNIX
-
/var/opt/jp1ajs2/embdb/_JFn#/dbarea/ajssys02
If you operate the embedded database in a logical host environment set up by using the jajs_setup_cluster command, specify the value specified for the -d option.
- In Windows
-
[directory-name-specified-in-the-d-option]\jp1ajs2\embdb\_JFn#\dbarea\ajssys02
- In UNIX
-
[directory-name-specified-in-the-d-option]/jp1ajs2/embdb/_JFn#/dbarea/ajssys02
If you operate the embedded database in a logical host environment set up by using the jajs_setup_cluster command, specify the value specified for the -d option.
- For Windows
-
[directory-name-specified-in-the-D-option]\jp1ajs2\embdb\_JFn#\dbarea\ajssys02
- For UNIX
-
[directory-name-specified-in-the-D-option]/jp1ajs2/embdb/_JFn#/dbarea/ajssys02
- #
-
Specify the value specified for the -id option of this command. If you omit the -id option, specify _JF0.
-b backup-file-storage-directory
Specify the directory that stores the backup file. Use an absolute path to specify the directory. In Windows, to include space characters in the specified absolute path, enclose the path in double quotation marks (").
Create the directory that you are going to specify beforehand. If you specify a directory that does not exist, an error occurs.
The specified directory stores the following files:
-
Backup file
-
Processing output result file
File names are automatically assigned based on the following rules:
- When the -s option is specified
-
-
Backup file: BACK_XXXXYYZZVVWW.bk
-
Output result file: BACK_XXXXYYZZVVWW.log
-
- When the -s option is not specified
-
-
Backup file: BACK_MST_XXXXYYZZVVWW.bk
-
Output result file: BACK_MST_XXXXYYZZVVWW.log
XXXX: Year
YY: Month
ZZ: Day
VV: Hour
WW: Minutes
-
The amount of free space required for the backup file storage directory differs depending on the scale of the embedded database model as shown in the following table.
Database model |
Required free space |
---|---|
Large scale |
About 6,700 MB |
Medium scale |
About 1,400 MB |
Small scale |
About 200 MB |
If the database area has been expanded by using the ajsembdbaddarea command, additional free space equivalent to the area added by the expansion is required. Similarly, if the database auto-increment function is enabled, additional free space equivalent to the area added by the function is required.
For details about the database auto-increment function, see 23.2 Estimating the database area in the JP1/Automatic Job Management System 3 Configuration Guide.
-s
Specify this option when you specify to acquire the backup during operation.
If you acquire a backup of the embedded database, you will need an unload log file when you restore the database from the backup. Therefore, confirm that an unload log file is output. This file is output if the operating status of the automatic log unload functionality is set to ACTIVE by using the ajsembdboplog command. For details on the ajsembdboplog command, see ajsembdboplog in 3. Commands Used for Normal Operations.
-id embedded-database-setup-ID
Specify the setup identifier that identifies the embedded database in the _JFn format (n: 0-9 or A-Z). The value specified in this argument must be the same as the value specified in the -id option of the ajsembdbbuild command.
If you want to operate an embedded database created by using the jajs_setup, jajs_setup_cluster, and jajs_migrate commands, use the ajsembdbidlist command to check the setup identifier of the embedded database. For details on the ajsembdbidlist command, see ajsembdbidlist in 2. Commands Used during Setup.
If you omit this option, the system assumes _JF0.
If you specify both the -id option and the -i option, the -i option takes precedence.
Notes
-
Do not acquire the backup of an embedded database with a failure. If you do so, and then use that backup file for restoration, a problem might occur.
-
Execute this script while the embedded database is active.
-
If you execute this script while a job is being executed, the job might end abnormally. In such a case, re-execute the script when job execution load is low.
-
When you specify -s option and acquire the backup, ajsembdbrstr command requires the unload log file as the input information.
-
If you do not specify -s option and acquire the backup, make sure that the database is not updated before you backup the database.
-
If you attempt to back up the database when it has been updated, an error might occur.
-
To monitor the systemlog files status, use the ajsembdbstatus command with the -l option specified.
For details about the ajsembdbstatus commands, see the sections that cover these commands in 1. Commands. For details on the ajsembdbstatus command, see ajsembdbstatus in 3. Commands Used for Normal Operations.
-
The execution results of the command are output to the log file. The log file is stored in the following directories:
- For Windows, if the installation folder is the default installation folder or is in a folder protected by the system:
-
%ALLUSERSPROFILE%\Hitachi\JP1\JP1_DEFAULT\JP1AJS2\log
The default of the %ALLUSERSPROFILE% value is system-drive\ProgramData.
A folder protected by the system is the path to a folder in any of the following:
- system-drive\Windows
- system-drive\Program Files
- system-drive\Program Files (x86)
- For Windows, if the installation folder is other than the above:
-
JP1/AJS3-Manager-installation-folder\log
- For UNIX:
-
/var/opt/jp1ajs2/log
-
The file name is ajsembdbbackup.log. Since the contents of this file are not overwritten, the file size increases indefinitely. Evacuation or delete the contents of this file as necessary.
If this file does not exist, execute ajsembdbbackup command to create a new one.
-
If you do not specify the -s option, you can restore the embedded database by using only the backup file. Execute the command without -s when acquiring the backup in synchronization with JP1/AJS3.
-
If you use the backup file that is acquired by specifying the -s option to restore the embedded database, you need the unload log file as well. Use caution.
-
While you are executing the ajsembdbbackup command, a KFPS01278-W or KFPS01279-W warning message may appear.
If code=1601-0 is included in the KFPS01278-W message or code=1607-0 is included in the KFPS01279-W message, the backup operation is not affected.
-
Do not execute multiple instances of this command concurrently. If you do so, the following problems might occur:
-
A message output error occurs. For example, an incorrect message is output, or a message that should be output is not output.
-
This command incorrectly results in an error.
-
-
You cannot execute this command for an embedded database for which the backup enhancement function is enabled. If you do so, an error will occur.
Return values
0 |
Normal end |
Values other than 0 |
Abnormal end |
Actions to be taken if an error occurs
An error might occur when you execute ajsembdbbackup command. If an error occurs, read the following table and take appropriate action.
Message |
Cause |
Action to be taken |
---|---|---|
KFPS01280-E AJSEMBDBBACKUP:EmbedDB SYNC END (4) AJSEMBDBBACKUP:[ERROR]pdlogsync -d sys -w -t 180 |
The database cannot be backed up since the scheduler database is being updated. |
Wait until the job being executed ends, and then re-execute the command. |
KAVS0996-E |
|
Review the specified arguments, and then re-execute the command. |
KFPR26012-E |
The path specified in -d option is incorrect, or the user does not have read privileges for the folder indicated by the specified path. |
Revise the specified path and privileges, and then re-execute the command. If AJS administrators operate the system, make sure that the AJS administrators have the appropriate privileges. |
KFPR16003-E |
The path specified in -b option is incorrect, or the user does not have write privileges indicated by the specified path. |
Revise the specified path and privileges, and then re-execute the command. If AJS administrators operate the system, make sure that the AJS administrators have the appropriate privileges. |
KFPR26006-E Invalid parameter AAA exists at -m option in command line |
The host name specified in -mh option is invalid. |
Revise the host name and the specified arguments, and then re-execute the command. |
KFPS01984-E |
The path specified in -i option is not a absolute path. |
Revise the specified path, and then re-execute the command. |
Bad directory specified in -i option |
The path specified in the -i option is not the path for the embedded database practical directory, or the user does not have the appropriate privileges. Alternatively, the system has not been set up correctly. |
Specify the correct embedded database directory in -i option. Alternatively, revise the privileges, and then re-execute the command. If the embedded database directory is specified correctly, retry setup of the embedded database. If AJS administrators operate the system, make sure that the AJS administrators have the appropriate privileges. |
KAVS2104-E |
The setup ID specified in -id option is invalid or the embedded database is not set up. |
Check whether the setup ID specified in -id option is correct. |
KAVS8409-E |
The ajsembdbbackup command cannot be executed for an embedded database for which the backup enhancement function is enabled. |
To back up the embedded database for which the backup enhancement function is enabled, use the jajs_dbbackup command. |