jpcras

Format

jpcras     directory-name
           service-key
          [all|data|dump]
          [lhost=logical-host-name]
          [inst=instance-name]

To Page Top

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.

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 (executed from the administrator console when Windows UAC functionality is enabled)

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

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.

• You can use the jpcras command to execute OS commands for collecting OS system information. A dialog box stating that system information is being updated might be displayed, however this command only collects information. Therefore, when you execute the jpcras command, it does not affect the system.

To Page Top

Return values

To Page Top

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

To Page Top

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

To Page Top