jimdbbackup

Function

This command backs up the IM database. The following describes the purposes of making such a backup and the types of data that can be acquired.

Backup for error recovery

You must back up the database periodically in order to recover the database in the event of a database failure. The database backup targets are the integrated monitoring database area, the IM Configuration Management database area, and the system database areas.

Backup for expansion

When you are preparing to expand the size of the database, you must temporarily back up the database's data. The database backup targets are the integrated monitoring database area and the IM Configuration Management database area.

To Page Top

Format

jimdbbackup -o backup-file-name
            -m {MAINT|EXPAND}
              [-h logical-host-name]
              [-q]

To Page Top

Execution permission

In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)

In UNIX: Superuser permissions

To Page Top

Storage directory

In Windows:

Manager-path\bin\imdb\

In UNIX:

/opt/jp1imm/bin/imdb/

To Page Top

Arguments

-o backup-file-name

Specifies the absolute path name of the file to which the database is to be backed up. You must specify a logical drive or a backup file. This option is mandatory.

An error results if you specify a network drive, a UNC path, or a Windows reserved device file. If the specified backup file already exists, the existing file will be overwritten.

Make sure that the value you specify for backup-file-name includes a file path. The characters permitted for the file name are alphanumeric characters, the underscore (_), dot (.), hash mark (#), and at mark (@). The character set also depends on the OS. If the name contains a space or a parenthesis (( or )), the entire name must be enclosed in double-quotation marks ("). In Windows, the backup file name when MAINT is specified must be in all lowercase letters. The maximum length of the file name depends on OS limitations.

If the directory for storing the specified backup file is not found, command execution fails. Make sure that you create the directory before you execute the command.

-m {MAINT|EXPAND}

Specifies the database backup format. The permitted characters are uppercase letters. This option is mandatory.

• MAINT: Specifies a backup for error recovery

• EXPAND: Specifies a backup for expansion

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name of the host where the command is executed. The command backs up the database that corresponds to the specified logical host. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed. Note that this logical host name cannot be JP1_DEFAULT. In addition, the logical host name is case sensitive.

-q

Specifies that the command is to be executed without requesting confirmation from the user.

To Page Top

Return values

To Page Top

Notes

• Before you execute this command, make sure that the execution conditions for the jimdbrecovery command are satisfied.

• If you execute another JP1/IM - Manager command or start a JP1/IM - Manager service while this command is executing, execution may fail because this command places the database in the mode that disables referencing and updating.

• While this command is executing, do not press Ctrl +C or Ctrl + Break. Because the command executes backup processing in the background, the backup processing will continue even though Ctrl +C or Ctrl + Break is pressed. If you press Ctrl +C or Ctrl + Break and then immediately attempt to execute another JP1/IM - Manager command or start a JP1/IM - Manager service, execution of the requested command or startup of the requested service may fail.

  If you have canceled command execution by pressing Ctrl + C or Ctrl + Break, first make sure that the following process is not executing, and then re-execute the command:

  • pdcopy process if you are performing a backup for error recovery

  • pdrorg process if you are performing a backup for expansion

• The jimdbbackup command creates a backup file during execution. In the case of a backup for expansion or a backup for error recovery, the amount of free space that is needed on the drive where the backup file is to be output is about 2 gigabytes for a small database, about 15 gigabytes for a medium-sized database, and about 50 gigabytes for a large database.

• When the IM database is used, JP1/IM - Manager must not be running.

• In Windows, the IM database (JP1/IM2-Manager DB Server) must be running, and the cluster service for the IM database (JP1/IM2-Manager DB Cluster Service_logical-host-name) must be stopped.

• A backup file for recovery cannot be distinguished from a backup file for expansion. We recommend that you name the backup files so that you can distinguish between the types of backup files.

• At the time a backup file is output, it is in a status in which any user can access it. We recommend that immediately after you have made a backup, you change the access permissions or move the file to a protected location so that unauthorized users cannot access it.

• If you are using JP1/IM - MO, the JP1/IM - Message Optimizer service of JP1/IM - MO on the connection source must be stopped.

• Before executing the command in Windows, in case of existing the Application Experience service, make sure that the startup type of the Application Experience service is not set to Disabled.

To Page Top