4.8.3 Get JP1 event
Function
Information about JP1 events registered in the integrated monitoring database is output to a specified file in CSV format, for a specified server's JP1/IM - Manager over a specified period. The output format of the file is the same as the output result of JP1/IM's jcoevtreport command. The format for time of registration, time of arrival, start time and finish time is YYYYMMDDhhmmss; the header is output in DISP format.
This plugin assumes that the following servers are being used.
• Monitoring server (Execution target servers)
The server that acquires the number of JP1/IM - Manager events.
Use situation
The plugin can be used to investigate events arriving at JP1/IM - Manager.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running on the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
(1)Job Management Partner 1/Integrated Management - Manager 09-00 or later, or
JP1/Integrated Management - Manager 11-00 or later
[Prerequisite product OS running on the execution target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) AIX V6
(9) AIX V7
[Usage conditions for required products on the execution target server]
(1) If the execution target server's JP1/IM - Manager is in a cluster configuration, specify the name of the physical host on which the IM logical host is running in property plugin.destinationHost, and the logical host name of JP1/IM - Manager in property JP1IM.jp1imLHostName.
(2) An integrated monitoring database must be running.
(3) The range of dates and times that can be specified is: 1970/01/01 00:00:00 through 2038/01/19 03:14:07 (GMT). If the time zone of the command execution host is Japan, this becomes 1970/01/01 09:00:00 through 2038/01/19 12:14:07 (GMT+9:00).
(4) If the OS is UNIX, the default locale of the connected user defined in the agentless connection target must be set to the language code used by the JP1/IM - Manager
Cautions
(1) Do not run multiple instances of this component on the same execution target server.
(2) Do not execute jcoevtreport simultaneous with the execution of this plugin.
Version
02.00.00
Plug-in tags
Gather JP1 information,IM,Windows,Linux,AIX
Plug-in name displayed in the task log
jp1imRetrieveEvent
Return code
0: Normal
11: Error (user error) Definition file's contents are invalid
12: Error (user error) Invalid property
13: Error (user error) Authentication disabled
20: Error (user error) Other user error
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
22: Error (invalid environment) Insufficient memory or disk capacity
23: Error (invalid environment) Required environment is invalid
24: Error (invalid environment) Start status is invalid
25: Error (invalid environment) Communication error
26: Error (linked product error) Internal error
41: Error (error detected in plugin) Missing property (error detected in plugin script)
42: Error (error detected in plugin) Internal error (error detected in the plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
JP1IM.outputFileName |
output file name |
Specifies the name of the CSV file to which the JP1 event information acquired. |
-- |
Input |
R |
|
JP1IM.jp1imStartTime |
Output target start date and time |
Specifies the start date of the events to output. The specification format is YYYY-MM-DD. The time is set to 00:00:00. |
-- |
Input |
R |
|
JP1IM.jp1imEndtime |
Output target end date and time |
Specifies the end date of the events to output. The specification format is YYYY-MM-DD. The time is set to 00:00:00. |
-- |
Input |
R |
|
JP1IM.jp1imFilterName |
Filter file name |
Specifies the full path name of the filter file for output of event reports. |
-- |
Input |
O |
|
JP1IM.jp1imLHostName |
JP1/IM logical host name |
Specifies the JP1/IM logical host name. |
-- |
Input |
O |
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |