4.8.1 Collect JP1/IM troubleshooting information
Function
Collects troubleshooting information for JP1/Integrated Management - Manager (hereafter called JP1/IM) on a specified server.
This plugin assumes the following server:
• Monitoring server (Execution target server)
This is the server on which JP1/IM troubleshooting information is collected. The JP1/IM described in the prerequisites must have already been set up.
The plugin collects troubleshooting information in the folder specified in the JP1IM.logFolder property.
The plugin collects the information described below (for details about the information that is collected and the storage format, see the JP1/IM manual):
• All information that can be collected by JP1/IM's data collection tool (with no options specified)
Messages output by JP1/IM's data collection tool are stored as jp1imGetLog_result.log immediately under the folder specified in the JP1IM.logFolder property.
Use situation
You use this plugin to collect JP1/IM troubleshooting information for purposes of investigating problems that occur in JP1/IM.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
(1)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 in 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 has a cluster configuration, specify in the plugin.destinationHost property the name of the physical host on which JP1/IM's logical host is running, and specify JP1/IM's logical host name in the JP1.logicalHostName property.
Cautions
(1) Do not execute multiple instances of this plugin concurrently on the same execution target server.
(2) If the OS of the target server is Windows and an existing folder is specified in JP1IM.logFolder, the plugin deletes that folder and then re-creates it. Do not specify the name of a folder that contains files that should not be deleted.
Version
02.00.00
Plug-in tags
Troubleshoot JP1,IM,Windows,Linux,AIX
Plug-in name displayed in the task log
jp1imGetLog
Return code
0: Normal
12: Error (user error) Invalid property
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
JP1IM.logFolder |
Folder for storing collected files |
Specify the full path of the folder that will store files collected by the JP1/IM information collection tool. |
-- |
Input |
R |
|
JP1.logicalHostName |
Logical host name for the execution target server |
Specify the JP1 logical host name of the execution target server. |
-- |
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 |