Job Management Partner 1/Integrated Management - Manager Command and Definition File Reference

jcoevtreport

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.

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-condition-definition-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. 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 and time for the events that are to be output.

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).

-e output-end-date

Specifies the end date and time for the events that are to be output.

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

Specifies the relative or absolute path name of the filter condition 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.

-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.

-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

Specifies that 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, are to be 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 2KAVB4600

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

[Contents][Back][Next]

All Rights Reserved. Copyright (C) 2009, Hitachi, Ltd.