jpcras
- Organization of this page
Format
jpcras directory-name service-key [all|data|dump] [lhost=logical-host-name] [inst=instance-name]
Function
The jpcras command collects information about PFM - Manager, PFM - Agent, PFM - RM, or PFM - Base, as well as OS information. You use this command when a problem occurs in PFM - Manager, PFM - Agent, PFM - RM, or PFM - Base.
This command collects information about the host where this command executes or maintenance information for the logical host specified in the lhost option. The collected information is stored in a specified directory. In UNIX, the collected information is compressed by a combination of the tar and compress commands or a combination of the tar and gzip commands. In Windows, however, the collected information is stored in uncompressed format. If you want the collected information to be stored in compressed format, compress the information manually.
When a problem occurs, there is other information that is needed, in addition to the information that can be collected by this command. For details on the information to be collected when a problem occurs, see the chapter on troubleshooting in the JP1/Performance Management User's Guide.
Hosts that can execute the command
-
PFM - Manager
-
PFM - Agent
-
PFM - RM
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
directory-name
Specifies the name of the directory in which the collected information is to be stored. For directory-name, specify a string of 1 to 127 bytes, consisting of alphanumeric characters and symbols. A relative path cannot be used. The absolute path must be used. Note that the following symbols cannot be specified:
; , * ? ' " < > | & ^ `
If the directory name contains a space, enclose the entire name in double quotation marks ("). If you specify any of the following symbols, enclose it in double quotation marks (") in order to prevent it from being analyzed by the shell or the command prompt:
( )
Do not specify the Performance Management installation directory in directory-name.
A directory name for a removable medium, such as a floppy disk, cannot be specified in this option.
For this option, you cannot specify the directory name of a removable medium such as a floppy disk.
In UNIX, the collected information is saved as a file named jpcrasYYMMDD#.tar.Z (when compressed by the compress command) or jpcrasYYMMDD#.tar.gz (when compressed by the gzip command) in the specified directory.
In Windows, a file for the collected information is copied uncompressed to the folder specified by this option.
- #
-
YYMMDD indicates the file creation date:
-
YY
Last two digits of the year.
-
MM
Month, in the range 01 to 12.
-
DD
Date, in the range 01 to 31.
-
service-key
Specifies the service key of the service for which information is to be collected. Note that you cannot specify a product name even if the product name display functionality is enabled. You can also specify the following in service-key:
-
all: Specifies all services of Performance Management programs.
-
mgr: Specifies the PFM - Manager services (excluding the Action Handler and Status Server services).
-
act: Specifies the Action Handler service.
-
service-key-of-PFM - Agent or PFM - RM service: Collects information for each PFM - Agent or PFM - RM service (including the Action Handler service)
-
stat: Specifies the Status Server service.
For details about the service key of the PFM - Agent or PFM - RM service, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.
[all|data|dump]
Specifies the information that is to be collected. Different information is collected for each of these specifications; normally, all is specified.
The following tables show for both OSs the information that is collected depending on the specification of this option.
Information collected |
Option |
||||
---|---|---|---|---|---|
all |
data |
dump |
Omitted |
||
System log |
Y |
N |
N |
Y |
|
Common message log |
Y |
N |
N |
Y |
|
Service configuration information |
Y |
N |
N |
Y |
|
Process information |
Y |
N |
N |
Y |
|
Version information |
Y |
N |
N |
Y |
|
System file |
Y |
N |
N |
Y |
|
Database information |
Y |
Y |
N |
Y# |
|
OS information |
System information |
Y |
N |
N |
Y |
Network status |
Y |
N |
N |
Y |
|
Host name |
Y |
N |
N |
Y |
|
Firewall information |
Y |
N |
N |
Y |
|
Dump information |
Y |
N |
Y |
N |
|
Docker environment information |
Y |
N |
N |
Y |
- Legend:
-
Y: Information is collected.
N: Information is not collected.
- #
-
View Server, Agent Store, and Remote Monitor Store service database information is not collected when specification of the option is omitted. In this case, collected is the database information for the Master Store, Master Manager, and Name Server services.
Table 2‒31: Information collected by the jpcras command (in UNIX) Information collected
Option
all
data
dump
Omitted
System log
Y
N
N
Y
Common message log
Y
N
N
Y
Service configuration information
Y
N
N
Y
Process information
Y
N
N
Y
Version information
Y
N
N
Y
System file
Y
N
N
Y
Database information
Y
Y
N
Y#
OS information
System information
Y
N
N
Y
Patch information
Y
N
N
Y
Kernel information
Y
N
N
Y
Version information
Y
N
N
Y
Network status
Y
N
N
Y
Environment variable
Y
N
N
Y
Host name
Y
N
N
Y
Firewall information (Linux)
Y
N
N
Y
Dump information
Y
N
Y
N
Docker environment information
Y
N
N
Y
- Legend:
-
Y: Information is collected.
N: Information is not collected.
- #
-
View Server, Agent Store, and Remote Monitor Store service database information is not collected when specification of the option is omitted. In this case, collected is the database information for the Master Store, Master Manager, and Name Server services.
For details about the information that can be collected, see the chapter on troubleshooting in the JP1/Performance Management User's Guide.
lhost=logical-host-name
Specifies the host environment in which the command is to be executed. You use this argument when a logical host has been configured on the machine that is used to execute the command. For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters with no space characters.
If this argument is omitted, maintenance information for all host environments is collected. Wildcard characters cannot be used.
inst=instance-name
Specifies an instance name in order to collect information about that instance. This option is applicable only when a PFM - Agent or PFM - RM with an instance environment is specified in service-key. For instance-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters.
If this option is omitted, information is collected for all instances.
Notes
-
When you collect the database information for the Agent Store or Remote Monitor Store service by specifying the all or data option, you do not need to stop that service.
-
If the version of the Store service is 2.0, first execute the two commands listed below to collect the data other than database data, and then collect troubleshooting data from the database. When the Store version is 2.0, the database is large and the collection of data takes time. Depending on the time required, investigation of the problem could be delayed.
-
jpcras directory-name all
-
jpcras directory-name all dump
If the database is small, execute the following command to collect data that also includes the data in the database:
-
jpcras directory-name all all
-
-
When you execute the jpcras command, the data in the database of the Store service is collected, but the data in the database in the import directory is not collected. To collect the databases in the import directory, set the value of the JPC_COLIMPORT environment variable to 1.
-
Depending on the size of the file to be collected and the network environment, it may take some time for the command's processing to execute.
-
The command cannot collect the specified information in a system in which the syslog file is not output to the default path and file name. In such a system, you must find a different method for collecting the information.
-
You must specify the arguments in the order they appear in Format.
-
Do not specify directory-name as a relative path.
-
Do not specify the Performance Management installation directory in directory-name.
-
Specify in directory-name an empty directory that contains no file or directory.
-
Make sure that there is enough disk space available. Estimate the available disk space on the basis of the amount of disk space each product is using.
-
If this command is executed while there is a disk capacity shortage or memory shortage, an OS message might be output. However, if the KAVE06010-I message is displayed, the maintenance information has been correctly collected and this OS message can be ignored.
-
If the KAVE05035-E message is output, check the available space on the disk and in memory based on the instructions in the OS message.
-
If the KAVE05213-E message is displayed, collect a list of the files stored in the Performance Management installation directory, in addition to the collected maintenance information.
-
If an error occurs during file collection, the file or directory that was being collected remains in the following directory; such remaining files or folders should be deleted as necessary:
-
In Windows:
Folder specified in directory-name
-
In UNIX:
Folder specified in directory-name/jpcwk*
-
-
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 execute the jpcras command, jpctool service list -id "*" -host "*" is executed to acquire a list of PFM services and to check the startup status. If a firewall exists between the host executing the command and the hosts within another PFM system, or if the system configuration is large, executing jpctool service list -id "*" -host "*" might take a long time. In such cases, set the JPC_COLCTRLNOHOST environment variable to 1 to suppress the processing of jpctool service list -id "*" -host "*" and reduce the command execution time.
-
When you execute the jpcras command on a UNIX environment, regarding free disk space requirements, note the following:
-
The storage directory specified for the jpcras command must have twice as much free disk space as the amount collected.
-
Use the /tmp or /var/tmp directory for the tar command processing. Note that the directory used differs depending on the OS environment.
The following shows an execution example for the jpcras command.
jpcras /usr/ras all all
The data collected by the jpcras command is assumed to be 100 MB. In this case, the free disk space required for the /usr/ras directory is 200 MB. Note that 100 MB of free disk space is temporarily needed in the /tmp or /var/tmp directory, for the tar command processing.
-
-
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 collect only information about the local host.
-
If PFM is in a cluster environment, information about the shared disk and physical hosts must be collected. If the jpcras command is executed without the lhost option when the shared disk is online, the command collects information about the shared disk and physical hosts. Therefore, use this command to collect information without specifying the lhost option even if PFM is in a cluster environment. The lhost option is a legacy that has been left for compatibility purposes only.
-
In a cluster system, execute this command at all nodes in the cluster system. Also, if the system is operated in a multiple-monitoring environment, execute this command on both the primary and secondary hosts.
Return values
0 |
The command terminated normally. |
1 |
An argument specification is invalid. |
2 |
The user does not have execution permission for the command. |
100 |
The Performance Management environment is invalid. |
102 |
The specified logical host name or instance has not been set up. |
210 |
A disk space shortage occurred. |
211 |
Collection target directory cannot be accessed. |
255 |
An unexpected error occurred. |
Usage example 1
This example collects all information in a UNIX host and stores the collected information in the /tmp/jp1pc directory:
jpcras /tmp/jp1pc all all
Usage example 2
This example collects dump information for PFM - Agent for Platform (UNIX) in a UNIX host and stores the collected information in the /tmp/jp1pc directory:
jpcras /tmp/jp1pc agtu dump