Hitachi

JP1 Version 12 JP1/Performance Management - Remote Monitor for Platform Description, User's Guide and Reference


3.1.4 Setup procedure for the Windows edition

This subsection describes how to set up PFM - RM for Platform.

[Figure] indicates the following setup items:

Organization of this subsection

(1) Registering PFM - RM for Platform[Figure]

To achieve central management of PFM - RM for Platform in the Performance Management system, you must register PFM - RM for Platform into PFM - Manager and PFM - Web Console.

If PFM - RM for Platform is already registered in PFM - Manager and PFM - Web Console, you do not have to follow the procedure described below. If PFM - RM for Platform is not registered yet, manually register PFM - RM for Platform according to the procedure.

You can determine whether manual registration of PFM - RM for Platform is necessary by referring to the conditions described below.

Manually registering PFM - RM for Platform in PFM - Manager

When all of the following conditions apply, manually register PFM - RM for Platform in PFM - Manager:

  • The PFM - RM for Platform to be installed is of a product version that is not specified in the Release Notes for PFM - Manager.

  • PFM - RM for Platform is installed on a host other than PFM - Manager.

Manually registering PFM - RM for Platform in PFM - Web Console

When the following condition applies, manually register PFM - RM for Platform in PFM - Web Console:

  • The PFM - RM for Platform to be installed is of a product version that is not specified in the Release Notes for PFM - Web Console.

If, however, the Release Notes for PFM - RM for Platform state that it is necessary to execute the setup command, execute the setup command.

The following figure shows the procedure for registering PFM - RM for Platform.

Figure 3‒6: Procedure for registering PFM - RM for Platform (for Windows)

[Figure]

Notes about registering PFM - RM for Platform
  • Register PFM - RM for Platform before you set up an instance environment.

  • If you install different versions of PFM - RM for Platform on separate hosts, set up old versions before you set up new versions.

  • If you install PFM - RM for Platform on the same host as where PFM - Manager is installed, the jpcconf agent setup command executes automatically.

  • When PFM - RM for Platform is registered, folders named RM Platform are created on the Reports and Alarms pages of PFM - Web Console. If you have already created a folder or file named RM Platform on the Reports page, you must rename it before starting the registration procedure.

The following subsections describe how to register PFM - RM for Platform.

(a) Copying the setup files for PFM - RM for Platform

Copy the setup files from the PFM - RM host to the hosts where PFM - Manager and PFM - Web Console are installed.

To copy the setup files:

  1. Stop PFM - Web Console.

    If PFM - Web Console is running, stop it.

  2. Copy the setup files in the binary mode.

    Copy the files from the PFM - RM host to the PFM - Manager and PFM - Web Console hosts.

    The following table lists the source file storage locations and the copy destination locations.

    Table 3‒6: Setup files to be copied (for Windows)

    No.

    Source (setup files for PFM - RM for Platform)

    Target

    Program name

    OS

    Target folder

    1

    installation-folder\setup\jpcagt7w.EXE

    PFM - Manager

    Windows

    PFM-Manager-installation-folder\setup

    2

    installation-folder\setup\jpcagt7u.Z

    UNIX

    /opt/jp1pc/setup/

    3

    installation-folder\setup\jpcagt7w.EXE

    PFM - Web Console

    Windows

    PFM-Web-Console-installation-folder\setup

    4

    installation-folder\setup\jpcagt7u.Z

    UNIX

    /opt/jp1pcwebcon/setup/

(b) Executing the setup command at the PFM - Manager host

At the PFM - Manager host, execute the setup command for PFM - RM for Platform.

Execute the following command:

jpcconf agent setup -key RMPlatform

This example shows execution in the interactive mode, but you can also execute the jpcconf agent setup command in the non-interactive mode. For details about this command, see the chapter that describes commands in the manual JP1/Performance Management Reference.

Notes about executing the command

Before you execute the command, stop all Performance Management programs and services. An error might occur if the jpcconf agent setup command is executed before all Performance Management programs and services have stopped completely. If an error has occurred, re-execute the jpcconf agent setup command.

After you have executed the setup command at the PFM - Manager host, you might delete the setup files for PFM - RM for Platform that were copied to the PFM - Manager.

(c) Executing the setup command at the PFM - Web Console host

At the PFM - Web Console host, execute the setup command for PFM - RM for Platform.

Execute the following command:

jpcwagtsetup

After you have executed the setup command at the PFM - Web Console host, you might delete the setup files for PFM - RM for Platform that were copied to the PFM - Web Console.

(2) Setting up an instance environment

Set up an instance environment for PFM - RM for Platform on the PFM - RM host. To set up multiple instance environments, repeat this procedure. With PFM - RM for Platform, you can define a maximum of 50 monitoring targets in a single instance environment.

Monitored hosts running Windows and those running UNIX can coexist within a single instance.

Using common account information in an instance environment

If you specify Y for the UseCommonAccount instance environment setting item, common account information (pfmhost) that was created beforehand for the instance environment is used.

The following table lists the correspondence between instance environment setting items and common account information setting items.

Table 3‒7: Correspondence between instance environment setting items and common account information setting items

Instance environment setting item

Common account information (pfmhost) setting item

Description

RMHost_User

User

User name

RMHost_Password

Password

Password

RMHost_Domain

Domain

Domain name

Note 1:

Common account information must be created on the PFM - RM host beforehand. Use the jpcconf acc setup command to create common account information. For details about the jpcconf acc setup command, see the chapter that describes commands in the manual JP1/Performance Management Reference.

Note 2:

The settings and precautions required for creating common account information (pfmhost) are the same as for the corresponding instance environment setting items. See the corresponding instance environment setting items in Table 3-9.

Notes about setting up instance environments

(a) Instance environment setting items that must be specified depending on what is monitored in the instance

The instance environment setting items that must be specified differ depending on what is monitored in the instance. The following table lists and describes the instance environment setting items that must be specified for each monitoring target in the instance.

Table 3‒8: Instance environment setting items that must be specified for each monitoring target in the instance

Item name

What is monitored in the instance

Windows environment

UNIX environment

Health check monitoring

UseCommonAccount

D

D

D

Interval

D

D

T

Std_Category

D

D

T

Disk_Category

D

D

T

Network_Category

D

D

T

Ps_Category

D

D

T

RMHost_User

Y

Y

Y

RMHost_Password

Y

Y

Y

RMHost_Domain

D

D

D

SSH_Type

N

D

N

SSH_Client

N

Y

N

Perl_Module

N

Y

N

Log_Size

D

D

D

Legend:

Y: Specification is required.

D: Specification is required if the default value is to be changed.

T: There is no need to change the default value.

N: Specification is not required.

(b) Instance environment setting items and values

The table below lists and describes the instance environment setting items and values. Check this information before you start operations.

Use the jpcconf inst setup command to set up an instance environment.

For details about how to execute the jpcconf inst setup command, see (d) Execution in the interactive mode and (e) Execution in the non-interactive mode.

For details about the jpcconf inst setup command, see the chapter that describes commands in the manual JP1/Performance Management Reference.

Table 3‒9: Instance environment setting items and values for PFM - RM for Platform (for Windows)

No.

Item name#1

Description

Setting

Default

1

UseCommonAccount

Specifies whether to use common account information.

Specify one of the following values:

  • Y: Use

  • N: Do not use

N

2

Interval

Specifies a collection interval for the collection process.

Specify a value in the range from 60 to 3,600 (seconds).

300

3

Std_Category#2

Specifies whether the collection process is to collect basic information (PI and PI_CPU records).

Specify one of the following values:

  • Y: Collect

  • N: Do not collect

Y

4

Disk_Category#2

Specifies whether the collection process is to collect disk information (PI_PDSK and PI_LDSK records).

Specify one of the following values:

  • Y: Collect

  • N: Do not collect

Y

5

Network_Category#2

Specifies whether the collection process is to collect network information (PI_NET record).

Specify one of the following values:

  • Y: Collect

  • N: Do not collect

Y

6

Ps_Category#2

Specifies whether the collection process is to collect process information (PD_APS, PD_ASVC, PD_APP2, PD_APPC, and PD_APPD records).

Specify one of the following values:

  • Y: Collect

  • N: Do not collect

Y

7

RMHost_User#3

Specifies the user account#4 used on the PFM - RM host.

From 1 to 256 bytes of characters can be specified.

The tab character cannot be used.

--

8

RMHost_Password

Specifies the password for the account used on the PFM - RM host. The characters entered in this item are not displayed on the screen. If you specify this password, you are prompted to confirm the password by entering it again.

From 1 to 256 bytes of characters can be specified.

The tab character cannot be used.

--

9

RMHost_Domain#5

Specifies the domain name to which the account used on the PFM - RM host belongs.

There is no need to specify this item if the account belongs to a workgroup.

From 0 to 256 bytes of characters can be specified.

The tab character cannot be used.

No domain name is specified.

10

SSH_Type

Specifies the type of the SSH client.

Specify one of the following character strings (lowercase):

  • putty: Use the plink.exe provided by PuTTY as the SSH client.

  • windows: Use ssh.exe provided by OpenSSH (supplied with Windows Server 2019) as the SSH client.

putty

11

SSH_Client#5

Specifies the absolute path to the execution module (plink.exe or ssh.exe) of the SSH client (PuTTY or OpenSSH) specified with SSH_Type. Even if the file path contains a space, there is no need to enclose the file path in double quotation marks ("). There is no need to specify this item if all of the monitored hosts in the instance are only running Windows.

From 0 to 256 bytes of characters can be specified.

The tab character cannot be used.

No SSH client execution module is specified.

12

Perl_Module#5

Specifies an absolute path for the execution module (perl.exe) of Perl (ActivePerl or Strawberry Perl). Even if the file path contains a space, there is no need to enclose the file path in double quotation marks ("). There is no need to specify this item if all of the monitored hosts in the instance are only running Windows.

From 0 to 256 bytes of characters can be specified.

The tab character cannot be used.

No Perl execution module is specified.

13

Log_Size

Specifies the maximum size of one agent log file. #7

Specify a value in the range from 1 to 32 (megabytes).

3

Legend:

--: No default is set.

#1

When the jpcconf inst setup command is executed in the non-interactive mode, this item name is used as a product-specific label in the definition file. For details about commands in the non-interactive mode, see the chapter that describes commands in the manual JP1/Performance Management Reference.

#2

The settings for Std_Category, Disk_Category, Network_Category, and Ps_Category are given higher priority than the collection settings for the individual records.

For example, if you set Std_Category to N (do not collect), a PI record is handled as follows:

- The PI record information is not recorded in the Store database.

- If an attempt is made to display a real-time report based on PI records from the PFM - Web Console, the KAVJS5001-I error message is displayed.

- If an alarm is bound to a PI record, that alarm does not function.

#3

PFM - RM for Platform starts the collection process by using the user account specified in RMHost_User. When adding or modifying an instance environment, you need to create a new user account and specify it for RMHost_User. However, if a profile for the newly created user account already exists, collection of performance data might fail. In such a case, log on to Windows again by using the newly created user account.

If the system is being run with enhanced file permissions, the user specified for RMHost_User must belong to the PFM operation group. For details about operations with enhanced file permissions, see the chapter that describes file permission enhancement in the JP1/Performance Management Planning and Configuration Guide.

To specify the local host as a monitored host when the user account control functionality (UAC) is enabled on the PFM - RM host, specify the local account's Built-in Administrator for RMHost_User in the instance settings.

Note that the following check boxes in the General tab of the Administrator Properties window must not be selected:

- User must change password at next logon

- Account is disabled

These notes also apply when User in common account information (pfmhost) is used. In this case, read these notes with User replacing RMHost_User in common account information (pfmhost).

#4

If you run PFM - RM for Platform in a cluster system, specify an account that can log on to both the active node and the standby node by using the same user name and password.

This also applies when User is used in the common account information (pfmhost).

#5

If both of the following conditions are met when the local host is monitored, specify the local host name for RMHost_Domain:

- The PFM - RM host is running Windows

- The PFM - RM host is a participant in a domain.

#6

You must specify this item if the instance includes a monitored host running UNIX. Additionally, when operating PFM - RM for Platform in a cluster system, specify a file path that can be accessed from both the active server and the standby server.

#7

Use the following formula for estimating the agent log size:

agent-log-size (megabytes) = ((a x 24 x 3,600) / b x 4) / (4 x 1,024)

Legend:

a: Number of days to retain the agent log

b: Instance interval value

In the agent log, a maximum of (16 + number-of-monitoring-targets x 4) files are collected per instance.

If the hard disk does not have sufficient free space, the agent log generates an output error. For details about the agent log, see 10.3 Log information to be collected for troubleshooting.

(c) Instance environment setting items that are not displayed

Instance environment setting items are usually displayed by executing a command, but some might not be displayed depending on the contents of other setting items or for some other reason. The table below lists and describes conditions that prevent instance environment setting items from being displayed. It also shows the input values that are used in such cases.

Table 3‒10: Conditions that prevent instance environment setting items from being displayed, and input values that are used

Item name

Conditions that prevent instance environment setting items from being displayed, and input values that are used

RMHost_User

These items are not displayed when Y is specified for UseCommonAccount.

Input value:

The value in the corresponding common account information is used as the input value. For details about the corresponding common account information, see Table 3-7.

RMHost_Password

RMHost_Domain

(d) Execution in the interactive mode

  1. Execute the jpcconf inst setup command.

    The following example sets up an instance environment using inst1 as the instance name:

    jpcconf inst setup -key RMPlatform -inst inst1
  2. Set up an instance environment for PFM - RM for Platform.

    Enter each instance environment setting item for PFM - RM for Platform according to the instructions given by the command. For details about each instance environment setting item, see Table 3-9. After you input each setting item, press the Enter key. To use a displayed default value, simply press the Enter key.

    The following is a setting example in which the instance includes a monitored host running UNIX:

    C:\Program Files\Hitachi\jp1pc\tools>jpcconf inst setup -key RMPlatform -inst inst1
     UseCommonAccount   [N]                  :<Enter>
     Interval             [300]                :<Enter>
     Std_Category         [Y]                  :<Enter>
     Disk_Category        [Y]                  :<Enter>
     Network_Category     [Y]                  :<Enter>
     Ps_Category          [Y]                  :<Enter>
     RMHost_User#1                             :rmuser<Enter>
     RMHost_Password#1                         :rmpass#2<Enter>
     Re-enter#1                                :rmpass#2<Enter>
     RMHost_Domain#1      []                   :<Enter>
     SSH_Type             [putty]              :<Enter>
     SSH_Client           [] :C:\Program Files\PuTTY\plink.exe#3<Enter>
     Perl_Module          [] :C:\Perl\bin\perl.exe#3<Enter>
     Log_Size (MB)        [3]                  :<Enter>
    KAVE05080-I The instance environment is now being created. (servicekey#4=RMPlatform, inst=inst1)
    KAVE05081-I The instance environment has been created. (servicekey#4=RMPlatform, inst=inst1)
    #1

    This item is not displayed when Y is specified for UseCommonAccount.

    #2

    Re-entry of the password is prompted. The entered password is not displayed on the screen.

    #3

    Enter this line if the instance includes monitored hosts running UNIX. There is no need to enter this line if all monitored hosts in the instance are running Windows.

    #4

    If the PFM - Manager's product name display function is disabled, agt7 is displayed for servicekey.

(e) Execution in the non-interactive mode

  1. Execute the jpcconf inst setup command to create a definition file template.

    Execute the command as follows:

    jpcconf inst setup -key RMPlatform -noquery -template definition-file-name

    Sections and labels that correspond to the instance environment setting items are output to a definition file. Note that the label of the Instance Definitions section is left blank.

  2. Edit the definition file template created in step 1.

    Edit the setting values as required for the instance environment.

    For details about the product-specific labels to be specified in the definition file, see Table 3-9.

    Shown below is an example of a definition file for an instance environment in which the instance includes monitored hosts running UNIX. Specify values for the labels in the Instance Definitions section as required for the instance environment.

    [Common Definitions]
    Definition File Version=0001
     
    [Product Information]
    Product ID=7
     
    [Instance Definitions]
    UseCommonAccount=
    Interval=
    Std_Category=
    Disk_Category=
    Network_Category=
    Ps_Category=
    RMHost_User#1=rmuser
    RMHost_Password#1=rmpass
    RMHost_Domain#1=
    SSH_Type=putty
    SSH_Client= C:\Program Files\PuTTY\plink.exe#2
    Perl_Module= C:\Perl\bin\perl.exe#2
    Log_Size=
    #1

    There is no need to specify values for these items if Y is specified for UseCommonAccount.

    #2

    Enter this line if the instance includes monitored hosts running UNIX. There is no need to enter this line if all monitored hosts in the instance are running Windows.

  3. Execute the jpcconf inst setup command to set up an instance environment for PFM - RM for Platform.

    The following example sets up an instance environment using inst1 as the instance name. For the -input option, specify the definition file edited in step 2.

    jpcconf inst setup -key RMPlatform -inst inst1 -noquery -input definition-file-name
Note:

If the definition file contains confidential information such as passwords, save the definition file in a secure location, and delete it after you have used it. If you want to transfer the definition file between hosts, we recommend that you use a secure file transfer protocol, such as Secure File Transfer Protocol (SFTP), which is FTP over an SSH tunnel.

When all of the settings have been completed, an instance environment can be built. The following table shows the folder structure of an instance environment.

Table 3‒11: Folder structure of an instance environment (for Windows)

No.

Storage folder

File name

Description

1

installation-folder#1\agt7\agent\instance-name

jpcagt.ini

Service startup initialization file of Remote Monitor Collector

2

jpcagt.ini.lck

Lock file for the service startup initialization file of Remote Monitor Collector (for each instance)

3

jpcagt.ini.model#2

Sample of a service startup initialization file of Remote Monitor Collector

4

status.dat

Intermediate file for internal processing

5

tstatuses.dat

Virtual Agent status information#3

6

targetlist.ini

List of monitoring targets

7

grouplist.ini

List of groups

8

GARULES.DAT

Grouping rule description file

9

targets

Storage folder for remote agent

10

groups

Storage folder for group agent

11

log

Storage folder for log files

12

installation-folder#1\agt7\store\instance-name

*.DB

Performance data file

13

*.IDX

Index files for performance data files

14

*.LCK

Lock files for performance data files

15

jpcsto.ini

Service startup initialization file of Remote Monitor Store

16

jpcsto.ini.model#2

Model file for the service startup initialization file of Remote Monitor Store

17

status.dat

Intermediate file for internal processing

18

*.DAT

Definition file for a data model

19

dump

Export folder

20

backup

Backup folder

21

partial

Partial backup folder

22

import

Import folder

23

log

Storage folder for log files

#1

If you run a logical host, replace installation-folder with environment-folder\jp1pc. An environment folder is a folder on the shared disk that is specified when the logical host is created.

#2

Use these sample files when you want to restore the settings to their initial values from when the instance environment was configured.

#3

Created when the health check function is enabled.

To change an instance environment, re-execute the jpcconf inst setup command, and then update each instance environment setting. For details about updating the instance environment settings, see 3.6.2 Updating an instance environment.

You can change some settings by using PFM - Web Console to edit properties. For details about the information that can be changed by editing properties, see F.1 List of properties of the Remote Monitor Store service.

In an instance environment, the service IDs and Windows service names are as follows:

Service IDs in an instance environment
  • For the Remote Monitor Collector service

    7Ainstance-number instance-name[host-name]

  • For the Remote Monitor Store service

    7Sinstance-number instance-name[host-name]

  • For the Group Agent service

    7Ainstance-number instance-name[All@host-name]

In PFM - RM for Platform, the instance name specified in the jpcconf inst setup command is displayed.

If the host name of the PFM - RM host is host1, and inst1 is specified as the instance name, the service IDs will be as follows:

  • For the Remote Monitor Collector service

    7A1inst1[host1]

  • For the Remote Monitor Store service

    7S1inst1[host1]

  • For the Group Agent service

    7A1inst1[All@host1]

For details about the service IDs, see the naming rules provided in the appendix in the JP1/Performance Management Planning and Configuration Guide.

Windows service names in an instance environment
  • For the Remote Monitor Collector service

    PFM - RM for Platform instance-name

  • For the Remote Monitor Store service

    PFM - RM Store for Platform instance-name

If inst1 is specified as the instance name, the service names will be as follows:

  • For the Remote Monitor Collector service

    PFM - RM for Platform inst1

  • For the Remote Monitor Store service

    PFM - RM Store for Platform inst1

For details about the Windows service names, see the naming rules provided in the appendix in the JP1/Performance Management Planning and Configuration Guide. For details about the Windows service names when a logical host is used for operation, see the chapter that describes cluster system configuration and operation in the JP1/Performance Management User's Guide.

You cannot set up an instance environment by using PFM - Web Console's facility to distributing agent-specific properties.

(f) Setting an offset value for starting performance data collection

You can set an offset value (in seconds) for starting performance data collection from monitoring targets on an instance-by-instance basis. By adjusting the offset values set for instances, you can make instances start collecting performance data at different times, thereby reducing the number of monitoring targets from which performance data is collected at a certain point in time.

For details about how to set an offset value, see 8. Definition Files in Service startup initialization file of Remote Monitor Collector (jpcagt.ini).

(3) Setting the monitored host

Set information about the monitored host for the instance specified in (2) Setting up an instance environment. You can set a maximum of 50 monitored hosts for a single instance. To set multiple monitored hosts, repeat this procedure. However, if the number of monitored hosts is large, the desired performance might not be achieved depending on the machine's performance and environment. In such a case, reduce the number of monitored hosts. Carefully validate performance before starting operations.

For PFM - RM 11-00 or later, you can specify logical hosts as monitored hosts. Note, however, that you can specify logical hosts only when monitoring whether processes or services are running. For other monitoring, we recommend that you specify physical hosts.

Important

If you specify a logical host as a monitored host for any purpose other than monitoring whether processes or services are running, correct values will not be stored for the first performance data when the machine is switched.

Using common account information for monitored hosts

If Y is set for UseCommonAccount in the setting items for the monitored host, common account information# (wmi or ssh) that is created beforehand for the monitored host is used.

#

In health check monitoring, the common account information cannot be used.

The type of the common account information to be used differs depending on whether the OS of the monitored host is Windows or UNIX. The following table lists the correspondence between the OS of the monitored host and the type of common account information.

Table 3‒12: Correspondence between the OS of the monitored host and the type of common account information

OS of the monitored host

Type of common account information

Windows

wmi

UNIX

ssh

The following tables list the correspondence between the setting items for the monitored host and those for common account information.

Table 3‒13: Correspondence between the setting items for the monitored host and those for common account information (when the OS of the monitored host is Windows)

Setting items for the monitored host

Setting items for common account information (wmi)

Description

User

User

User name

Password

Password

Password

Domain

Domain

Domain name

Table 3‒14: Correspondence between the setting items for the monitored host and those for common account information (when the OS of the monitored host is UNIX)

Setting items for the monitored host

Setting items for common account information (ssh)

Description

User

User

User name

Private_Key_File

Private_Key_File

Private key file name

Note 1:

Common account information must be created on the PFM - RM host beforehand. Use the jpcconf acc setup command to create common account information. For details about the jpcconf acc setup command, see the chapter that describes commands in the manual JP1/Performance Management Reference.

Note 2:

The settings and precautions required for creating common account information (wmi or ssh) are the same as for the corresponding monitoring target setting items. See the corresponding monitoring target setting items in Table 3-16.

Important

To use common account information, you need to unify the account information settings so that you can connect to multiple monitoring targets by using a single set of account information. For this reason, there is a risk of greater negative impact if common account information is leaked. To avoid such a risk, determine whether to use common account information after considering security measures and information management.

Notes about setting a monitored host

(a) Monitoring target setting items that must be specified depending on what is monitored

The monitoring target setting items that must be specified differ depending on what is monitored. The following table lists and describes these monitoring target setting items that must be specified for each monitoring target.

Table 3‒15: Monitoring target setting items that must be specified for each monitoring target

Item name

What is monitored

Windows environment

UNIX environment

Health check monitoring

Target Host

Y

Y

Y

UseCommonAccount

D

D

T

TargetType

T

Y

Y

User

Y

Y

N

Password

Y

N

N

Domain

D

N

N

Private_Key_File

N

Y

N

Port

N

D

N

Legend:

Y: Specification is required.

D: Specification is required if the default value is being changed.

T: There is no need to change the default value.

N: Specification is not required.

(b) Monitoring target setting items and values

The table below lists and describes the setting items and values for a monitored host. Check this information before you start operations.

Use the jpcconf target setup command to set up a monitored host.

For details about how to execute the jpcconf target setup command, see (d) Execution in the interactive mode and (e) Execution in the non-interactive mode.

For details about the jpcconf target setup command, see the chapter that describes commands in the manual JP1/Performance Management Reference.

Table 3‒16: Setting items and values for a monitored host in PFM - RM for Platform

No.

Item name#1

Description

Setting

Default

1

Target Host

Specifies the name of the monitored host#2. Specify a host name that can be resolved.#3

The specified monitored host name is used during performance data collection#4 and health checking. If JP1/IM is linked, this name is also used as the event host name.

From 1 to 32 bytes of alphanumeric characters and the hyphen (-) are permitted.

The name cannot begin with a hyphen (-).

The specified value must be unique within the instance.#5

No monitored host name is specified.#6

2

UseCommonAccount

Specifies whether to use common account information.

Specify one of the following values:

  • Y: Use

  • N: Do not use

N

3

TargetType

Specifies the method for connecting to the monitored host.

The value to be specified differs depending on whether the monitored host is running Windows or UNIX.

For health check monitoring, the value should be icmp.

  • Specify wmi if the monitored host is running Windows.

  • Specify ssh if the monitored host is running UNIX.

  • Specify icmp for health check monitoring.

wmi

4

User

Specifies the user#7, #8 used to connect to the monitored host.

From 1 to 256 bytes of characters are permitted.

The tab character is not permitted.

--

5

Password#9

Specifies the password used to connect to the monitored host.

The characters entered in this item are not displayed on the screen. When the password is specified, re-entry of the password is requested.

There is no need to specify this item if the monitored host is running UNIX.

From 0 to 256 bytes of characters are permitted.

The tab character is not permitted.

No password is specified.

6

Domain

Specifies the name of the domain#10 to which the monitored host belongs.

There is no need to specify this item if the monitored host belongs to a work group.

There is no need to specify this item if the monitored host is running UNIX.

From 0 to 256 bytes of characters are permitted.

The tab character is not permitted.

No domain name is specified.

7

Private_Key_File#11

Specifies an absolute path for the name of the private key file used in the SSH public key method. Even if the file path contains a space, there is no need to enclose the file path in double quotation marks (").

There is no need to specify this item if the monitored host is running Windows.

From 0 to 256 bytes of characters are permitted.

The tab character is not permitted.

A private key file name is not specified.

8

Port

Specifies the port number of the SSH server on the monitored host.

This item is not used if the monitored host is running Windows. In this case, leave the default value.

1 to 65,535

22

Legend:

--: No default is set.

#1

When the jpcconf target setup command is executed in the non-interactive mode, this item name is used as a product-specific label in the definition file. For details about commands in the non-interactive mode, see the chapter that describes commands in the manual JP1/Performance Management Reference.

#2

For health check monitoring, you can also specify hosts and hardware equipment that support the ICMP protocol (can communicate through ping command).

#3

To collect performance data and perform health checking, the name must be resolvable at least by the PFM - RM host.

If the JP1/IM linkage facility is used, the name must be resolvable by the JP1/IM host.

#4

Health check monitoring does not collect performance data.

#5

All cannot be used because it is a reserved word for group agents.

#6

If the specification is omitted, the host name of the PFM - RM host is assumed.

#7

If the monitored host is running Windows, the specified user must be a member of the monitored host's Administrators group, Performance Log Users group, or Performance Monitor Users group.

To perform operations such as Windows security audit, you also need permissions to execute such operations.

The type of records that can be collected differs according to the account type. For details about various account types and whether records can be collected, see 3.1.1(5)(a) Setting the user accounts.

If the monitored host is running Windows, note that the following check boxes in the General tab of the Administrator Properties window must not be selected:

- User must change password at next logon

- Account is disabled

In addition, if the monitored host specifies a domain user in an Active Directory environment, click the Account tab for that user, and then click the Log On To button to display the Logon Workstations window. In the Logon Workstations window, make sure that one of either of the conditions listed below exists there:

- The All computers option is selected.

- The following computers option is selected, and the host name of the monitored host is already registered.

If the monitored host resides in a work group environment, execute the gpedit.msc command to display the Local Computer Policy window, and select Computer Configuration, Windows Settings, Security Settings, Local Policies, and then Security Options. Then, make sure that the Network access: Sharing and security model for local accounts option is set to Classic - local users authenticate as themselves.

These notes also apply when User in common account information (wmi) is used.

#8

When the monitored host is running UNIX, use bash, bsh, or ksh for the login shell of the user to be specified.

This also applies when User in common account information (ssh) is used.

#9

This item is required if the monitored host is running Windows.

This also applies when Password in common account information (wmi) is used.

#10

When monitoring the local host, specify a local host name if all of the following conditions are satisfied:

  • The PFM - RM host is a participant in a domain.

  • The user of the PFM - RM host is used for connecting to the monitored host.

This also applies when Domain in common account information (wmi) is used. When using common account information, specify the local host name for Domain in common account information (wmi).

#11

This item is required if the monitored host is running UNIX.

Also, when operating PFM - RM for Platform in a cluster system, specify a file path that can be accessed from both the active server and the standby server.

This also applies when Private_Key_File in common account information (ssh) is used.

(c) Monitored host setting items that are not displayed

Monitored host setting items are usually displayed by executing a command, but some are not displayed depending on the contents of other setting items or for some other reason. The table below describes conditions that prevent monitored host setting items from being displayed. It also shows the input values that are used in such cases.

Table 3‒17: Conditions that prevent monitored host setting items from being displayed, and input values that are used

Item name

Conditions that prevent monitored host setting items from being displayed, and input values that are used

User

  • This item is not displayed when Y is specified for UseCommonAccount.

    Input value:

    The value in the corresponding common account information is used as the input value. For details about the corresponding common account information, see Table 3-13 or Table 3-14.

  • This item is not displayed when icmp is specified for TargetType.

Password

  • These items are not displayed when ssh or icmp is specified for TargetType.

  • These items are not displayed when Y is specified for UseCommonAccount and wmi is specified for TargetType.

    Input value:

    The value in the corresponding common account information is used as the input value. For details about the corresponding common account information, see Table 3-13.

Domain

Private_Key_File

  • This item is not displayed when wmi or icmp is specified for TargetType.

  • This item is not displayed when Y is specified for UseCommonAccount and ssh is specified for TargetType.

    Input value:

    The value in the corresponding common account information is used as the input value. For details about the corresponding common account information, see Table 3-14.

Port

This item is not displayed when wmi or icmp is specified for TargetType.

(d) Execution in the interactive mode

  1. Execute the jpcconf target setup command.

    In PFM - RM for Platform, we recommend that you specify the host name of the monitored host as the name of the monitoring target.

    The following example sets the monitored host targethost1 with instance name inst1 as the monitoring target:

    jpcconf target setup -key RMPlatform -inst inst1 -target targethost1
  2. Set up the monitoring target for PFM - RM for Platform.

    Enter setting items for the monitored host according to the instructions given by the command. For details about the setting items for the monitored host, see Table 3-16. After you input each setting item, press the Enter key to set it. To use a displayed default value, simply press the Enter key.

    The following is an example of the settings when the monitored host is running Windows:

    Conditions for the monitored host to be set up

    - Host name: targethost1

    - User: user1

    - Password: pass1

    - Domain: domain1

    C:\Program Files\Hitachi\jp1pc\tools>jpcconf target setup -key RMPlatform -inst inst1 -target targethost1
     Target Host          []                   :targethost1<Enter>
     UseCommonAccount     [N]                  :<Enter>
     TargetType           [wmi]                :<Enter>
     User#1                                    :user1<Enter>
     Password#1                                :pass1#2<Enter>
     Re-enter#1                                :pass1#2<Enter>
     Domain#1             []                   :domain1<Enter>
    KAVE05361-I The monitoring target is now being added. (servicekey#3=RMPlatform, inst=inst1, target=targethost1)
    KAVE05362-I The monitoring target has been added. (servicekey#3=RMPlatform, inst=inst1, target=targethost1)
    #1

    This item is not displayed when Y is specified for UseCommonAccount.

    #2

    Re-entry of the password is prompted. The entered password is not displayed on the screen.

    #3

    If PFM - Manager's product name display function is disabled, agt7 is displayed for servicekey.

    The following is an example of the settings when the monitored host is running UNIX:

    Conditions for the monitored host to be set up

    - Host name: targethost2

    - User: ssh-user

    C:\Program Files\Hitachi\jp1pc\tools>jpcconf target setup -key RMPlatform -inst inst1 -target targethost2
     Target Host          []                   :targethost2<Enter>
     UseCommonAccount     [N]                  :<Enter>
     TargetType           [wmi]                :ssh<Enter>
     User#1                                    :ssh-user<Enter>
     Private_Key_File     [] :C:\Program Files\PuTTY\agt7.ppk<Enter>
     Port                 [22]                 :<Enter>
    KAVE05361-I The monitoring target is now being added. (servicekey#2=RMPlatform, inst=inst1, target=targethost2)
    KAVE05362-I The monitoring target has been added. (servicekey#2=RMPlatform, inst=inst1, target=targethost2)
    #1

    This item is not displayed when Y is specified for UseCommonAccount.

    #2

    If PFM - Manager's product name display function is disabled, agt7 is displayed for servicekey.

    The following is an example of the settings for health check monitoring:

    Conditions for the monitored host to be set up

    - Host name: targethost3

    C:\Program Files\Hitachi\jp1pc\tools>jpcconf target setup -key RMPlatform -inst inst1 -target targethost3
     Target Host          []                   :targethost3<Enter>
     UseCommonAccount     [N]                  :<Enter>
     TargetType           [wmi]                :icmp<Enter>
    KAVE05361-I The monitoring target is now being added. (servicekey#=RMPlatform, inst=inst1, target=targethost3)
    KAVE05362-I The monitoring target has been added. (servicekey#=RMPlatform, inst=inst1, target=targethost3)
    #

    If PFM - Manager's product name display function is disabled, agt7 is displayed for servicekey.

(e) Execution in the non-interactive mode

  1. Execute the jpcconf target setup command to create a definition file template.

    Execute the command as follows:

    jpcconf target setup -key RMPlatform -noquery -template definition-file-name

    Sections and labels that correspond to the monitored host setting items are output to a definition file. Note that the value for the label of the Target Definitions section is left blank.

  2. Edit the definition file template created in step 1.

    Edit the template setting values as required for the monitored host.

    For details about the product-specific labels to be specified in the definition file, see Table 3-16.

    Shown below is an example of the coding of a definition file when the monitored host is running Windows. Specify values for the labels in the Target Definitions section as required for the monitored host.

    [Common Definitions]
    Definition File Version=0001
     
    [Product Information]
    Product ID=7
     
    [Target Definitions]
    Target Host=targethost1
    UseCommonAccount=
    TargetType=
    User#=user1
    Password#=pass1
    Domain#=domain1
    Private_Key_File=
    Port=
    #

    There is no need to specify a value for this item when Y is specified for UseCommonAccount.

    Shown below is an example of the coding of a definition file when the monitored host is running UNIX. Specify values for the labels in the Target Definitions section as required for the monitored host.

    [Common Definitions]
    Definition File Version=0001
     
    [Product Information]
    Product ID=7
     
    [Target Definitions]
    Target Host=targethost2
    UseCommonAccount=
    TargetType=ssh
    User#=ssh-user
    Password=
    Domain=
    Private_Key_File#= C:\Program Files\PuTTY\agt7.ppk
    Port=
    #

    There is no need to specify a value for this item when Y is specified for UseCommonAccount.

    Shown below is an example of the coding of a definition file for health check monitoring. Specify values for the labels in the Target Definitions section as required for the monitored host.

    [Common Definitions]
    Definition File Version=0001
     
    [Product Information]
    Product ID=7
     
    [Target Definitions]
    Target Host=targethost3
    UseCommonAccount=
    TargetType=icmp
    User=
    Password=
    Domain=
    Private_Key_File=
    Port=
  3. Execute the jpcconf target setup command to set up the monitoring target for PFM - RM for Platform.

    The following example sets up a monitoring target where inst1 is the instance name and targethost1 is the monitored host. For the -input option, specify the definition file edited in step 2.

    jpcconf target setup -key RMPlatform -inst inst1 -target targethost1 -input definition-file-name -noquery
Note:

If the definition file contains confidential information such as passwords, save the definition file in a secure location, and delete it after you have used it. If you want to transfer the definition file between hosts, we recommend that you use a secure file transfer protocol, such as Secure File Transfer Protocol (SFTP), which is FTP over an SSH tunnel.

When all of the settings have been completed, a monitoring target environment can be built. The following table shows the folder structure of the monitoring target environment.

Table 3‒18: Folder structure of the monitoring target environment

No.

Storage folder

File name

Description

1

installation-folder#\agt7\agent\instance-name\targets

monitoring-target-name.ini

Monitoring target settings file

2

monitoring-target-name.ini.model

Sample of a monitoring target settings file

3

installation-folder#\agt7\agent\instance-name\targets\monitoring-target-name

--

Work folder for the monitoring target

Legend:

--: Not applicable

#

If you run a logical host, replace installation-folder with environment-folder\jp1pc.

The following service IDs are added by the monitoring target settings:

Service IDs to be added
  • Remote Agent service

    7Ainstance-number instance-name[monitoring-target-name@host-name]

    The instance name and monitoring target name will be the values specified in the jpcconf target setup command.

    If you specify host1 as the host name of the PFM - RM host, inst1 as the instance name, and targethost1 as the monitoring target name, the service ID will be as follows:

    7A1inst1[targethost1@host1]

For details about the service IDs, see the naming rules provided in the appendix in the JP1/Performance Management Planning and Configuration Guide.

If you want to change information about the monitoring target, re-execute the jpcconf target setup command and update the information. For details about updating a monitoring target, see 3.6.3 Updating a monitoring target.

You can change some settings by using PFM - Web Console to edit properties. For details about the information that can be changed by editing properties, see F.3 List of properties of remote agents and group agents.

(4) Network settings[Figure]

You must specify network settings only if you need to change the network environment settings for the network configuration where Performance Management is used.

There are two types of network environment settings, as described below. Change network settings as necessary.

(5) Changing the log file size[Figure]

The operation status of Performance Management is output to Performance Management's own log file. This log file is called the common message log. Modify this setting if you want to change the file size.

For details, see the chapter explaining installation and setup in the JP1/Performance Management Planning and Configuration Guide.

(6) Changing performance data storage locations[Figure]

These settings are required in order to change the following settings for the performance data that is managed by PFM - RM for Platform:

Note:

If you use a logical host for operation, replace installation-folder with environment-folder\jp1pc.

For details about changing performance data storage locations, see 3.6.1 Changing performance data storage locations.

(7) Setting the connection-target PFM - Manager

You must specify on the PFM - RM host information about the PFM - Manager that manages PFM - RM for Platform. The jpcconf mgrhost define command is used to make this setting.

Notes about setting the connection-target PFM - Manager
  • Only one PFM - Manager can be set as the connection destination even when multiple PFM - RMs are installed on the same host. A different PFM - Manager cannot be specified for each PFM - RM.

  • If PFM - RM for Platform and PFM - Manager are installed on the same host, then the PFM - Manager on the local host is the connection-target PFM - Manager. In this case, you cannot change the connection-target PFM - Manager to any other PFM - Manager. To connect to PFM - Manager on a remote host, install PFM - RM for Platform on a different host than for PFM - Manager.

To set the connection-target PFM - Manager:

  1. Stop the Performance Management programs and services.

    If any Performance Management programs and services are running on the local host, stop all of them before starting the setup procedure. If Performance Management programs and services are running during execution of the jpcconf mgrhost define command, a message is displayed that asks you to terminate them.

    For details about how to stop services, see the chapter that describes starting and stopping Performance Management in the JP1/Performance Management User's Guide.

  2. Execute the jpcconf mgrhost define command with the host name of the connection-target PFM - Manager specified.

    The following shows an example of command execution when the connection-target PFM - Manager is located on the host01 host:

    jpcconf mgrhost define -host host01

    This example shows execution in the interactive mode, but you can also execute the jpcconf mgrhost define command in the non-interactive mode. For details about this command, see the chapter that describes commands in the manual JP1/Performance Management Reference.

(8) Action log output settings[Figure]

These settings are required in order to output action logs at the following times:

An action log contains log information about exceeded threshold values caused by factors such as system overloads; its output is linked with the alarm function. For details about the action log output settings, see J. Outputting Action Log Data.