2.5.1 For VMware

(a) Add the Web site to the Restricted Sites or Trusted Sites zones

Using by the user specified as a HostUserID in the "Internet Options" dialog box for instance setting, select the "Security" tab, specify a host for monitoring target to "Add this website to the zone:" in "Local Intranet" or "Trusted sites" as followings:

If you have more than one monitoring target, add each of them to the zone for the Web site.

https://( monitoring-target-hosts-name ^#)

#

When VM_Host is not specified by setting for the monitoring target, specify the name of Target Host. When VM_Host is specified, specify the name of VM_Host.

(b) Turn off Internet Explorer Enhanced Security Configuration

For the group (Administrators or Users groups) includes the user specified as a HostUserID in the Internet Options dialog box for instance setting, turn off on "Internet Explorer Enhanced Security Configuration" dialog box.

In this case, be careful that the settings are applied for the other users in the same group.

If a user other than the user specified as a HostUserID turns off this configuration, the user with HostUserID needs to log on to the PFM - RM host to apply the configuration change.

(a) Open the login page of VMware ESX to be monitored

In the address bar of Internet Explorer, enter https://name-of-the-monitored-host to open the login page of VMware ESX.

If you see the This site is not secure message, select Go on to the webpage (not recommended) under More information.

(b) Show the certificate

In the address bar of Internet Explorer, click Certificate Error or the key icon, and in the pop-up window that appears, select View Certificate.

(c) Check the certificate

In the General tab of the Certificate dialog box, check the Issued by field. The following types of certificates are available:

• Default certificate

  If the issuer is VMware Installer, the certificate will be a default certificate.

• vCenter Server certificate

  If the issuer is CA and the Issuer field in the Details tab of the Certificate dialog box is VMware Engineering, the certificate will be a vCenter Server certificate.

• Your own certificate

  The certificates issued by any issuer other than the above will be your own certificate.

If VMware ESX to be monitored uses the default certificate, you do not have to install the CA certificate in the PFM - RM for Virtual Machine host. However, when monitoring using the default certificate, see (3) When using the default certificate.

If a vCenter Server certificate or an own certificate is used for the monitored VMware ESX, a CA certificate must be installed in the PFM-RM for Virtual Machine host.

If you are using a vCenter Server certificate on the monitored VMware ESX or using your own certificate, see (4) When obtaining and operating a CA certificate.

Furthermore, check the certificate of VMware ESX to see if:

• The validity period for the certificate of VMware ESX is valid.

• The name specified in the Issued to field of the VMware ESX certificate can be resolved by the PFM - RM for Virtual Machine host.

• The name specified in the Issued to field of the certificate is the same as that of the host to be specified as the target monitored by PFM - RM for Virtual Machine.

  If these host names are inconsistent, the certificate is handled as an invalid one.

  You need to configure the monitored host differently according to the Issued to field of the VMware ESX certificate. Based on your environment, configure it as follows:

  • If the Issued to field of the VMware ESX certificate contains a domain name

    Specify the name entered in the Issued to field of the VMware ESX certificate for the VM_Host parameter of the settings for the monitored host.

  • If the Issued to field of the VMware ESX certificate contains a host name, but not a domain name

    Specify the name entered in the Issued to field of the VMware ESX certificate for the Target Host parameter of the settings for the monitored host.

    Specify no value or specify the same value as that of the Target Host parameter for the VM_Host parameter of the settings for the monitored host.

If you monitor the target without installing the CA certificate in the PFM - RM for Virtual Machine host when VMware ESX to be monitored uses the vCenter Server certificate or your own certificate, see (3) When using the default certificate, just like the case where the default certificate is used.

(a) Obtain the CA certificate

• When the vCenter Server certificate is used

  If you used the vCenter Server for VMware ESX management, obtain CA certificate from vCenter Server. The vCenter Server's CA certificate is available from "Download trusted root CA certificates" on the page where "Getting Started" of vCenter Server is displayed.

  For details about, the following knowledge base. For questions about knowledge base, contact VMware.

  KB 2108294 : How to download and install vCenter Server root certificates to avoid Web Browser certificate warnings

• When your own certificate is used

  Obtain the CA certificate from the administrator of the certificate.

Check whether the obtained CA certificate is the validity period.

In addition, if the validity period of the certificate is expired, you need to obtain a new CA certificate and import it.

(b) Importing the default certificate for VMware

After you have prepared a CA certificate for VMware as described in (1) above, import the certificate onto the PFM-VM host. To import the certificate:

1. In Windows, choose Start and then Run.

   The Run dialog box opens.

   

2. In the Run dialog box, enter mmc and click OK.

   Management Console starts.

   

3. In Console1, choose File and then Add/Remove Snap-in.

   The Add/Remove Snap-in dialog box opens.

   

4. Choose Certificates and then click Add.

   The Certificates snap-in dialog box opens.

   

5. Choose Computer account and then click Next.

   The Select Computer dialog box opens.

   

6. Choose Local computer and click Finish.

   

7. Check that Certificates (Local Computer) is added to Selected snap-ins and click OK.

8. Expand Certificates (Local Computer) and right-click Certificates under Trusted Root Certification Authorities. Then click All Tasks and Import from the displayed menu items.

   

9. In the right pane of Console1, right-click Trusted Root Certification Authorities, then All Tasks and Import.

   The Certificate Import Wizard dialog box opens.

   

10. Click Next.

    

11. In the File name text box, enter the file name under which to save the certificate, and then click Next.

    

12. Choose Place all certificates in the following store, and then click Next.

    

13. Click Finish.

    

14. Click OK.

(a) User defined record collection

The following records are used in user defined record collection:

• Host Generic Data Detail (PD_HGDD)

• Host Generic Data Interval (PI_HGDI)

• VM Generic Data Detail (PD_VGDD)

• VM Generic Data Interval (PI_VGDI)

Each record has different record types and monitoring targets. Use the record that meets your needs.

The following table shows the details of the records.

Record name	Record type	Monitoring target	Use it to:
Host Generic Data Detail (PD_HGDD)	PD record	Physical server	Get the physical server's system status at a given point in time.
Host Generic Data Interval (PI_HGDI)	PI record	Physical server	Analyze changes or trends in the physical server's system status over time.
VM Generic Data Detail (PD_VGDD)	PD record	Virtual machine	Get the virtual machine's system status at a given point in time.
VM Generic Data Interval (PI_VGDI)	PI record	Virtual machine	Analyze changes or trends in the virtual machine's system status over time.

(b) Items collected in user defined records

You can see which items are collected in user defined records by checking the performance chart of VMware vSphere Client.

For example, if you want to monitor utilization of the physical server's CPU core, you check the following items:

Items collected for CPU core utilization

Chart Options: CPU

Rollup: average

Internal Name: coreUtilization

(c) Deploying the user-defined record definition file

Add the user-defined record definition file with the name recorddef.ini to the folder of the instance whose VM_Type is vmware.

For physical hosts:

installation-folder\agt8\agent\instance-name\recorddef.ini

For logical hosts:

environment-folder\jp1pc\agt8\agent\instance-name\recorddef.ini

The same definition file is used for all the monitoring targets in the instance.

Examples where the instance name is inst01:

• For physical hosts:

  installation-folder\agt8\agent\inst01\recorddef.ini

• For logical hosts:

  environment-folder\jp1pc\agt8\agent\inst01\recorddef.ini

The user-defined record define information file is validated when the Remote Monitor Collector service starts. If there is no error in the file, the message KAVL20528-I is output. If there is an error in the file, the message KAVL20527-W is output, and the Remote Monitor Collector service starts without collecting user defined records.

Note

If you change the user-defined record definition file, restart the Remote Monitor Collector service. The definition file that was loaded at startup is not updated until the service is restarted.

(d) Creating the user-defined record definition file

You can specify the user defined records to be monitored and the items to be collected to create the user-defined record definition file.

Format of the definition file

Configure the user-defined record definition file (in ini format) as follows:

[record-ID]
[[section-name]]
TYPE=chart-option
NAME=internal-name
ROLLUP=rollup

Items of the definition file

The following table shows the items you need to specify.

Item	Parameter	Explanation
1	[record-ID]	Specify the record ID in which data is stored. Values can be: PD_HGDD: Host Generic Data Detail record PI_HGDI: Host Generic Data Interval record PD_VGDD: VM Generic Data Detail record PI_VGDI: VM Generic Data Interval record
2	[[section-name]]	Specify the section name with up to 32 bytes of single-byte alphanumeric characters, hyphens (-), and underscores (_). The specified section name is stored in the SECTION_NAME field.
3	TYPE=chart-option	Specify the chart option# with up to 32 bytes of single-byte alphanumeric characters. If the specified chart option does not exist, no performance data will be collected.
4	NAME=internal-name	Specify the name of the performance counter (internal name) with up to 64 bytes of single-byte alphanumeric characters and periods (.). If the specified internal name does not exist, no performance data will be collected.
5	ROLLUP=rollup	Specify the rollup. Values can be: Average value: average Latest value: latest Summary value: summation If the specified rollup does not exist, no performance data will be collected.

#

The following table shows the values to be specified for each chart option.

Item	Chart option	Value to be specified	Corresponding record ID
1	CPU	cpu	PD_HGDD, PI_HGDI, PD_VGDD, and PI_VGDI
2	vSphere Replication	hbr	PD_HGDD and PI_HGDI
3	System	sys	PD_HGDD, PI_HGDI, PD_VGDD, and PI_VGDI
4	Storage adapter	storageAdapter	PD_HGDD and PI_HGDI
5	Storage path	storagePath	PD_HGDD and PI_HGDI
6	Disk	disk	PD_HGDD, PI_HGDI, PD_VGDD, and PI_VGDI
7	Datastore	datastore	PD_HGDD, PI_HGDI, PD_VGDD, and PI_VGDI
8	Network	net	PD_HGDD, PI_HGDI, PD_VGDD, and PI_VGDI
9	Memory	mem	PD_HGDD, PI_HGDI, PD_VGDD, and PI_VGDI
10	Virtual flash	vflashModule	PD_HGDD and PI_HGDI
11	Virtual disk	virtualDisk	PD_VGDD and PI_VGDI
12	Power source	power	PD_HGDD, PI_HGDI, PD_VGDD, and PI_VGDI
13	Information on the management agent	managementAgent	PD_HGDD and PI_HGDI

Definition example for utilization of the physical server's CPU core

[PD_HGDD]
[[CPU_CORE_UTIL]]
TYPE=cpu
NAME=coreUtilization
ROLLUP=average

Notes

• If there is no performance data that matches the combination of the specified items, the type name (TYPE), counter name (NAME), and rollup type (ROLLUP), no user defined record will be collected. Create a report for the user defined record to make sure the items are output.

• The number of the section names in the user-defined record definition file must not exceed 100. Collecting performance data can take a long time when many section names are listed in the file.

• If a large number of virtual machines monitored are running, the number of the PI_VGDI records increases. Keep this in mind, and monitor the PFM-RM host to prevent a poor disk performance or a storage shortage.

• The user-defined record definition file is loaded during startup of the PFM - RM for Virtual Machine service. If you change the definition file, restart the service.

• If there is an error in the user-defined record definition file, the message KAVL20527-W is output to the common message log. Check the line number and the details in the message to correct the file.

• If there is an error in the user-defined record definition file, the PFM - RM for Virtual Machine service starts while ignoring the record type that includes the error. You can check the valid defined record types in the message KAVL20528-I, which is output to the common message log.

• If the message KAVL20528-I is not output to the common message log, no user defined records will be collected. Make sure that the location where the user-defined record definition file is stored, the file name, and the contents of the file are correct.

(e) Examples of the definition and output

Here are examples of the definition and output to collect CPU wait time and memory wait time for physical servers and virtual machines.

Definition example:

[PD_HGDD]
[[CPU_WAIT]]
TYPE=cpu
NAME=wait
ROLLUP=summation
[[MEM_LATENCY]]
TYPE=mem
NAME=latency
ROLLUP=average
 
[PI_VGDI]
[[CPU_WAIT]]
TYPE=cpu
NAME=wait
ROLLUP=summation
[[MEM_LATENCY]]
TYPE=mem
NAME=latency
ROLLUP=average

Output example:

Host Generic Data Detail (PD_HGDD) record

Section Name	Data Name	Object Name	String Data	Double Data
CPU_WAIT	wait	0	0	0.0
CPU_WAIT	wait	1	24	24.0
MEM_LATENCY	latency	n/a	0	0.0

VM Generic Data Interval (PI_VGDI) record

Section Name	Data Name	Object Name	String Data	Double Data
CPU_WAIT	wait	0	1.2	1.2
CPU_WAIT	wait	1	1	1.0
MEM_LATENCY	latency	n/a	0.2	0.2