jpctool db backup

Format

jpctool db backup   -id service-ID
                   [-host host-name]
                   [-lhost logical-host-name]
                   [-d directory]
                   [-partial startday,endday[,[dbid]
                       [,[recname][,[drawer]]]]]
                   [-direct]
                   [-alone]

To Page Top

Function

The jpctool db backup command creates a backup file of the data stored in the Master Store, Agent Store, or Remote Monitor Store service database.

The default execution of this command creates the following files:

For full backup

• When backing up the data stored in the Master Store service database

  • Windows: installation-folder\mgr\store\backup\generation-number^#1\database-ID^#2.DB

  • UNIX: /opt/jp1pc/mgr/store/backup/generation-number^#1/database-ID^#2.DB

• When backing up the data stored in the Agent Store service database when Store version 1.0 is used

  • Windows: installation-folder\xxxx^#3\store[\instance-name]^#4\backup\generation-number^#1\database-ID^#2.DB

  • UNIX: /opt/jp1pc/xxxx^#3/store[/instance-name]^#4/backup/generation-number^#1/database-ID^#2.DB

• When backing up the data stored in the Agent Store and Remote Monitor Store service database when Store version 2.0 is used

  • Windows: Under installation-folder\xxxx^#3\store[\instance-name]^#4\backup\generation-number^#1, the following backup files are created:

    • STPI\summary-separator\year\month-day\generation-number^#5\record-name.DB^#6

    • STPI\summary-separator\year\month-day\generation-number^#5\record-name.IDX^#6

    • STPD\year\month-day\generation-number^#5\record-name.DB^#6

    • STPD\year\month-day\generation-number^#5\record-name.IDX^#6

    • STPL\year\month-day\generation-number^#5\record-name.DB^#6

    • STPL\year\month-day\generation-number^#5\record-name.IDX^#6

    • STAM.DB

    • STAM.IDX

    • STDC.DB

    • STDC.IDX

    • STDM.DB

    • STDM.IDX

    • STPA.DB

    • STPA.IDX

    • STPH.DB

    • STPH.IDX

    • STPT.DB

    • STPT.IDX

    • jpcsto.ini

    • STDICT.DAT

    • STRULES.DAT

  • UNIX: Under /opt/jp1pc/xxxx^#3/store[/instance-name]^#4/backup/generation-number^#1, the following backup files are created:

    • STPI/summary-separator/year/month-day/generation-number^#5/record-name.DB^#6

    • STPI/summary-separator/year/month-day/generation-number^#5/record-name.IDX^#6

    • STPD/year/month-day/generation-number^#5/record-name.DB^#6

    • STPD/year/month-day/generation-number^#5/record-name.IDX^#6

    • STPL/year/month-day/generation-number^#5/record-name.DB^#6

    • STPL/year/month-day/generation-number^#5/record-name.IDX^#6

    • STAM.DB

    • STAM.IDX

    • STDC.DB

    • STDC.IDX

    • STDM.DB

    • STDM.IDX

    • STPA.DB

    • STPA.IDX

    • STPH.DB

    • STPH.IDX

    • STPT.DB

    • STPT.IDX

    • jpcsto.ini

    • STDICT.DAT

    • STRULES.DAT

#1

Generation numbers are assigned sequentially beginning with 01. The maximum generation number is the value specified in Backup Save in the jpcsto.ini file. The default maximum generation number is 05. However, when you directly specify the backup directory, directories with generation numbers are not created. The backup data is written under the specified directory.

#2

The following are the specifiable database IDs:

• PI: PI record-type Agent Store and Remote Monitor Store service database

• PD: PD record-type Agent Store and Remote Monitor Store service database

• PL: PL record-type Agent Store and Remote Monitor Store service database

• PA: Master Store service database

#3

xxxx denotes the service key of a PFM - Agent or PFM - RM. For details about the service key, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.

#4

A directory with instance names is for a PFM - Agent or PFM - RM that monitors an application program that can start a set of multiple services at the same host.

#5

Either [001] or [002] is assigned.

#6

The record-name item indicates PI_LOGD, PD_PDI, PL_MESS, or other Agent record name.

For partial backup (Store version 2.0 only)

• When backing up a part of the data stored in the Agent Store and Remote Monitor Store service database

  Backup files are created according to the records being collected and the -partial option specification.

  • Windows: Under installation-folder\xxxx^#1\store\instance-name^#2\partial, the following backup files are created:

    • STPI\summary-separator\year\month-day\generation-number^#3\record-name.DB^#4

    • STPI\summary-separator\year\month-day\generation-number^#3\record-name.IDX^#4

    • STPD\year\month-day\generation-number^#3\record-name.DB^#4

    • STPD\year\month-day\generation-number^#3\record-name.IDX^#4

    • STPL\year\month-day\generation-number^#3\record-name.DB^#4

    • STPL\year\month-day\generation-number^#3\record-name.IDX^#4

    • STAM.DB

    • STAM.IDX

    • STDC.DB

    • STDC.IDX

    • STDM.DB

    • STDM.IDX

    • STPA.DB

    • STPA.IDX

    • STPH.DB

    • STPH.IDX

    • STPT.DB

    • STPT.IDX

    • jpcsto.ini

    • STDICT.DAT

    • STRULES.DAT

  • UNIX: Under /opt/jp1pc/xxxx^#1/store/instance-name^#2/partial, the following backup files are created:

    • STPI/summary-separator/year/month-day/generation-number^#3/record-name.DB^#4

    • STPI/summary-separator/year/month-day/generation-number^#3/record-name.IDX^#4

    • STPD/year/month-day/generation-number^#3/record-name.DB^#4

    • STPD/year/month-day/generation-number^#3/record-name.IDX^#4

    • STPL/year/month-day/generation-number^#3/record-name.DB^#4

    • STPL/year/month-day/generation-number^#3/record-name.IDX^#4

    • STAM.DB

    • STAM.IDX

    • STDC.DB

    • STDC.IDX

    • STDM.DB

    • STDM.IDX

    • STPA.DB

    • STPA.IDX

    • STPH.DB

    • STPH.IDX

    • STPT.DB

    • STPT.IDX

    • jpcsto.ini

    • STDICT.DAT

    • STRULES.DAT

#1

xxxx denotes the service key of a PFM - Agent or PFM - RM. For details about the service key, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.

#2

A directory with instance names is for a PFM - Agent or PFM - RM that monitors an application program that can start a set of multiple services at the same host.

#3

Either [001] or [002] is assigned.

#4

The record-name item indicates PI_LOGD, PD_PDI, PL_MESS, or other Agent record name.

To Page Top

Hosts that can execute the command

• PFM - Manager

• PFM - Agent^#

• PFM - RM^#

#

The command can be executed only when the -alone or -direct option is specified.

To Page Top

Execution permission

In Windows:

• User with Administrators permissions

• User with Backup Operators permission

In UNIX:

User with root user permissions

To Page Top

Installation directory

In Windows:

installation-folder\tools\

In UNIX:

/opt/jp1pc/tools/

To Page Top

Arguments

To Page Top

Disk space required to execute this command

This command creates a temporary file during execution. For the amount of disk space that is required to execute this command, see the appendix in the JP1/Performance Management Planning and Configuration Guide.

To Page Top

About deletion of unnecessary backup data

The following describes which directories and files you can delete when deleting backup data that is no longer needed.

Note that the following description applies in an environment in which backup data is saved in the system-managed backup directory for the Store database (that is, the -d option is not specified). In an environment in which backup data is saved in a user directory (specified by the -d option), all backup data, including that directory, can be deleted.

For full backup:

• Master Store service backup data that can be deleted

  • Windows: Folders and files under installation-folder\mgr\store\backup\generation-number\

  • UNIX: Directories and files under /opt/jp1pc/mgr/store/backup/generation-number/

• Agent Store service backup data that can be deleted if the Store version is 1.0

  Note that this description assumes that the Store database's default backup directory that was set initially has not been changed. If the default backup directory has been changed by using the jpcconf db define command, replace the path before the backup directory with the path of the new default backup directory.

  • Windows: Folders and files under installation-folder\service-key\store[\instance-name]\backup\generation-number\

  • UNIX: Directories and files under /opt/jp1pc/service-key/store[/instance-name]/backup/generation-number/

• Agent Store and Remote Monitor Store service backup data that can be deleted if the Store version is 2.0

  Note that this description assumes that the Store database's default backup directory that was set initially has not been changed. If the default backup directory has been changed by using the jpcconf db define command, replace the path before the backup directory with the path of the new default backup directory.

  • Windows: Folders and files under installation-folder\service-key\store[\instance-name]\backup\generation-number\

  • UNIX: Directories and files under /opt/jp1pc/service-key/store[/instance-name]/backup/generation-number/

Partial backup (available only when the Store version is 2.0)

• Agent Store and Remote Monitor Store services backup data that can be deleted

  Note that this description assumes that the Store database's default backup directory that was set initially has not been changed. If the default backup directory has been changed by using the jpcconf db define command, replace the path before the partial directory with the path of the new default backup directory.

  • Windows: Folders and files under installation-folder\service-key\store[\instance-name]\partial\

  • UNIX: Directories and files under /opt/jp1pc/service-key/store[/instance-name]/partial/

To Page Top

Notes

• Arguments must be specified in the order that they appear in the description. Otherwise, they will not be recognized correctly.

• This command cannot be executed in the following cases:

  • The Name Server service, Master Manager service, or the specified Master Store service, Agent Store, or Remote Monitor Store service is stopped.

  • The data in the database of the specified Master Store, Agent Store, or Remote Monitor Store service is currently being backed up.

  • The data in the database of the specified Master Store, Agent Store, or Remote Monitor Store service is currently being exported.

• If you execute multiple instances of the jpctool db backup or jpctool db dump command on separate hosts concurrently, make sure that you specify the -direct or -alone option. To execute backup or export processing more than once, make sure that the current command's processing is completed before executing the next command.

  If you execute the jpctool db backup command without specifying the -direct or -alone option, do so on a single host, rather than on multiple hosts.

• When you specify service-ID (for the -id option) or host-name (for the -host option) in the jpctool db backup command, you can use wildcard characters. You can execute backup or export processing concurrently on multiple agents by using wildcard characters in the service-ID or -host option.

  Example: Execute the jpctool db backup command on multiple agents

  This example creates a backup file for all agents on PFM - Agent for Platform (Windows):

  jpctool db backup -id "TS*" -host "*"

• If the volume of data to be backed up is large, backup processing may take some time.

• A historical report cannot be displayed in PFM - Web Console for an Agent Store or Remote Monitor Store service while it is being backed up. Request display of the historical report again after backup processing is completed.

• If command execution is interrupted by pressing the Ctrl + C keys or by a signal, a predefined return value is not returned. Therefore, you should ignore the return value when the command was interrupted by the Ctrl + C keys or by a signal.

• When you use the -d option to specify a backup directory, do not use the same backup directory for different service keys or different instances, and do not specify the import directory. If you do so, the backup data may be damaged.

• Before you execute this command on a PFM - Agent or PFM - RM host, check whether the option for restricting remote operation from Agent hosts is enabled on the PFM - Manager host. If that option is enabled, you can back up only data on the local host. If you specify a remote host by using the -host option, the command fails.

• An attempt to execute the jpctool db backup command for the Master Store, Agent Store, or Remote Monitor Store service might fail while one of the following commands and operations is being processed for that service:

  • jpctool db backup

  • jpctool db dump

  • jpctool db clear

  • jpctool db import

  • jpctool db restore

  • Operation to store data of the Agent Store service or the Remote Monitor Store service

  • Operation to display a historical report

  If the jpctool db backup command fails in the above situation, re-execute the command.

• This command cannot be executed between hosts that use different types of the Internet protocol.

To Page Top

Return values

To Page Top

Usage example 1

This example backs up all data from the host02 host:

jpctool db backup -id ?S* -host host02

To Page Top

Usage example 2

This example backs up all data from the agt01 host in a logical host environment (host name: jp1-ha1):

jpctool db backup -id ?S* -host agt01 -lhost jp1-ha1

To Page Top

Usage example 3

The following examples execute the command with -alone and -direct specified at the lhost02 host in the logical environment in PFM - Agent for Platform (Windows):

jpctool db backup -id OS* -lhost lhost02  -alone
 
jpctool db backup -id OS* -lhost lhost02  -direct

To Page Top

Usage example 4

This example backs up the data of all Agent Store and Remote Monitor Store services on the jp1-ha1 logical host when PFM - Agent or PFM - RM is in a logical host environment (host name: jp1-ha1) and PFM - Manager is on the physical host:

jpctool db backup -id "?S*" -host jp1-ha1

To Page Top

Usage example 5

This example backs up the data of all Agent Store and Remote Monitor Store services on the jp1-ha1 logical host when PFM - Agent or PFM - RM is on a logical host (host name: jp1-ha1) and PFM - Manager is on a logical host (host name: jp1-ha2):

jpctool db backup -id "?S*" -host jp1-ha1 -lhost jp1-ha2

To Page Top