jpcconf db display
- Organization of this page
Format
Format 1
jpcconf db display [-key service-key[-inst instance-name]] [-lhost logical-host-name]
Format 2
jpcconf db display -d backup-directory
Function
The jpcconf db display command displays information about the Store service or backup data.
This command can also check whether the Store version is 1.0 or 2.0.
The following describes the functional differences between Format 1 and Format 2. For Format 1, Store service information is displayed. For Format 2, information about the specified backup data is displayed. The information displayed for each format is as follows.
Format 1
Contents displayed |
Description |
service-key |
Indicates the service key of the agent. |
instance-name |
Indicates an instance name for multi-instance agents. This element is "" (empty string) for single-instance agents. |
data-model-version |
Displays a hyphen (-) when the target agent is 07-00 or earlier. Displays the data model version of the target Store service when the target agent is 08-00 or later. |
Store-version |
Indicates the Store version. |
If the information displayed in the data section is less than the following specified length, the remaining length is created by spaces.
service-key: 6 bytes
instance-name: 15 bytes
data-model-version: 14 bytes
Store-version: 9 bytes
Format 2
Contents displayed |
Description |
service-key |
Indicates the service key of the agent. |
data-model-version |
Displays a hyphen (-) when the Store version is 1.0. Displays the data model version of the specified backup data when the Store version is 2.0. |
Store-version |
Indicates the Store version. |
Hosts that can execute the command
PFM - Manager
PFM - Agent
PFM - Base#
PFM - RM
#
This can only be executed when the -d option is specified.
Execution permission
In Windows:
User with Administrators permissions (executed from the administrator console when Windows UAC functionality is enabled)
In UNIX:
User with root user permissions
Installation directory
In Windows:
installation-folder\tools\
In UNIX:
/opt/jp1pc/tools/
Arguments
-key service-key
Specifies the service key of the Store service whose information you want to display. 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 Job Management Partner 1/Performance Management Planning and Configuration Guide.
-inst instance-name
Specifies the instance name of the Store service whose information you want to display. For instance-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters.
This option must be specified when the target Store service is on a multi-instance agent. You cannot specify this option for single-instance agents.
-lhost logical-host-name
Specifies the logical host name of the Store service whose information you want to display. For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters.
If you omit this option, setup is performed for the Store service on the physical host.
-d backup-directory
Specifies the name of the backup directory containing the backup data whose information you want to display. You cannot specify the following characters in the backup directory name:
; , * ? ' " < > |
Use 1 to 214 bytes (but none of the above characters) to specify a relative path or the full path. When you specify a relative path, specify the path from the directory that is the current directory when the command is executed.
Notes
When the target instance of PFM - Agent is 07-00 or earlier, the data model version is not displayed.
When you execute this command on the standby server in a logical host environment to display the information about the Store service, a hyphen (-) is displayed for the Store version and the data model version.
Return values
0 |
The command ended normally. |
1 |
An argument is specified incorrectly. |
2 |
The user does not have execution permission for the command. |
5 |
The specified PFM - Agent or PFM - RM has not been installed. |
100 |
The environment for Performance Management is invalid. |
102 |
The specified logical host or instance is not set up. |
104 |
The specified Store service is being backed up or is exporting data. |
200 |
A memory shortage occurred. |
210 |
A disk space shortage occurred. |
211 |
The file or directory cannot be accessed. |
254 |
The command ended normally. As a result of command execution, the Store version was 1.0 for at least one of the specified services. |
255 |
An unexpected error occurred. |
Usage example 1
The following example displays information about all the services on the physical host:
> jpcconf db display
Key Instance Name DataModel Ver Store Ver
----------- --------------- -------------- ---------
EAP inst1 4.0 2.0
EAP inst2 4.0 1.0
EAP inst3 4.0 2.0
Windows 5.0 1.0
SR 4.0 2.0
#
In the above example, EAP is a multi-instance agent whose version is 08-11, Windows is a single-instance agent whose version is 08-11, and SR is a single-instance agent whose version is 08-50.
Usage example 2
The following example displays information about the backup data of Store 1.0 in the backup directory:
> jpcconf db display -d "d:\backup01"
Key DataModel Ver Store Ver
----------- --------------- ---------
EAP - 1.0
Usage example 3
The following example displays information about the backup data of Store 2.0 in the backup directory:
> jpcconf db display -d "d:\backup02"
Key DataModel Ver Store Ver
----------- --------------- ---------
EAP 5.0 2.0
Format
jpcconf db vrset [-ver 2.0|1.0]
-key service-key
[-inst instance-name]
[-lhost logical-host-name] [-force]
Function
The jpcconf db vrset command changes the version of the Store database. When this command is executed, Store database data is converted to the specified Store version format. Note that the data retention period is converted to the specified Store version setting.
The Store version is specified by -ver Store-version. Either 2.0 or 1.0 can be specified for Store-version.
- When the -ver 2.0 option is specified
-
Setup is performed with Store version 2.0 functionality.
When you execute this command, the setting for all records of the PD and Pl record types for the deletion period become 10 days.
The retention period for the PI database after setup changes as follows according to the retention period that existed before setup:
Retention period before setup
Retention period after setup
Summary type
Minute-by-minute
(unit: days)
Hourly
(unit: days)
Daily
(unit: weeks)
Weekly
(unit: weeks)
Monthly
(unit: months)
1 minute
1
--
--
--
--
1 hour
1
1
--
--
--
1 day
1
1
1
--
--
2 days
2
2
1
--
--
3 days
3
3
1
--
--
4 days
4
4
1
--
--
5 days
5
5
1
--
--
6 days
6
6
1
--
--
1 week
7
7
1
1
--
1 month
31
31
5
5
1
1 year
366
366
54
54
12
Note that for PFM - Agent 08-11 or later, this is the specified value for each instance of PFM - Agent. For details about the specified value, see the corresponding PFM - Agent manuals.
Hosts that can execute the command
-
PFM - Manager
-
PFM - Agent
-
PFM - RM
Execution permission
- In Windows:
-
User with Administrators permissions
- In UNIX:
-
User with root user permissions
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pc/tools/
Arguments
-key service-key
Specifies the service key of the Store service. 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 Job Management Partner 1/Performance Management Planning and Configuration Guide.
-inst instance-name
Specifies the instance name of the Store service whose information you want to display. For instance-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters. This option must be specified when the target Store service is on a multi-instance agent. You cannot specify this option for single-instance agents.
-lhost logical-host-name
Specifies the logical host name of the Store service. For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters. If you omit this option, setup is performed for the Store service on the physical host.
-force
When this option is specified, no confirmation message is displayed. Note that this option can only be specified, when the -ver 1.0 option is specified.
Notes
- When the -ver 2.0 option is specified
-
-
Before this command is executed, only the PFM - Agent or PFM - RM service to be set up needs to be stopped. As such, stop the PFM - Agent or PFM - RM service before executing this command.
-
You should back up data before you execute this command.
-
Executing this command requires the same amount of free disk space as that being used by the Store database before the command is executed.
-
Check the retention period after the command is executed. Note that the retention period is changed to 10 days for all the records of the PD and PL record types.
-
- When the -ver 1.0 option is specified
-
-
When this command is executed, data is initialized. If any data exists, a confirmation message such as the following is displayed before data is initialized:
KAVE05873-Q If you continue the processing, the Store database will be initialized. Do you want to continue? (Y/N)
Processing continues only when you enter y or Y. However, when the -force option is specified, the command is executed without displaying the confirmation message.
-
The import directory is not deleted even if this command is executed.
-
For PFM - Agent or PFM - RM hosts for which Store version 2.0 is a prerequisite, if the -ver 1.0 option is specified and this command is executed, the KAVE05882-E message is displayed and the command terminates. In this case, the Store version cannot be changed from 2.0 to 1.0.
-
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. |
10 |
The command is being executed. |
11 |
The user canceled the processing. |
12 |
Version setup or restoration is disabled for the specified version of the Store service. |
100 |
The Performance Management environment 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. |