4.10.17 Add monitoring target (JP1/PFM - RM)
Function
Adds a monitored target (remote agent) to JP1/PFM - RM for Platform (hereafter called JP1/PFM - RM).
This plugin assumes the following server:
• PFM-RM server (Execution target server)
This is the server on which this plugin is executed. JP1/PFM - RM must have already been set up.
• Server being monitored
This is a server that is added to JP1/PFM - RM as a target to be monitored.
Use situation
You use this plugin to add a newly configured server as a monitored target in a system using JP1/PFM - RM for performance monitoring.
You can optimize the monitoring configuration task in JP1/PFM - RM by using this plugin together with the following plugins:
• jp1pfmSetRemoteAgent
• jp1pfmAddStoreDataDef
• jp1pfmBindAlarm
• jp1pfmAddProcessDef
• jp1pfmAddAgentTreeDef
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/Performance Management - Remote Monitor for Platform 10-00 or later, or
JP1/Performance Management - Remote Monitor for Platform 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)
[Usage conditions for required products on the execution target server]
(1) A monitoring instance is running on the JP1/PFM - RM to which a monitored server is to be added.
(2) The following file is stored on the execution target server:
• Monitored target definition file (file name specified in the jpcconf target setup command)
In the monitored target definition file, specify the following value for Target Host:
#AGENTNAME#
(3) If the execution target server has a cluster configuration, specify in the common.targetHostName property the name of the physical host on which JP1/PFM - RM's logical host is running, and specify JP1/PFM - RM's logical host name in the JP1.logicalHostName property.
(4) The product name display function is enabled in the execution target server's JP1/PFM - RM.
Cautions
(1) Do not execute multiple instances of this plugin concurrently on the same execution target server.
(2) The OSs that can be monitored depend on the OS of JP1/PFM - RM:
In JP1/PFM - RM on Linux, only UNIX and Linux can be monitored.
In JP1/PFM - RM on Windows, Windows, UNIX, and Linux can be monitored.
(3) The maximum number of remote agents that can be added to a single monitoring instance of JP1/PFM - RM is 50. When the number of remote agents exceeds 50, this plugin results in an error.
(4) Specify "RMPlatform" for the JP1PFM.serviceKey property. Operation with any other value specified is not supported.
Version
02.00.00
Plug-in tags
Configure JP1,PFM,Windows,Linux
Plug-in name displayed in the task log
jp1pfmAddRemoteAgent
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)
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
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.serviceKey |
JP1/PFM product's service key |
Specify RMPlatform as the JP1/PFM - RM service key. |
-- |
Input |
R |
|
JP1PFM.instanceName |
Name of a JP1/PFM - RM instance |
Specify the name of the JP1/PFM - RM instance that the monitored server's remote agent belongs to. |
-- |
Input |
R |
|
JP1PFM.targetName |
Host name of the monitored server |
Specify the host name of the monitored server. |
-- |
Input |
R |
|
JP1PFM.targetDefinitionFileName |
Monitoring target definition file name |
Specify the full path of the monitoring target definition file on the execution target server. |
-- |
Input |
R |
|
JP1.logicalHostName |
Logical host name for the execution target server |
Specify the logical host name in JP1/PFM - RM 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 |