6.8.3 Format of the jpcuser command

The following describes the format of the jpcuser command.

Format:

jpcuser record-name
        -file user-created-data-file-name
        [-file user-created-data-file-name]...
        [-debug [0|1|2]]
        [-lhost logical-host-name]

Note: Square brackets ([]) indicate optional items. A vertical bar (|) has the same meaning as OR. Accordingly, only one of the options separated by a vertical bar can be used at a time.

Description:

The jpcuser command converts user-created data (user-specific performance data output by user commands) into data in a format that PFM - Agent for Platform can use (user data file).

The command can also output debug log information that can be used for checking whether the user-created data is correct. For details about the format of the debug log and how to read it, see 6.8.5 Checking the debug log to determine whether user-created data is correct.

To execute this command in a logical host environment, execute it on the executing node.

If an error occurs during execution of this command, an error message is output to the following folders:

Physical host environment: installation-folder\agtt\agent\jpcuser\log\public\
Logical host environment: environment-folder\jp1pc\agtt\agent\jpcuser\log\public\

Users who can execute the command:

Members of the Administrators group

Location of the command:

installation-folder\agtt\agent\jpcuser\

Arguments:

The first argument in the command line must be record-name. The -file option, -debug option, and -lhost option can be specified in any order. The arguments that are always required on the command line are record-name and a -file option. The -debug option and -lhost option can be omitted.

record-name

Specify the name of the user-defined record in which performance data is to be stored. You can specify only one of the following names:

PD_UPD
PD_UPDB
PI_UPI
PI_UPIB
PI_XUI1
PI_XUI2
PI_XUI3
PI_XUI4
PI_XUI5

-file user-created-data-file-name

Specify the name of a user-created data file whose length is no more than 259 bytes. Use multiple -file options to specify multiple user-created data files. When multiple user-created data files are specified, the command creates one user data file from the user-created data files.

Wildcard characters cannot be used in the file name specified in the -file option.

You can specify a file name by using a relative path name from the current directory (which is the directory in which the jpcuser command is executed).

If a warning occurs in one or more files when multiple user-created data files are specified, the command returns a value that indicates normal termination with a warning. If an error occurs in one or more files, the command returns a value that indicates abnormal termination or the occurrence of an error.

-debug [0|1|2]

Use this option to specify whether to output only the user data file, only the output debug log information, or both. You can use this option to check whether the user-created data was correct. You can specify only one -debug option in the command.

When -debug 1 is specified, the command performs only debugging. If you want to create user-defined records, specify the -debug option with a value other than 1.

If an error message is output to the debug log, an error might exist in the user command scripts.

If this option is not specified, the command does not output debug log information.

The following table explains the values that can be specified in the -debug option.

Table 6‒25: Values specified for the debug option
Value	User data file output?	Debug log file output?
`0`	Yes	No
`1`	No	Yes
`2`	Yes	Yes
Other values	Yes	No
No value specified	Yes	No

Legend:

Yes: The file is output.

No: The file is not output.

The user data file is jpcuser_XXX. The XXX part represents the record type (UPD, UPDB, UPI, UPIB, or XUIn (where n is a number in the range from 1 to 5)). The storage folders are as follows:

Physical host environment: installation-folder\agtt\agent\jpcuser\userdata
Logical host environment: environment-folder\jp1pc\agtt\agent\jpcuser\userdata

The debug log file is jpcuser_dbg_XX.log. The XX part is a two-digit number that indicates how new the log file is. The storage folders are as follows:

Physical host environment: installation-folder\agtt\agent\jpcuser\debug
Logical host environment: environment-folder\jp1pc\agtt\agent\jpcuser\debug

The following table explains the naming rule for debug log files.

Table 6‒26: Example of debug log output
Debug log file name	Explanation
`jpcuser_dbg_01.log`	The latest debug log file
`jpcuser_dbg_02.log`	The second latest debug log file
`jpcuser_dbg_03.log`	The third latest debug log file
...	...

-lhost

Specify the logical host name of the host on which this command is executed. If you omit specifying this option, a physical host is assumed. For details about the format of a logical host name, see the description of the -lhost option of the jpcconf ha setup command in the manual JP1/Performance Management Reference.

Note that you can set this option only once.

Return value:

`0`	Normal termination
1 to 100	Normal termination with a warning
101 to 255	Abnormal termination or the occurrence of an error

To Page Top