jpctool db clear
- Organization of this page
Format
jpctool db clear -id service-ID
[-host host-name]
[-lhost logical-host-name]
-dbid database-ID
Function
The jpctool db clear command erases the data stored in the Master Store, Agent Store, or Remote Monitor Store service database.
Hosts that can execute the command
PFM - Manager
Execution permission
- In Windows:
-
-
User with Administrators permissions
-
User with Backup Operators permission
-
- In UNIX:
-
User with root user permissions
Installation directory
- In Windows:
installation-folder\tools\
- In UNIX:
/opt/jp1pc/tools/
Arguments
-id service-ID
Specifies the service ID (whose second character is S) of the Master Store, Agent Store, or Remote Monitor Store service. For service-ID, specify a string of 1 to 258 bytes. You can use wildcard characters to specify multiple service IDs. In this case, processing of the remaining services continues even if an error occurs on one service. If errors occur on multiple services, the command returns a value for the last error that occurred.
-host host-name
Specifies a host name if data is to be deleted from a specific host. For host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters with no space characters. If you omit this option, the local host is assumed.
You can use a wildcard character to specify multiple host names.
-lhost logical-host-name
Specifies a logical host name if this command is to be executed by a host in a logical host environment, not in the physical host environment. For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters with no space characters. If you omit this specification, the physical host is assumed. Wildcard characters cannot be used.
-dbid database-ID
Specifies the ID of the database from which the data is to be erased. The following shows 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
You can use a wildcard character to specify multiple database IDs.
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 if the Name Server service, Master Manager service, or the specified Master Store, Agent Store, or Remote Monitor Store service is not running.
-
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.
Return values
|
0 |
The command terminated normally. |
|
1 |
An argument specification is invalid. |
|
2 |
The user does not have execution permission for the command. |
|
3 |
One or more of the specified services is not active. |
|
5 |
PFM - Manager has not been installed. |
|
7 |
The specified service ID does not match Agent Store, Remote Monitor Store, or Master Store service. |
|
100 |
The Performance Management environment is invalid. |
|
101 |
Name Server service, Master Manager service, Master Store service, or the operation target service is not active. |
|
102 |
The specified logical host name has not been set up. |
|
200 |
A memory shortage occurred. |
|
210 |
A disk space shortage occurred. |
|
211 |
A backup file or directory cannot be accessed. |
|
220 |
A host name specified in the service configuration information file is invalid. |
|
222 |
A communication error occurred. |
|
255 |
An unexpected error occurred. |
Usage example 1
This example erases all data from the host01 host:
jpctool db clear -id ?S* -host host01 -dbid *
Usage example 2
This example erases the data of the PI record type of PFM - Agent for Platform (UNIX) from the host03 host. The following command assumes that the PFM - Manager to which PFM - Agent for Platform (UNIX) belongs is in a logical host environment (host01):
jpctool db clear -id "US*" -host host03 -lhost host01 -dbid PI
Usage example 3
This example erases the data of all the 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 clear -id "?S*" -host jp1-ha1 -dbid *
Usage example 4
This example erases the data of all the 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 clear -id "?S*" -host jp1-ha1 -lhost jp1-ha2 -dbid *