2.7.2 Get JP1/IM and JP1/Base logs
Function
This service template runs the data collection tool of the specified server's JP1/Base and JP1/IM - Manager. Files generated by options can be transferred to the JP1/AO server.
This service template assumes that the following servers are being used.
• Monitoring server
These are servers running JP1/IM - Manager.
(1) A folder for holding generated files (property OS.folderPathRemote) is created on the monitoring server (remote).
(2) The data collection tool of the specified server's JP1/Base and JP1/IM - Manager is executed in remote. The results of the data collection tool are stored in the folder created on the monitoring server.
(3) During transfer of files generated on the JP1/AO server (local), a folder for holding generated files (property OS.folderPathLocal\immtemp) is created on the JP1/AO server (local), and the files are transferred from remote to local. If you want the generated files to be transferred to the JP1/AO server, set property common.transferLogFile to yes. The folder created on the monitoring server is not deleted regardless of whether or not the created folder and generated files are transferred.
The following information is collected. Note that when 1st is specified for property jp1.informationLevel, the information of the primary data (the first folder or file created by the data collection tool) is transferred to the JP1/AO server. When 2nd is specified, the information of the primary and secondary data (the second folder or file created by the tool) is transferred to the JP1/AO server.
• All information that can be acquired by the data collection tool (no options specified) of JP1/IM - Manager
• All information that can be acquired by the data collection tool (no options specified) of JP1/Base
The messages output by the data collection tool of JP1/IM - Manager and the data collection tool of JP1/Base are stored under folders created by the monitoring server, and named as follows:
• Messages output by the data collection tool of JP1/IM - Manager: jp1imGetLog_result.log
• Messages output by the data collection tool of JP1/Base: jp1baseGetLog_result.log
Prerequisites
For the latest support information about [Required product for 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) The following products are running on the monitoring server:
Job Management Partner 1/Integrated Management - Manager 09-00 or later, or
JP1/Integrated Management - Manager 11-00 or later
Job Management Partner 1/Base 09-00 or later, or
JP1/Base 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) With this service, a folder on the JP1/AO side for storing collected files is created under the name of immtempp at the path specified in property OS.folderPathLocal, and a storage folder is created on the monitoring server side for collected files in property OS.folderPathRemote.
(2) If the monitoring server's JP1/IM - Manage is in a cluster configuration, specify the name of the physical host on which the logical host is running in property common.targetHost, and the logical host name in property jp1im.jp1imLHostName.
(3) When the data collection tool result 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.
Cautions
(1) Do not run multiple instances of this service on the same server.
(2) If there is a folder named immtemp at the path specified in property OS.folderPathLocal, it is generated again after the immtemp folder is deleted.
(3) If there is a file with the same name as the folder specified in property OS.folderPathLocal or OS.folderPathRemote, the service ends abnormally.
(4) The total volume of data collected by the data collection tool varies greatly depending on the environment in which it is used. Estimate the volume before execution, and then check the available space on the machine you plan to use. See the release notes for the product in question regarding the size of data collected.
(5) When transferring files to the JP1/AO server, the service (the file forwarding plugin) might take a while to execute if the total size of the files is large.
(6) When you specify a logical host name, specify the length of the folder path so that it fulfills the following conditions.
• folder-path-(remote)-length <= 218 - {(logical-host-name-length) - 11} * 2
• folder-path-(local)-length <= 208 - {(logical-host-name-length) - 11} * 2
(7) Do not use environment variables in property OS.folderPathRemote or property OS.folderPathLocal.
(8) If yes is specified as the value of property common.transferLogFile, do not specify a blank as the value of property OS.folderPathLocal and property jp1.informationLevel. If a blank is specified, the service ends abnormally.
(9) If you are executing this service in a UNIX environment, do not use multibyte characters in properties.
(10) If a service ends abnormally in the JP1/IM troubleshooting information acquisition or JP1/Base troubleshooting information acquisition plugin, and the task log displays the message "Standard output of the KNAE08132-E command is larger than the upper limit, so processing was suspended (upper limit: 100 KB).", check the content of the following files.
• Messages output by the data collection tool of JP1//IM - Manager: jp1imGetLog_result.log
• Messages output by the data collection tool of JP1/Base: jp1baseGetLog_result.log
Version
03.00.00
Tags
Troubleshoot JP1,IM,Base
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 |
|
Storage information for collected data |
Specify the destination for the generated data and the level of data to transfer to the JP1/AO server. |
Y |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" 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 |
|---|---|---|---|---|---|---|
|
common.targetHost |
Host name of the monitoring server |
Specify the host name or IP address of the monitoring server. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
Monitored system environment information |
|
OS.folderPathRemote |
Folder path (remote) |
Specify the full path of the remote folder in which to temporarily store data collected by the data collection tool. |
Input |
Disabled |
R |
Storage information for collected data |
|
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 |
|
common.transferLogFile |
Whether to transfer log file |
Specifies whether or not to transfer results from the data collection tool to the JP1/AO server. |
Input |
Disabled |
R |
Storage information for collected data |
|
OS.folderPathLocal |
Folder path (local) |
Specify the folder on the JP1/AO server in which to store data collected by the data collection tool. In case of transferring log file, it's mandatory. |
Input |
Disabled |
O |
Storage information for collected data |
|
jp1.informationLevel |
Level of information |
Specify the level of information to be transferred to JP1/AO server, as "1st" (primary information) or "2nd" (secondary information). This property is mandatory when transferring log files. |
Input |
Disabled |
O |
Storage information for collected data |
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 |
|---|---|
|
common.targetHost |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
OS.folderPathRemote |
A character string of no more than 228 characters can be entered. It cannot include <, >, |, ;, &, %, ", *, ), ` or a trailing \ and /. |
|
jp1im.jp1imLHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
common.transferLogFile |
Select one of the following values: yes,no |
|
OS.folderPathLocal |
A character string of no more than 208 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", or a trailing \ or /. |
|
jp1.informationLevel |
Select one of the following values: 1st,2nd |
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 |
checkOS |
Flow Plug-in |
Outputs the type of OS. |
-- |
|
1-1 |
Output OS type |
Outputs the type of OS of the monitoring server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
1-2 |
Output OS type |
Outputs the OS of the JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
2 |
osCreateFolder |
Flow Plug-in |
Creates a folder. |
-- |
|
2-1 |
Create folder |
Creates a folder on a monitoring server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
3 |
getLogFile |
Flow Plug-in |
Acquires a log. |
-- |
|
3-1 |
Get JP1/Base troubleshooting information |
Acquires a JP1/Base log and stores it in a specified folder. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
3-2 |
Get JP1/IM troubleshooting information |
Acquires a JP1/IM log and stores it in a specified folder. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4 |
fileTransfer |
Flow Plug-in |
Transfers a file. |
-- |
|
4-3 |
Compatible Plug-in |
Ascertains whether a value matches the value indicating whether a log file transfer is required. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4 |
Flow Plug-in |
Transfers a file. |
-- |
|
|
4-4-1 |
Compatible Plug-in |
Checks whether JP1/AO server is Windows. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2 |
Flow Plug-in |
-- |
-- |
|
|
4-4-2-1 |
Delete folder |
Deletes a folder on the JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-2 |
Flow Plug-in |
Creates a folder. |
-- |
|
|
4-4-2-2-1 |
Create folder |
Creates a folder on a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-2-2 |
Create folder |
Creates a folder on a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-2-5 |
Compatible Plug-in |
Ascertains whether a logical host name was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-2-6 |
Create folder |
Creates a folder on a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3 |
Flow Plug-in |
Transfers a file. |
-- |
|
|
4-4-2-3-1 |
Compatible Plug-in |
Checks whether a monitoring server is Windows. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2 |
Flow Plug-in |
If it is Windows, conducts file transfer processing. |
-- |
|
|
4-4-2-3-2-1 |
Compatible Plug-in |
Ascertains whether secondary was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-2 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-2-2-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-2-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-2-3 |
Compatible Plug-in |
Ascertains whether a logical host name was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-2-4 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-2-2-4-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-2-4-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-3 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-2-3-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-3-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-3-3 |
Compatible Plug-in |
Ascertains whether a logical host name was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-3-4 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-2-3-4-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-2-3-4-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-3 |
Compatible Plug-in |
Checks whether a monitoring server is UNIX. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4 |
Flow Plug-in |
If it is UNIX, conducts file transfer processing. |
-- |
|
|
4-4-2-3-4-1 |
Compatible Plug-in |
Checks whether a monitoring server is Linux. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2 |
Flow Plug-in |
If it is Linux, conducts file transfer processing. |
-- |
|
|
4-4-2-3-4-2-1 |
Compatible Plug-in |
Ascertains whether secondary was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-2 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-2-2-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-2-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-2-3 |
Compatible Plug-in |
Ascertains whether a logical host name was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-2-4 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-2-2-4-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-2-4-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-3 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-2-3-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-3-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-3-3 |
Compatible Plug-in |
Ascertains whether a logical host name was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-3-4 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-2-3-4-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-2-3-4-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-3 |
Compatible Plug-in |
Checks whether a monitoring server is not Linux. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4 |
Flow Plug-in |
If it is not Linux, conducts file transfer processing. |
-- |
|
|
4-4-2-3-4-4-2-1 |
Compatible Plug-in |
Ascertains whether secondary was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-2 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-4-2-2-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-2-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-2-3 |
Compatible Plug-in |
Ascertains whether a logical host name was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-2-4 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-4-2-2-4-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-2-4-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-3 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-4-2-3-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-3-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-3-3 |
Compatible Plug-in |
Ascertains whether a logical host name was specified. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-3-4 |
Flow Plug-in |
Transfers collected files to a JP1/AO server. |
-- |
|
|
4-4-2-3-4-4-2-3-4-1 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-2-3-4-4-2-3-4-2 |
File-forwarding plug-in |
Transfers collected files to a JP1/AO server. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-3 |
Compatible Plug-in |
Checks whether JP1/AO server is Unix. |
Eliminate the cause of the error, and then re-execute the service. |
|
|
4-4-4 |
Flow Plug-in |
-- |
-- |
|