jcoevtreport
- Organization of this page
Function
This command outputs to a CSV file information about the JP1 events registered in the integrated monitoring database. Only one instance of this command can be executing at the same time.
The jcoevtreport command can output JP1 event information to a CSV file as long as the IM database service is running, even if the integrated monitoring database is disabled or Central Console is not running.
- Important note
-
Because the jcoevtreport command acquires an event from the integrated monitoring database, operations such as searching for events from JP1/IM - View, switching response statuses, and acquiring events from JP1/IM - Manager are affected. Therefore, if the jcoevtreport command is executed when many events are running, other processes of JP1/IM - View or JP1/IM - Manager are delayed, and overall operation might be affected. If you want to execute the jcoevtreport command, do so during a time when it will not affect operation.
For details about the CSV output format, see 3.12.2 Saving event information in the integrated monitoring database (CSV report) in the Job Management Partner 1/Integrated Management - Manager Overview and System Design Guide.
The command outputs error information to standard error, such as invalid definitions or a file size that exceeds the maximum value.
The following table describes the output functions.
Function |
Description |
---|---|
Output of event report |
Function that outputs to a CSV file information about the JP1 events registered in the integrated monitoring database |
Output of maintenance information |
Function that outputs all information about the JP1 events registered between an output start date/time and an output end date/time in the event of an integrated monitoring database failure |
Output-and-save |
Function that saves JP1 event information from the output of event report function before the information is deleted from the integrated monitoring database |
Output-and-save status display |
Function that displays the size and percentage of the JP1 events in the integrated monitoring database that have not been output and saved (percentage of the maximum capacity of the integrated monitoring database), as well as the deletion warning notification level |
Format
- Output of event report
jcoevtreport [-h logical-host-name] [-o output-file-name] -s output-start-date -e output-end-date [-user] [-f filter-file-name] [-k item-file-name] [-t {ON|OFF}] [ -a {EVTATTR|DISP}]
- Output of maintenance information
jcoevtreport [-h logical-host-name] [-o output-file-name] -s output-start-date -e output-end-date -sys
- Output-and-save
jcoevtreport [-h logical-host-name] [-o output-file-name] -save [ -t {ON|OFF}] [ -a {EVTATTR|DISP}]
- Output-and-save status display
jcoevtreport [-h logical-host-name] -showsv
Execution permission
In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)
In UNIX: Superuser permissions
Storage directory
- In Windows:
-
Console-path\bin\
- In UNIX:
-
/opt/jp1cons/bin/
Arguments
- -h logical-host-name
-
When you are operating in a cluster system, this option specifies the logical host name of the host that executes the command. The command acquires JP1 event information from the integrated monitoring database that is running at the specified logical host and performs output of event reports, output of maintenance information, output-and-save, or output-and-save status display. If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed. If you are not using a cluster system, specification of this option is not needed.
- -o output-file-name
-
Specifies the relative or absolute path name of the CSV file to which the JP1 event information acquired from the integrated monitoring database is to be output.
If you specify a file name that begins with a hyphen (-), use a relative or absolute path that includes a directory (such as ./-hoge) in order to distinguish the file name from an option. The permitted file name is a maximum of 250 bytes including the path.
Note that the following characters cannot be specified in a file name in Windows:
-
Characters: : ? " < > |
-
A character string that completely matches any of the following strings (not case sensitive): CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9
The following describes the relationship between the specified output file name and the file name that is actually created.
Event information in the integrated monitoring database is output to a CSV file named output-file-name_serial-number.csv. The serial number is a number from 000 to 999. A maximum of 50,000 event information items can be output to a file. If a file with the same name already exists, the command does not overwrite the file. Instead, the command creates a new file by incrementing the serial number until an unused file name is obtained. If this option is omitted, the command outputs a CSV file named jcoevtreport_serial-number.csv to the current directory.
If the current directory (.) or the root directory (/) is specified in the file name, the command handles it as shown below:
-o argument
Windows
UNIX
.
._xxx.csv is created in the current directory.
_xxx.csv is created in the current directory.
/
_xxx.csv is created in the root directory.
_xxx.csv is created in the root directory.
"" (null character)
_xxx.csv is created in the current directory.
Insufficient argument error
-
- -s output-start-date
-
Specifies the start date/time of the event arrival time that is used for outputting events.
The specification format is YYYYMMDDhhmmss.
The specified date/time must be within the period from 1970/01/01 00:00:00 to 2038/01/19 03:14:07 (GMT). When the time zone of the host on which the command is executed is Japan, the period is (GMT + 9:00) 1970/01/01 09:00:00 to 2038/01/19 12:14:07.
- -e output-end-date
-
Specifies the end date/time of the event arrival time that is used for outputting events .
The specification format is YYYYMMDDhhmmss.
The specified date/time must be within the same period as for the -s option.
- -k item-file-name
-
Specifies the relative or absolute path name of the output item definition file when an event report is to be output.
If you specify a file name that begins with a hyphen (-), use a relative or absolute path that includes a directory (such as ./-hoge) in order to distinguish the file name from an option.
- -f filter-condition-definition-file-name filter-file-name
-
Specifies the name of a filter file in relative or absolute path format.
If you specify a file name that begins with a hyphen (-), use a relative or absolute path that includes a directory (such as ./-hoge) in order to distinguish the file name from an option.
For details about the filter file formats, see Filter file in 2. Definition Files.
- -t {ON|OFF}
-
Specifies whether the registration time, arrival time, and START_TIME and END_TIME (common information for the extended attributes) are to be output in the format YYYYMMDDhhmmss or in absolute time in seconds.
-
ON: Specifies that the registration time, arrival time, and START_TIME and END_TIME (common information for the extended attributes) are to be output in the format YYYYMMDDhhmmss (i.e., they are to be converted from absolute time in seconds from January 1, 1970, to the calendar format YYYYMMDDhhmmss).
-
OFF: Specifies that the time is not to be converted to the calendar format.
This option takes precedence over the item file specification.
ON and OFF are not case sensitive.
-
- -a {EVTATTR|DISP}
-
Specifies the output format for the header. If the -a option is omitted, no header is output.
When EVTATTR is specified, the command displays attribute names (such as B.ID and E.SEVERITY); when DISP is specified, the command displays item names (such as event ID and severity).
EVTATTR and DISP are not case sensitive.
If DISP is specified in the -a option, the character string to be output varies according to the value set for the LANG environment variable. The following table shows the character strings for the header to be output by the jcoevtreport command.
Table 1‒32: Header character string output by the jcoevtreport command -a EVTATTR
-a DISP
LANG is Japanese
LANG is English
B.SEQNO
Serial number
Serial number
B.ID
Event ID
Event ID
B.PROCESSID
Source process ID
Source process ID
B.TIME
Registered time
Registered time
B.ARRIVEDTIME
Arrived time
Arrived time
B.REASON
Registered reason
Registered reason
B.USERID
Source user ID
Source user ID
B.GROUPID
Source group ID
Source group ID
B.USERNAME
Source user name
Source user name
B.GROUPNAME
Source group name
Source group name
B.SOURCESERVER
Registered host name
Source event server name
B.DESTSERVER
Destination event server name
Destination event server name
B.SOURCEIPADDR
Source IP address
Source IP address
B.DESTIPADDR
Destination IP address
Destination IP address
B.SOURCESEQNO
Source serial number
Source serial number
B.CODESET
Code set
Code set
B.MESSAGE
Message
Message
E.SEVERITY
Event level
Event level
E.USER_NAME
User name
User name
E.PRODUCT_NAME
Product name
Product name
E.OBJECT_TYPE
Object type
Object type
E.OBJECT_NAME
Object name
Object name
E.ROOT_OBJECT_TYPE
Root object type
Root object type
E.ROOT_OBJECT_NAME
Root object name
Root object name
E.OBJECT_ID
Object ID
Object ID
E.OCCURRENCE
Occurrence
Occurrence
E.START_TIME
Start time
Start time
E.END_TIME
End time
End time
E.RESULT_CODE
Return code
Result code
E.JP1_SOURCEHOST
Event source host name
Event source host
E.@JP1IM_ACTTYPE
Action type
Action type
E.@JP1IM_ACTCONTROL
Action
Action
E.@JP1IM_SEVERE
Server event
Severe Event
E.@JP1IM_CORRELATE
Correlation event
Correlation event
E.@JP1IM_RESPONSE
Response-waiting event
Response-waiting event
E.@JP1IM_ORIGINAL_SEVERITY
Original severity level
Original Severity Level
E.@JP1IM_CHANGE_SEVERITY
New severity level
New Severity Level
E.@JP1IM_DEALT
Response status
Event status
E.@JP1IM_RELEASE
Severe event released
Severe Event Released
E.@JP1IM_DISMISSED
Severe event deleted
Severe Event Deleted
E.@JP1IM_MEMO
Memorandum
Memo
Program-specific extended attributes count
Number of program-specific extended attributes
Program-specific extended attributes count
Program-specific extended attributes
Program-specific extended attribute
Program-specific extended attribute
- -user
-
Specifies that an event report on the JP1 events registered in the integrated monitoring database is to be output.
The -user option is optional.
If you omit all of the -user, -sys, -save, and -showsv options, the output of event report function is assumed.
- -sys
-
Specifies that maintenance information on the JP1 events registered in the integrated monitoring database is to be output.
- -save
-
Specifies that all JP1 events in the integrated monitoring database that have not been output and saved are to be output and saved.
- -showsv
-
The following items are output.
Display item
Description
Percentage of the events that have not been output
The percentage of the JP1 events in the integrated monitoring database that have not been saved and output (percentage of the maximum capacity of the integrated monitoring database) is displayed.
Size of the events that have not been output
The data size of the JP1 events in the integrated monitoring database that have not been saved and output is displayed in megabytes.
The displayed size is the data size in the integrated monitoring database. For CSV output, capacity equivalent to the displayed size of the events that were not output 1.2 is required.
Deletion warning notification level setting
The value set for the deletion warning notification is displayed.
If deletion warning notification is disabled, a hyphen (-) is displayed.
Return values
0 |
Normal termination |
1 |
Invalid option or argument |
2 |
Invalid filter |
3 |
Invalid item file |
4 |
Report output processing error |
5 |
Execution permission error (Windows only) |
6 |
Concurrent execution error |
7 |
Serial number of the output file has reached the maximum value |
101 |
Integrated monitoring database has not been set up |
102 |
IM database service is not running |
103 |
Error occurred in the connection with the IM database service |
254 |
Memory shortage occurred |
255 |
System error |
Example 1
Output to a report the events that arrived at the manager from 2008/06/01 12:00:00 to 2009/01/01/00:00:00:
jcoevtreport -s 20080601120000 -e 20090101000000 -user
Example 2
Set report_xxx.csv as the output destination and output an event report on the JP1 events dated from 2009/07/08 08:45:00 to 2009/07/14 17:15:00:
jcoevtreport -s 20090708084500 -e 20090714171500 -o report
Example 3
Set report_xxx.csv as the output destination and output maintenance information on the JP1 events dated from 2009/07/08 08:45:00 to 2009/07/14 17:15:00:
jcoevtreport -sys -s 20090708084500 -e 20090714171500 -o report
Example 4
Set report_xxx.csv as the output destination and perform output-and-save:
jcoevtreport -save -o report
Example 5
Displays the output-and-save status:
jcoevtreport -showsv