jpcconf db define

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Note
Return values
Usage example 1
Usage example 2

Format

jpcconf db define    -key service-key
                    [-inst instance-name]
                    [-lhost logical-host-name]
                    [{-sd|-bd|-bs|-pbd|-dd|-id}
                     setting-value[-move]]

To Page Top

Function

The jpcconf db define command changes and displays the settings of the Store service.

You can use this command to change the storage directory for the Store database of the Agent Store or Remote Monitor Store service or to change the maximum generation number and other settings if you back up the Store database.

To change the settings of the Store service, specify -sd, -bd, -bs, -pd, -pbd, -dd, or -id. If you do not specify any of these options, the command displays the settings of the Store service.

The following settings can be displayed:

StoreDir:: Displays the Store directory.
BackupDir:: Displays the backup directory.
BackupSave:: Displays the maximum number of generations for the backup directory.
PartialBackupDir:: Displays the partial backup directory.
DumpDir:: Displays the dump directory.
ImportDir:: Displays the import directory.

To Page Top

Hosts that can execute the command

PFM - Manager
PFM - Agent
PFM - RM

To Page Top

Execution permission

In Windows:: User with Administrators permissions
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

`-key` `service-key`

Specifies the service key of the Store service whose settings are to be changed or displayed. A product name can also be specified when the product name display functionality is enabled. You can specify only the service key of PFM - Agent or PFM - RM here. For details about the service key of the PFM - Agent or PFM - RM, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.

`-inst` `instance-name`

Specifies the instance name of the Store service whose settings are to be changed or displayed. For instance-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters.

You cannot specify this option when the Store service whose settings you want to change or display is on a single-instance agent.

`-lhost` `logical-host-name`

Specifies the logical host name of the Store service whose settings are to be changed or displayed. For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters.

When you omit this option, the settings of the Store service on the physical host are changed or displayed.

`-sd|-bd|-bs|-pbd|-dd|-id`

Use one of these options to specify the Store service settings you want to change. The options correspond to the label names in the jpcsto.ini file as shown below. By executing the jpcconf db define command, you can change the value of the corresponding label name in the jpcsto.ini file.

Option name	Corresponding label name in jpcsto.ini file	Description
`-sd`	`Store Dir`	Changes the Store directory for the Store database.
`-bd`	`Backup Dir`	Changes the backup directory for the Store database.
`-bs`	`Backup Save`	Changes the number of generations for the backup directory for the Store database.
`-pbd`	`Partial Backup Dir`	Changes the partial backup directory for the Store database.
`-dd`	`Dump Dir`	Changes the dump directory for the Store database.
`-id`	`Import Dir`	Changes the import directory for the Store database.

For setting-value, you can specify only a directory on a logical disk.

The value you can specify for setting-value differs as shown below, depending on the Store version of the target Store service:

Option name	Store version
Option name	1.0	2.0
`-sd`	The string can be a maximum of 127 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > \| Specify the full path or a relative path.	The string can be a maximum of 214 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > \| Specify the full path or a relative path. You must specify an existing directory.
`-bd`	The string can be a maximum of 127 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > \| Specify the full path or a relative path.	The string can be a maximum of 211 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > Specify the full path or a relative path. You must specify an existing directory.
`-bs`	Integer from 1 to 9	Integer from 1 to 9
`-pbd`	Cannot be specified.	The string can be a maximum of 214 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > Specify the full path or a relative path. You must specify an existing directory.
`-dd`	The string can be a maximum of 127 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > \| Specify the full path or a relative path.	The string can be a maximum of 127 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > Specify the full path or a relative path.
`-id`	Cannot be specified.	The string can be a maximum of 222 bytes long and can consist of single-byte alphanumeric characters, spaces, and symbols. However, the following symbols cannot be used: ; , * ? ' " < > Specify the full path or a relative path. You must specify an existing directory.

`-move`

Specifies whether to copy the contents of the current directory to the new directory when you change the settings of a Store service directory. The -move option cannot be specified together with certain options, as shown below:

Option	Whether -move option can be specified
`-sd`	Yes
`-bd`	Yes
`-bs`	No
`-pbd`	Yes
`-dd`	No
`-id`	Yes

Legend:

Yes: The -move option can be specified.

No: The -move option cannot be specified.

When you omit the -move option, only the settings of the current directory are changed.

If the -move option is specified, the following restrictions are placed on the directory that you specify:

The directory must be empty.
A subdirectory of the directory that is currently set cannot be specified.

To Page Top

Note

Before you change the Store service settings, make sure that the PFM - Agent or PFM - RM service specified by service-key has stopped. However, you do not need to stop that service when you only display the Store service settings.

To Page Top

Return values

`0`	The command ended normally.
`1`	An argument is specified incorrectly.
`2`	The user does not have execution permission for the command.
`4`	The specified service has not stopped.
`5`	The specified PFM - Agent or PFM - RM has not been installed.
`12`	Importing is disabled for the specified version of the Store service.
`100`	The environment for Performance Management is invalid.
`102`	The specified logical host or instance is not set up.
`200`	A memory shortage occurred.
`210`	A disk space shortage occurred.
`211`	The file or directory cannot be accessed.
`255`	An unexpected error occurred.

To Page Top

Usage example 1

The following example changes the settings of the Store service:

> jpcconf db define -key Windows -sd d:\store
KAVE05856-I Updating the configuration information of the Store database ended normally. (servicekey=Windows, label=Store Dir)

To Page Top

Usage example 2

The following example displays the settings of the Store service:

> jpcconf db define -key Exchange -inst inst1
Store Dir           : .
Backup Dir          : ./backup
Backup Save         : 5
Partial Backup Dir  : ./partial
Dump Dir            : ./dump
Import Dir          : ./import
KAVE05858-I Displaying Store database configuration information ended normally.  (servicekey=Exchange, inst=inst1)

To Page Top