2.1.4 Setting up PFM - RM for Virtual Machine

(1) Registering PFM - RM for Virtual Machine

To use PFM - Manager and PFM - Web Console to centrally manage PFM - RM for Virtual Machine, you need to register PFM - RM for Virtual Machine in PFM - Manager and PFM - Web Console.

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

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

Manually registering PFM - RM for Virtual Machine in PFM - Manager

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

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

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

Manually registering PFM - RM for Virtual Machine in PFM - Web Console

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

• The PFM - RM for Virtual Machine 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 Virtual Machine state that it is necessary to execute the setup command, execute the setup command.

The figure below shows the flow for registering PFM - RM for Virtual Machine.

Important

• Register PFM - RM for Virtual Machine before setting up the instance environment.

• If you add the same version of PFM - RM for Virtual Machine to a Performance Management system in which PFM - RM for Virtual Machine information is already registered, there is no need to register PFM - RM for Virtual Machine.

• To install different versions of PFM - RM for Virtual Machine on different hosts, set up the earlier version first, and then set up the later version.

• If you install PFM - RM for Virtual Machine on the same host as PFM - Manager, the jpcconf agent setup command is automatically executed. When the message KAVE05908-I New agent setup ended successfully is output to the common message log, check the result. If the command was not executed correctly, execute it again. For details about how to execute the command, see the chapter that explains commands in the manual JP1/Performance Management Reference.

• During the task of registering the PFM - RM for Virtual Machine information, a folder named RM VirtualMachine is created under the Reports and Alarms tabs in PFM - Web Console. If you had already created a folder or file named RM VirtualMachine under the Reports tab on your own, change its name before you proceed with registration.

jpcconf agent setup -key RMVM (jpcagtsetup agt8)

jpcwagtsetup

To Page Top

(2) Setting PFM - RM for Virtual Machine

If you want to change the following operations of PFM - RM for Virtual Machine, you need to set it up:

• The collection process starts collecting data based on a reference point that is the time 0 seconds after the service starts. (UseOffset)

• PFM - RM for Virtual Machine monitors VMware with Hyper-Threading enabled based on the physical processor cores rather than the logical processor cores. (UseHTPhysicalClocks)

The following explains how to perform the setting up PFM - RM for Virtual Machine.

Installation-folder\agt8\agent\jpcagt8cfg.ini

[common]
UseOffset={N | Y}
[vmware]
UseHTPhysicalClocks={N | Y}

To Page Top

(3) Setting up an instance environment

To set up an instance environment, you specify instance information. To set up multiple instance environments, you repeat the setup procedure.

Specify the instance information of PFM - RM for Virtual Machine. You specify this information from the PFM - RM host.

The table below shows the types of instance information to specify. Before you begin the setup procedure, check the following information.

#1

To execute the jpcconf target setup command in non-interactive mode, use this item name as the product-specific label in the definition file. For details about executing the command in non-interactive mode, see the chapter on commands in the manual JP1/Management Reference.

#2

Cannot be reset using the jpcconf inst setup command.

#3

Depending on the intervals at which Remote Monitor Collector collects information and at which a temporary performance information file is created, the contents of the file might not be updated, causing the same data to be collected. If this problem occurs, review and correct the settings of these intervals. For details about setting these intervals, see 1.3.1 General procedure for performance data collection tasks.

#4

If you set the UseOffset value to enable (Y) in 2.1.4 (2) Setting PFM - RM for Virtual Machine, set the Offset value to a smaller value than the Interval value.

If you set the UseOffset value to disable (N), the Offset value is ignored.

#5

In order to acquire performance data from a temporary performance information file during record collection, collection of the records collected when the Std_Category, Cpu_Category, Memory_Category, Disk_Category, and Network_Category items are enabled takes precedence over other records.

If records collected when any of these items are enabled are unnecessary, disable the relevant items by setting N. Doing so reduces the number of times the monitoring target is accessed. Remember that if you set N for any of the above items, you can no longer collect performance data for the relevant records.

For example, if you set Std_Category to N (disable collection), behavior for PI records is as follows:

• PI records are not saved in the Store database.

• A KAVJS5002-I error message is displayed when an attempt is made to display a real-time report on PI records from PFM - Web Console.

• If an alarm that uses a PI record is bound, the alarm does not function.

For the general procedure for performance data collection tasks, see 1.3.1 General procedure for performance data collection tasks.

#6

If PFM - RM for Virtual Machine is used in a cluster system, set the same user name and password on both the executing and standby nodes so that the PFM - RM host account can access both nodes.

#7

PFM - RM for Virtual Machine uses the user account specified by HostUserID to start the collection process. If the profile for the user account does not exist, acquisition of performance data might fail.

The profile information for a user account is created at the first logon with the user account.

When you add or change a PFM - RM for Virtual Machine instance environment, you might want to create a new user account and specify it for HostUserID. In such a case, the profile for the user account might have not been created yet. To avoid this, immediately after creating a new user account, log on to Windows with that user account.

#8

If PFM - RM for Virtual Machine is operated in a cluster system, specify it with the file path accessible from both the executing and standby nodes.

#9

For collected log data, a maximum of eight files are created per monitoring target. If the hard disk does not have sufficient free space, a collected log output error will occur. For details about the collected log, see 7.3 Log information.

#10

The VM Status (PI_VI) record is the only record that is collected if this item is enabled. For details about the fields of this record, see VM Status (PI_VI) in 5. Records.

To check the CPU resource usage of the physical host itself that runs the virtual machine by using the clock frequency of the physical CPU as the CPU resource clock frequency, specify N. You can specify N if, for example, you want to move or stop a virtual machine without exhausting CPU resources.

To check the CPU resource usage of a virtual machine by using the clock frequency assigned to the virtual machine as the CPU resource clock frequency, specify Y. You can specify Y when there are sufficient CPU resources on the physical host that runs the virtual machine.

Important

Even if the setting for the connection environment specified in the instance environment is invalid, the instance environment generation command terminates normally. However, when you begin collecting records in that instance environment, no performance data is collected. For the corrective action to take in such a case, see 7.2.1(1) No performance data is collected even when PFM - RM for Virtual Machine is started.

The items that need to be specified during instance environment setup depend on the virtual environment to be monitored. The table below shows the items that need to be specified for each virtual environment.

To create an instance environment, use the jpcconf inst setup command. The procedure for configuring an instance environment is described below.

This example shows execution in the interactive mode, but you can also execute the jpcconf inst 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.

For an instance environment setting example, see 2.6 Examples of setting up an instance environment and monitoring targets.

To configure an instance environment:

1. Execute the jpcconf inst setup command.

   You can specify any instance name. Make sure that you specify an easy-to-identify PFM - RM for the Virtual Machine instance name for convenience of management. The following shows an example of the command that builds an instance named inst1:

   jpcconf inst setup -key RMVM -inst inst1
    (jpcinssetup agt8 -inst inst1)

   Note that the instance name you specify must consist of only single-byte alphanumeric characters. For details, see the manual JP1/Performance Management Reference.

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

2. Set up the instance information of PFM - RM for Virtual Machine.

   Enter the items listed in Table 2-5 as instructed by the command. All items are required. If you choose to use the default value that is displayed for an item to input, simply press the Enter key.

Once all of the information has been input, an instance environment is created. To change the instance information that was input during configuration, execute the jpcconf inst setup command again to update the instance environment. For details about how to update an instance environment, see 2.4.2 Updating an instance environment. You can change some of the information that was specified by editing the properties from PFM - Web Console. For details about the information that can be specified, see E.2 Remote Monitor Collector service property list.

The instance environment that is created is described below.

• Folder structure of the instance environment

  The instance environment is created under the following folder:

  For a physical host: installation-folder\agt8

  For a logical host: environment-folder^#\jp1pc\agt8

  #

  The environment folder is the folder on a shared disk that was specified during creation of the logical host.

  The table below shows the folder configuration of the instance environment that is created.

  Table 2‒6: Folder configuration of the instance environment

  Folder name, file name			Explanation
  Remote Monitor	instance-name	groups	Storage folder for group agents
  		log	Storage folder for log files
  		targets	Storage folder for remote agents
  		GARULES.DAT	Grouping rule file
  		grouplist.ini	Group list file
  		inssetup.bat	Expansion of the jpcconf inst setup command for PFM - RM for Virtual Machine
  		jpcagt.ini	Remote Monitor Collector service startup initialization file
  		jpcagt.ini.lck	Lock file for a remote monitor collector service startup initialization file (this file is created for each instance)
  		jpcagt.ini.model#	Model file for the Remote Monitor Collector service startup initialization file
  		plugin.ini	Virtual environment connection definition file
  		status.dat	Intermediate file for internal processing
  		targetlist.ini	Monitoring-target list file
  		tstatuses.dat	Virtual-agent status information file
  store	instance-name	backup	Backup folder
  		dump	Export folder
  		import	Import folder
  		log	Storage folder for log files
  		partial	Partial backup folder
  		*.DAT	Data model definition file
  		*.DB	Performance data file
  		*.IDX	Index file for a performance data file
  		*.LCK	Lock file for a performance data file
  		jpcsto.ini	Remote Monitor Store service startup initialization file
  		jpcsto.ini.model#	Model file for the Remote Monitor Store service startup initialization file
  		status.dat	Intermediate file for internal processing

  #

  Use this file when you need to restore the instance environment to the settings that were in effect when it was created.

• Service ID of the instance environment

  The service ID of the instance environment is as follows.

  When the product name display function is enabled

  instance-name[host-name]<RM VirtualMachine>

  When the product name display function is disabled

  8 function-ID instance-number instance-name [host-name]

  For PFM - RM for Virtual Machine, the instance name specified by the jpcconf inst setup command is displayed for the instance name. For details about service IDs, see the naming rules described in the appendix section of the JP1/Performance Management Planning and Configuration Guide. For details about the product name display function, see the chapter that explains the functions of Performance Management in the JP1/Performance Management Planning and Configuration Guide.

• Windows service name of the instance environment

  The Windows service name of the instance environment is as follows.

  • Remote Monitor Collector service: PFM - RM for Virtual Machine-instance-name[logical-host-name]

  • Remote Monitor Store service: PFM - RM Store for Virtual Machine-instance-name[logical-host-name]

  For details about the Windows service name, see the naming rules described in the appendix section of the JP1/Performance Management Planning and Configuration Guide.

  For details about the Windows service name when Performance Management is operated on a logical host, see the chapter that explains configuration and operations in a cluster system in the JP1/Performance Management User's Guide.

To Page Top

(4) Setting up monitoring targets

Set information about the monitoring-target virtual environments for the instance set up in (3) Setting up an instance environment above. You can set a maximum of 50 monitoring-target virtual environments. To set multiple monitoring-target virtual environments for one instance, repeat the procedure described in (3). Note, however, that if there are many monitoring-target virtual environments, performance might be reduced, depending on the performance and environment of the machine. If this is the case, reduce the number of monitoring-target virtual environments. We recommend that you perform sufficient testing before you start working in the production environment.

Note on setting up a monitoring-target host:

• The command that generates a monitoring target terminates normally even if incorrect values are specified during setup of the monitoring-target host. However, record collection will not collect performance data if the settings are incorrect. For corrective measures you can take in such a case, see 7.2.1(1) No performance data is collected even when PFM - RM for Virtual Machine is started.

Setup of a monitoring target is performed on the PFM - RM for Virtual Machine host.

The table below lists and describes the items that can be specified during setup of a monitoring target. Check the settings of these items before starting operation.

#1

If the jpcconf target setup command is executed in non-interactive mode, use this item name as the product-specific label in the definition file. For details about executing the command in non-interactive mode, see the chapter on commands in the manual JP1/Performance Management Reference.

#2

The first thing you must do before you can perform collection of performance information and do health checks is to ensure that the PFM - RM host name can resolve to an IP address. To use the JP1/IM linkage facility, the JP1/IM host name must be resolvable to an IP address.

#3

The string All, which is a reserved word for group agents, cannot be used.

#4

If the monitoring-target virtual environment uses VMware, the account you specify must have a Read-only or a higher VMware role. For details about how to specify the role settings, see the VMware documentation.

If the monitoring-target virtual environment uses Hyper-V, for the permission of the account you specify, see 2.5.2(1)(a) Environment settings required for connection.

If the monitoring-target virtual environment uses KVM, always log in as superuser.

If the monitoring-target virtual environment uses Podman environment, always log in as superuser. The container (rootless container) of a general user cannot be monitored.

#5

If the monitoring-target virtual environment uses KVM, use bash, bsh, or ksh as the login shell for the user you specify.

If the monitoring-target virtual environment uses Podman environment, use bash as the login shell for the user you specify.

#6

If the monitoring-target virtual environment uses VMware and any of the symbols listed in the following table are used in the password on the VMware side, replace them with symbol entities when specifying a value for Password.

Symbol	Characters entered
<	&lt;
>	&gt;
&	&amp;
'	&apos;
"	&quot;

For example, if the string you want to specify for Password is abc<def>xyz, enter abc&lt;def&gt;xyz.

#7

The private key file is accessed every time record collection is performed. Make sure that the private key file at the path you specify can be accessed during record collection.

#8

If there is a problem with the client certificate, the connection is rejected on the Docker environment side. Thus, performance data cannot be collected.

The items that must be specified during setup of a monitoring target differ depending on the monitoring-target virtual environment. The following table shows the required setting items for each virtual environment.

A monitoring target is set up by using the jpcconf target setup command. To set up a monitoring target:

1. Execute the jpcconf target setup command.

   For PFM - RM for Virtual Machine, we recommend that you specify the host name of the physical server as the monitoring target name.

   The following shows an example of executing a command when setting the host named targethost1 as the monitoring target of the instance named inst1.

   jpcconf target setup -key RMVM -inst inst1 -target targethost1

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

2. Set up the PFM - RM for Virtual Machine monitoring target.

   Specify settings of the monitoring target as the command instructs. For details about these settings, see Table 2-8. After specifying a value for a setting item, press the return key to set the value. If you accept the initial value as is, only press the return key.

The following shows an example of specifying settings when the monitoring target is a VMware environment.

Conditions of the monitoring target that you want to set up:

• Host name of the physical server: targethost1

• User: user1

• Password: pass1

• Domain: domain1

C:\Program Files\Hitachi\jp1pc\tools>jpcconf target setup -key RMVM -inst inst1 -target targethost1
Target Host [] : targethost1 <Enter>
VM_Host [] : <Enter>
Security [1] : <Enter>
Port [0] :<Enter>
UserID:user1 <Enter>
Password :pass1#1<Enter>
Re-enter :pass1#1<Enter>
Domain [] :<Enter>
Private_Key_File [] :<Enter>
KAVE05361-I The monitoring target is now being added. (servicekey#2=RMVM,inst=inst1, target=targethost1)
KAVE05362-I The monitoring target has been added. (servicekey#2=RMVM,inst=inst1, target=targethost1)

#1

You are prompted to enter a password twice. The string entered as the password is not displayed.

#2

If the product name display function of PFM - Manager is disabled, agt8 is displayed for servicekey.

After you have specified all settings, the monitoring-target environment is set up. The following table shows the folders created in the environment.

#

If you use PFM - RM for Virtual Machine on a logical host, replace PFM-RM-for-Virtual-Machine-installation-folder with the environment-folder\jp1pc.

Note that a service ID is added during setup of the monitoring target.

Added service ID:

• Remote Agent service

  8Aab[monitoring-target-name@host-name] (a: instance-number, b: instance-name)

  For b (instance-name) and monitoring-target-name, specify the corresponding values that are specified in the jpcconf target setup command.

  For example, if the PFM - RM host name is host1, the instance name is inst1, and the monitoring target name is targethost1, the service ID is as follows:

  8A1inst1[targethost1@host1]

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

To change the information about a monitoring target, re-execute the jpcconf target setup command. For details about updating a monitoring target, see 2.4.3 Updating monitoring targets.

Some of the items that are set can be changed by editing the properties of PFM - Web Console. For details about the items that can be changed by editing these properties, see E.3 Remote agent and group agent property list.

To Page Top

(5) Settings for each monitoring target

To Page Top

(6) Network settings

This is necessary only when you want to change the settings according to the network configuration in which Performance Management is used.

In the network settings, you can specify the following two items:

• IP address

  Set an IP address when you use Performance Management in a network that is connected to multiple LANs. To set multiple IP addresses, define host names and IP addresses in the jpchosts file. Use the same jpchosts file throughout the entire Performance Management system.

  For details about how to set IP addresses, see the chapter that explains installation and setup in the JP1/Performance Management Planning and Configuration Guide.

• Port number

  You can set the port number to be used by Performance Management. To avoid confusion during operations, use the same port number and service name throughout the entire Performance Management system.

  For details about how to set port numbers, see the chapter that explains installation and setup in the JP1/Performance Management Planning and Configuration Guide.

To Page Top

(7) Changing the log file size

The operation status of Performance Management is output to a log file specific to Performance Management. This log file is called the common message log. This setting is necessary only when you want to change the size of this file.

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

To Page Top

(8) Changing the performance data storage destination

This setting is necessary only when you want to change the folder at the save destination, the backup destination, or the export destination for the database that stores the performance data managed by PFM - RM for Virtual Machine.

By default, performance data is saved in the following locations:

• Save destination: installation-folder\agt8\store\instance-name\

• Backup destination: installation-folder\agt8\store\instance-name\backup\

• Partial backup destination: installation-folder\agt8\store\instance-name\partial\

• Export destination: installation-folder\agt8\store\instance-name\dump\

• Import destination: installation-folder\agt8\store\instance-name\import\

  Important

  For the default save destinations when Performance Management is operated on a logical host, replace installation-folder with environment-folder\jp1pc.

For details, see 2.4.1 Changing the performance data storage destination.

To Page Top

(9) Setting up PFM - Manager at the connection destination of PFM - RM for Virtual Machine

On the host on which PFM - RM for Virtual Machine is installed, set up the PFM - Manager that manages the PFM - RM for Virtual Machine. To set up PFM - Manager at the connection destination, use the jpcconf mgrhost define command.

Important

• Even when multiple PFM - RMs are installed on the same host, you can specify only one PFM - Manager at the connection destination. You cannot set up a different PFM - Manager for each PFM - RM.

• When PFM - RM for Virtual Machine and PFM - Manager are installed on the same host, the PFM - Manager of the local host becomes the PFM - Manager at the connection destination. In this case, you cannot change the PFM - Manager at the connection destination to another PFM - Manager.

To set up PFM - Manager at the connection destination:

1. Stop Performance Management programs and services.

   Before you perform a setup operation, if Performance Management programs and services have been activated on the local host, stop all of them. For details about how to stop services, see the chapter that explains startup and termination of Performance Management in the JP1/Performance Management User's Guide.

   If the Performance Management programs and services are active during the execution of the jpcconf mgrhost define command, a message asking the user whether to stop these programs and services is displayed.

2. Specify the host name of the PFM - Manager host at the connection destination, and then execute the jpcconf mgrhost define command.

   For example, if the PFM - Manager at the connection destination is on the host host01, specify the following:

   jpcconf mgrhost define -host host01
    (jpcnshostname -s host01)

To Page Top

(10) Setting the action log output

This setting is necessary if you want to output an action log when you start or stop a PFM service, or when you change the connection status with PFM - Manager. An action log contains history information that is output in conjunction with the alarm function that monitors items such as the system load threshold.

For details about the setting procedure, see I. Outputting Action Log Data.

To Page Top