4.9.3 Add monitoring setting
Function
Specifies the performance data recording method for an agent managed by JP1/PFM.
This plugin assumes the following server:
• PFM management server (Execution target server)
This is the server on which this plugin is executed. JP1/PFM - Web Console must have already been set up.
Use situation
You use this plugin to initialize an added remote agent 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:
• jp1pfmAddStoreDataDef
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)Job Management Partner 1/Automatic Operation 10-00 or later
[Required products on the execution target server]
(1)Job Management Partner 1/Performance Management - Web Console 10-00 or later
[Prerequisite product OS running in the execution target server]
(1) Windows Server 2003,Standard Edition/Enterprise Edition (x86/x64) SP1 or later,Windows Server 2003 R2,Standard Edition/Enterprise Edition (x86/x64)
(2) Windows Server 2008 Standard/Enterprise (x86/x64),Windows Server 2008 R2 Standard/Enterprise/Datacenter
(3) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(4) Red Hat Enterprise Linux 5 Advanced Platform (x86), Red Hat Enterprise Linux 5 (x86), Red Hat Enterprise Linux 5 Advanced Platform (AMD/Intel 64), Red Hat Enterprise Linux 5 (AMD/Intel 64)
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
[Usage conditions for required products on the execution target server]
(1) The following file is stored on the execution target server:
• Recording method definition file (file specified in the jpcasrec update command)
If the following character strings are specified in the service tags in the file, they are replaced with the specified property values as shown below:
#INSTANCENAME#: Job Management Partner 1PFM - RM's instance name
#AGENTNAME#: Monitored server's host name
#REMOTEMONITORHOST#: Name of the host on which the Remote Monitor Collector service is running
Example service tag specifications:
<service id="7A1#INSTANCENAME#[#REMOTEMONITORHOST#]">
<service id="7A1#INSTANCENAME#[#AGENTNAME#@#REMOTEMONITORHOST#]">
(2) A key file for authentication has been created on the execution target server, by using a user account with the Job Management Partner 1/PFM administrator user permissions.
Version
01.00.04
Category
JP1/PFM
Plug-in name displayed in the task log
jp1pfmSetRemoteAgent
Return code
0: Normal
12: Error (user error) Invalid property
13: Error (user error) Authentication disabled
14: Error (user error) File access disabled
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.recordingMethodDefinitionFileName |
Recording method definition file name |
Specify the full path of the JP1/PFM recording method definition file on the execution target server. |
-- |
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 |
O |
|
JP1PFM.targetName |
Host name of the monitored server |
Specify the host name of the monitored server. |
-- |
Input |
O |
|
JP1PFM.remoteMonitorHost |
Remote Monitor Collector service activity host name |
Specifies the Remote Monitor Collector service activity host name. |
-- |
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 |