2.5.22 Get JP1 events
Function
This service template acquires information about JP1 events from the JP1/IM - Manager integrated monitoring database.
JP1 events are acquired and used for purposes such as analysis of system failure status.
This service template assumes that the following servers are being used.
• Monitoring server
These are Windows servers running JP1/IM - Manager.
The following summarizes the processing.
(1) JP1 event information registered in the integrated monitoring database is output in CSV format to a specified file. 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.
(2) If the generated file is to be transferred to a JP1/AO server, JP1 event information is transferred from the monitoring server to the JP1/AO server, and the temporary folder created on the monitoring server is deleted. In that case, set the event information transfer option (property jp1im.transferJP1EventFile) to yes.
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1)JP1/IM - Manager is running.
Job Management Partner 1/Integrated Management - Manager 09-00 or later, or
JP1/Integrated Management - Manager 11-00 or later
[Prerequisite product OS running in the system executing the service template]
(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 of prerequisite products in the system executing the service template]
(1) The JP1/IM - Manager integrated monitoring database is used.
(2) When JP1 event information is transferred to a JP1/AO server, the JP1/AO server (loopback address resolved by localhost) and the server that is the connection destination must be set as agentless connection destinations.
(3) If the running OS is UNIX, the default locale defined in the agentless-connection target for the connected user must be set to the language code operated by JP1/IM - Manager.
Cautions
(1) Do not execute multiple instances of this service simultaneously on the same monitoring server.
(2) This service executes the jcoevtreport command on the monitoring server. Therefore, do not simultaneously execute the jcoevtreport command on the monitoring server while executing the service. For the same reason, do not execute this service while the jcoevtreport command is executing on the monitoring server.
(3) When a large volume of JP1 event information is output, the system might be affected by JP1 event acquisition and file transfers. Adjust the settings of, for example, the interval between the output destination start date (property jp1im.jp1imStartTime) and output destination finish date (property jp1im.jp1imEndTime), and the event conditions within the filter file, to keep down the output of JP1 event information.
(4) When executing the service again for a monitoring server that has already executed the service and stored JP1 event information, change the value of the output folder name (remote; property jp1im.jp1imOutputFolderPathRemote) before executing. If the values are the same, the stored JP1 event information will also be transferred simultaneously.
(5) If this service is executed for a UNIX environment, do not use multi-byte characters in the properties.
(6) If multi-byte characters are specified, specify the path of the output (remote) folder by using a maximum of 226 bytes.
(7) When a folder has already been specified as local, the local folder is overwritten. Also, when there is a file by the same name in the folder, it too is overwritten. For this reason, exercise sufficient caution that folder names are specified correctly.
(8) If there is no folder at the path specified as remote, the folder is created. The created folder is left undeleted. If it is not used periodically, delete it.
Version
03.00.00
Tags
Gather JP1 information,IM
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Monitored system environment information |
Specify the environment information for the monitoring server. |
Y |
|
JP1 event acquisition information |
Specify the information on the JP1 Events to be retrieved. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1im.jp1imHostName |
JP1/IM host name |
Specifies the host name or IP address where JP1/IM is installed. IPv6 addresses are not supported. In the case of a cluster configuration, specify the physical host or logical host of the active server. |
Input |
Disabled |
R |
Monitored system environment information |
|
jp1im.jp1imLHostName |
JP1/IM logical host name |
Specify the logical host name of JP1/IM (when using JP1/IM in a cluster configuration). |
Input |
Disabled |
O |
Monitored system environment information |
|
jp1im.jp1imFilterFileName |
Filter file name (local) |
Specifies the full path name on the JP1/AO server of the filter file for event report output. |
Input |
Disabled |
O |
JP1 event acquisition information |
|
jp1im.jp1imOutputFolderPathRemote |
Output folder name (remote) |
Specifies the full path name of the folder where the JP1 event information is to be acquired. Creates a folder named jp1imtemp under the specified folder and stores the JP1 event information there. |
Input |
Disabled |
R |
JP1 event acquisition information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1im.transferJP1EventFile |
Whether to transfer event information |
Specifies whether or not to transfer JP1 event information to the JP1/AO server. If transfer is specified, the jp1imtemp folder created in the output folder (remote) is deleted. |
Input |
Disabled |
R |
JP1 event acquisition information |
|
jp1im.jp1imOutputFolderPathLocal |
Output folder name (local) |
Specifies the full path name of the folder on the JP1/AO server where the JP1 event information is to be acquired. The JP1/IM host name must be specified if you want to transfer the JP1 event information to the JP1/AO server. |
Input |
Disabled |
O |
JP1 event acquisition information |
|
jp1im.jp1imStartTime |
Output start date and time |
Specifies the start date of the events to output. The time is set to 00:00:00. |
Input |
Disabled |
R |
JP1 event acquisition information |
|
jp1im.jp1imEndTime |
Output end date and time |
Specifies the end date of the events to output. The time is set to 00:00:00. |
Input |
Disabled |
R |
JP1 event acquisition information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1im.jp1imHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
jp1im.jp1imLHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
jp1im.jp1imFilterFileName |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \ or /. |
|
jp1im.jp1imOutputFolderPathRemote |
A character string of no more than 226 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \ or /. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1im.transferJP1EventFile |
Select one of the following values: yes,no |
|
jp1im.jp1imOutputFolderPathLocal |
A character string of no more than 239 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \ or /. |
|
jp1im.jp1imStartTime |
0 |
|
jp1im.jp1imEndTime |
0 |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
outputEventInformation |
Flow Plug-in |
Acquires JP1 event information. |
-- |
|
1-3 |
Flow Plug-in |
Acquires JP1 event information. |
-- |
|
|
1-3-1 |
Flow Plug-in |
Determines the type of OS. |
-- |
|
|
1-3-1-1 |
Output OS type |
Acquire OS information. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-2 |
Compatible Plug-in |
Checks whether the OS is Windows. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-3 |
Flow Plug-in |
If it is Windows, acquires JP1 event information. |
-- |
|
|
1-3-3-1 |
Create folder |
Creates a folder. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-3-2 |
Compatible Plug-in |
Checks whether a filter file has been specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-3-3 |
Flow Plug-in |
If a filter file has been specified, acquires JP1 event information. |
-- |
|
|
1-3-3-3-1 |
File-forwarding plug-in |
Transfers a filter file. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-3-3-2 |
Get JP1 event |
Acquires JP1 event information. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-3-3-3 |
Delete file |
Deletes a filter file. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-3-4 |
Compatible Plug-in |
Checks whether a filter file has been specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-3-5 |
Flow Plug-in |
If a filter file has not been specified, acquires JP1 event information. |
-- |
|
|
1-3-3-5-1 |
Get JP1 event |
Acquires JP1 event information. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-4 |
Compatible Plug-in |
Checks whether the OS is UNIX. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-5 |
Flow Plug-in |
If it is UNIX, acquires JP1 event information. |
-- |
|
|
1-3-5-1 |
Create folder |
Creates a folder. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-5-2 |
Compatible Plug-in |
Checks whether a filter file has been specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-5-3 |
Flow Plug-in |
If a filter file has been specified, acquires JP1 event information. |
-- |
|
|
1-3-5-3-1 |
File-forwarding plug-in |
Transfers a filter file. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-5-3-2 |
Get JP1 event |
Acquires JP1 event information. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-5-3-3 |
Delete file |
Deletes a filter file. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-5-4 |
Compatible Plug-in |
Checks whether a filter file has been specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-3-5-5 |
Flow Plug-in |
If a filter file has not been specified, acquires JP1 event information. |
-- |
|
|
1-3-5-5-1 |
Get JP1 event |
Acquires JP1 event information. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2 |
outputFileTransfer |
Flow Plug-in |
Transfer JP1 event information. |
-- |
|
2-3 |
Compatible Plug-in |
Checks whether yes was specified for file transfer. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2-4 |
Flow Plug-in |
Transfer JP1 event information. |
-- |
|
|
2-4-1 |
Compatible Plug-in |
Checks whether the OS is Windows. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2-4-2 |
Flow Plug-in |
If it is Windows, acquires Transfer JP1 event information. |
-- |
|
|
2-4-2-1 |
FileTransfer Plug-in |
Transfer JP1 event information. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2-4-2-2 |
osDeleteFolder |
Deletes temporary folder. |
Files remain in the target server. Delete them manually. |
|
|
2-4-3 |
Compatible Plug-in |
Checks whether the OS is UNIX. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2-4-4 |
Flow Plug-in |
If it is UNIX, acquires Transfer JP1 event information. |
-- |
|
|
2-4-4-1 |
FileTransfer Plug-in |
Transfer JP1 event information. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2-4-4-2 |
osDeleteFolder |
Deletes temporary directory. |
Files remain in the target server. Delete them manually. |
|