4.10.10 Set agent hierarchy
Function
Imports JP1/PFM's agent hierarchy definition information and creates and updates the agent hierarchy displayed in JP1/PFM's GUI.
This plugin assumes the following servers:
• Execution target server
This server executes the plugin and imports the agent hierarchy definition file. JP1/PFM - Manager must have already been set up.
Use situation
When you have added a remote agent to JP1/PFM - RM by using the jp1pfmAddRemoteAgent plugin, you use this plugin to display the added remote agent in the User Agents.
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 - Manager 10-00 or later, or
JP1/Performance 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) The following file is stored on the execution target server:
• Agent hierarchy definition file (file specified in the jpcconf agttree import command)
(2) If the execution target server has a cluster configuration, specify in the plugin.destinationHost property the name of the physical host on which JP1/PFM - Manager's logical host is running, and specify the JP1/PFM - Manager's logical host name in the JP1.logicalHostName property.
Cautions
(1) This command cannot be executed if JP1/PFM - Manager's View Server service is stopped on the execution target server.
Version
02.00.00
Plug-in tags
Configure JP1,PFM,Windows,Linux,AIX
Plug-in name displayed in the task log
jp1pfmAddAgentTreeDef
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
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
24: Error (invalid environment) Start status is invalid
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.agentLevelDefinitionFileName |
Agent tree definition file name |
Specify the full path of the JP1/PFM agent tree 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 - Manager 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 |