4.10.14 Get report
Function
This plugin collects the performance information of the monitoring target agent.
This plugin assumes that the following server is being used.
• PFM management server (Execution target server)
This is the target that executes This plugin. JP1/PFM - WEB Console must have been set up.
Use situation
This plugin is used to create reports on systems that monitor performance.
Prerequisites
For the latest support information about [Required products on the execution target server]/[Prerequisite product OS running on the execution target server], see the release notes.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target server]
(1)JP1/PFM - Web Console
(2)JP1/PFM - Manager
(3)JP1/PFM - RM
[Prerequisite product OS running on the execution target server]
(1) Windows Server 2016 Standard/Datacenter
(2) Windows Server 2019 Standard/Datacenter
(3) Windows Server 2022 Standard/Datacenter
(4) Red Hat Enterprise Linux Server 7
(5) Red Hat Enterprise Linux Server 8
[Usage conditions for required products on the execution target server]
None.
[Other usage conditions]
(1) The JP1/PFM - Manager connected with the JP1/PFM - Web Console, which is a prerequisite product on the execution target server, and the JP1/PFM - RM corresponding to the service ID are running.
Cautions
(1) Reports cannot be output in HTML format. Do not specify <html-output> in the input file definitions.
Execution privilege
Windows: Administrator permission
Linux: root permission
Version
02.00.00
Plug-in tags
Gather JP1 information,PFM,Windows,Linux
Plug-in name displayed in the task log
jp1pfmReportRemoteAgent
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
14: Error (user error) File access disabled
15: Error (user error) No more agents can be added to the specified instance because 50 agents have already been added (error detected in the plugin script)
16: Error (user error) <html-output> is specified in the input file definition
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
25: Error (invalid environment) Communication error
26: Error (linked product error) Internal error
27: Error (check task logs for the nature of 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 |
|---|---|---|---|---|---|
|
JP1PFM.inputFileName |
Input File Name |
Specifies the name of the input file that contains the definitions for displaying the report. |
-- |
Input |
R |
|
JP1PFM.serviceID |
JP1/PFM - RM agent's service ID |
Specify the service ID of the JP1/PFM - RM remote agent to be defined. |
-- |
Input |
R |
|
JP1PFM.reportOutputFileName |
Report Output File Name |
Specifies the name of the file to which the report is to be output. |
-- |
Input |
R |
|
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 |