Job Management Partner 1/Performance Management - Agent Option for Virtual Machine Description, User's Guide and Reference

[Contents][Glossary][Index][Back][Next]

2.1.4 Setting up PFM - Agent for Virtual Machine

This subsection explains the setup for operating PFM - Agent for Virtual Machine. The setup procedure depends on the virtual environment to be monitored. The table below lists the setup items required for each virtual environment.

Table 2-3 Setup items required for each virtual environment

Setup item VMware Hyper-V
(1) Registering PFM - Agent Y Y
(2) Setting up an instance environment Y Y
(3) Embedding a certificate Y N
(4) Network settings Y Y
(5) Changing the log file size Y Y
(6) Changing the performance data storage destination Y Y
(7) Setting up PFM - Manager at the connection destination of PFM - Agent for Virtual Machine Y Y
(8) Setting the action log output Y Y
(9) Setting WMI N Y

Legend:
Y: Setup is required
N: Setup is not required

The icon [Figure] or [Figure] indicates a setup item required for the indicated virtual environment.

The icon [Figure] indicates either a setup item that may be required depending on the environment that is used, or an optional setup item that is available for changing default settings.

Organization of this subsection
(1) Registering PFM - Agent
(2) Setting up an instance environment
(3) Embedding a certificate
(4) Network settings
(5) Changing the log file size
(6) Changing the performance data storage destination
(7) Setting up PFM - Manager at the connection destination of PFM - Agent for Virtual Machine
(8) Setting the action log output
(9) Set up WMI

(1) Registering PFM - Agent [Figure] [Figure] [Figure]

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

The figure below shows the flow for registering PFM - Agent.

Figure 2-4 PFM - Agent registration flow

[Figure]

Note
  • Register PFM - Agent before setting up the instance environment.
  • If you add the same version of PFM - Agent for Virtual Machine to a Performance Management system in which PFM - Agent for Virtual Machine information is already registered, there is no need to register PFM - Agent.
  • To install different versions of PFM - Agent for Virtual Machine on different hosts, set up the earlier version first, and then set up the later version.
  • If you install PFM - Agent 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 Job Management Partner 1/Performance Management Reference.
  • During the task of registering the PFM - Agent for Virtual Machine information, a folder named VirtualMachine is created under the Reports and Alarms tabs in PFM - Web Console. If you had already created a folder or file named VirtualMachine under the Reports tab on your own, change its name before you proceed with registration.

(a) Copying the PFM - Agent for Virtual Machine setup files

Copy the setup files located on the host on which you installed PFM - Agent for Virtual Machine to the host on which you installed PFM - Manager and PFM - Web Console.

To copy the setup files:

  1. If PFM - Web Console is running, stop it.

  2. Copy the setup files of PFM - Agent in the binary mode.
    The table below shows the location where the files are stored and the location to which the files are to be copied.

    Table 2-4 Setup files to copy

    PFM - Agent setup file Copying destination
    PFM program name OS Destination folder
    installation-folder\setup\jpcagt5w.EXE PFM - Manager Windows PFM-Manager-installation-folder\setup\
    installation-folder\setup\jpcagt5u.Z UNIX /opt/jp1pc/setup/
    installation-folder\setup\jpcagt5w.EXE PFM - Web Console Windows PFM-Web-Console-installation-folder\setup\
    installation-folder\setup\jpcagt5u.Z UNIX /opt/jp1pcwebcon/setup/

(b) Using the PFM - Manager host to execute the setup command

Use PFM - Manager to execute the following command for setting up PFM - Agent for Virtual Machine:

jpcconf agent setup -key VM (jpcagtsetup agt5)
Note
If you execute the jpcconf agent setup command when the Performance Management programs and services of the local host on which you are executing the setup command have not stopped completely, an error may occur. In this case, first make sure that the Performance Management programs and services have stopped completely, and then re-execute the jpcconf agent setup command.

After this task has been completed, you can delete the PFM - Agent setup file located on the PFM - Manager host.

(c) Using the PFM - Web Console host to execute the setup command

Use PFM - Web Console to execute the following command for setting up PFM - Agent for Virtual Machine:

jpcwagtsetup

After this task has been completed, you can delete the PFM - Agent setup file located on the PFM - Web Console host.

(2) Setting up an instance environment [Figure] [Figure]

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 - Agent for Virtual Machine. You specify this information from the PFM - Agent host.

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

Table 2-5 Instance information of PFM - Agent for Virtual Machine

Item Explanation Value that can be set Default value
VM_Type#1 Specifies the type of virtual environment to be monitored. Character string not exceeding 8 bytes.
Specify the following value, depending on the monitoring target:
  • For VMware: vmware
  • For Hyper-V: hyperv
 vmware
VM_Host Specifies the host name of the virtual environment to be monitored. Character string not exceeding 256 bytes. Note that the following character cannot be used:
  • Tab character
 instance-name#2
Security Specifies whether to use SSL for communicating with the virtual environment to be monitored. {0|1}
0: SSL is not used.
1: SSL is used.
Because Hyper-V does not support SSL, 0 is always set, even if 1 is specified.		 1
Port Specifies the port number to use for communicating with the virtual environment to be monitored. 0-65535
If 0 is specified, the following value is used according to the Security setting:

Security=0 (SSL is not used.)
HTTP's default port number 80

Security=1 (SSL is used.)
HTTPS's default port number 443
 0
UserID#3 Specifies the user ID for connecting to the virtual environment to be monitored. Character string not exceeding 256 bytes. Note that the following character cannot be used:
  • Tab character
 (None)
Password Specifies the password for connecting to the virtual environment to be monitored. The characters entered for this item are not displayed on the screen. When you enter a value for this item, the system will ask you to re-enter the value. Character string not exceeding 256 bytes. Note that the following character cannot be used:
  • Tab character
 (No password)
Domain Specifies the domain name to be used for connecting the virtual environment to be monitored. Character string not exceeding 256 bytes. Note that the following character cannot be used:
  • Tab character
If the PFM - Agent host does not belong to a domain (such as when it runs in a workgroup), leave this item blank.		 (None)
HostUserID Specifies the user ID of the PFM - Agent host. Character string not exceeding 256 bytes. Note that the following character cannot be used:
  • Tab character
 (None)
HostPassword Specifies the password for the user ID that was specified in HostUserID. The characters entered for this item are not displayed on the screen. When you enter a value for this item, the system will ask you to re-enter the value. Character string not exceeding 256 bytes. Note that the following character cannot be used:
  • Tab character
 (No password)
HostDomain Specifies the domain name of the PFM - Agent host. Character string not exceeding 256 bytes. Note that the following character cannot be used:
  • Tab character
If the PFM - Agent host does not belong to a domain (such as when it runs in a workgroup), leave this item blank.		 (None)
Log_Size Specifies the maximum size of a single file for the collected logs.#4 1-32 (megabytes)
A value of 16 or greater is recommended.		 16
Store Version#1 Specifies the Store version to use.#5 {1.0|2.0} 2.0

#1
Cannot be reset using the jpcconf inst setup command.

#2
This is the instance name specified for executing the jpcconf inst setup command.

#3
When the virtual environment to be monitored is VMware, the account to be specified must have at least read-only permissions for VMware roles. For details about how to specify permissions, see the VMware documentation.

#4
Logs are collected into a maximum of eight files per instance. 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.

#5
For details about Store versions, see the chapter that explains installation and setup in the Job Management Partner 1/Performance Management Planning and Configuration Guide.
Note
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.5(3) No performance data is collected even when PFM - Agent 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.

Table 2-6 Instance information items to be specified for each virtual environment

Item Virtual environment
VMware Hyper-V
VM_Type N Y
VM_Host D D
Security D N
Port D N
UserID Y Y
Password Y Y
Domain N Y
HostUserID Y Y
HostPassword Y Y
HostDomain Y Y
Log_Size D D
Store Version D D

Legend:
Y: Specification is required.
D: Specify only to change the default value.
N: Specification is not necessary.

To create an instance environment, use the jpcconf inst setup command. The procedure for configuring an instance environment is described below. For an instance environment setting example, see 2.6 Instance environment setting example.

To configure an instance environment:

  1. Execute the jpcconf inst setup command.
    You can specify any instance name; however, it is recommended for PFM - Agent for Virtual Machine that you specify the physical server name of the target virtual environment (for VMware, name of the VMware host). For example, to create an instance environment in which the physical server name is vm-host, specify the following and execute the command:
     
jpcconf inst setup -key VM -inst vm-host
    For details about the jpcconf inst setup command, see the chapter that explains commands in the manual Job Management Partner 1/Performance Management Reference.

  2. Set up the instance information of PFM - Agent for Virtual Machine.
    Enter the items listed in Table 2-6 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 Agent Collector service property list.

The instance environment that is created is described below.

(3) Embedding a certificate [Figure] [Figure]

Before you use SSL to communicate with VMware, you must embed a certificate. For details, see 2.5.1 For VMware.

Note
If no certificate has been embedded when you use SSL to communicate with VMware, the following problems may occur:
  • During performance data collection, it may take quite a while to receive a response from the VMware at the connection destination.
  • Because of the delay in receiving a response from the VMware at the connection destination, performance data collection might not be completed within the prescribed collection interval, resulting in a collection failure.
  • An error occurs when you perform an operation from PFM - Web Console that generates a query to the Agent Collector service of PFM - Agent for Virtual Machine, such as display of service properties.
  • The error KAVL16205-W occurs many times.

(4) Network settings [Figure] [Figure] [Figure]

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:

(5) Changing the log file size [Figure] [Figure] [Figure]

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. By default, the common message log uses two files, each with 2,048 kilobytes. 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 Job Management Partner 1/Performance Management Planning and Configuration Guide.

(6) Changing the performance data storage destination [Figure] [Figure] [Figure]

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 - Agent for Virtual Machine.

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

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

(7) Setting up PFM - Manager at the connection destination of PFM - Agent for Virtual Machine [Figure] [Figure]

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

Note
  • Even when multiple PFM - Agents 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 - Agent.
  • When PFM - Agent 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 Job Management Partner 1/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

(8) Setting the action log output [Figure] [Figure] [Figure]

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.

(9) Set up WMI [Figure]

For details about the WMI settings, see 2.5.2 For Hyper-V.

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2009, 2010, Hitachi, Ltd.