Port Adapter Installation and Configuration Guide vcenter Operations Manager 1.0 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www.vmware.com/support/pubs. EN-000893-01
You can find the most up-to-date technical documentation on the VMware Web site at: http://www.vmware.com/support/ The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: docfeedback@vmware.com Copyright 2012 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents. VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies. VMware, Inc. 3401 Hillview Ave. Palo Alto, CA 94304 www.vmware.com 2 VMware, Inc.
Contents Port Adapter Installation and Configuration Guide 5 Updated Information 7 1 Introduction to the Port Adapter 9 How the Adapter Monitors Ports 9 Resources that the Adapter Creates 9 Metrics that the Adapter Creates 10 2 Installing the Port Adapter 11 Install the Adapter in a Standalone Installation 11 Install the Adapter in a vapp Installation 12 Port Adapter Folders and Files 13 3 Configuring the Port Adapter 15 Add an Adapter Instance 15 Creating the Host and Port List 15 Configuring Alert Notifications 16 Start Data Collection 16 4 Troubleshooting the Port Adapter 17 Troubleshooting a Port Adapter Instance 17 Viewing System Log Files 17 Port Adapter Classes 18 Index 19 VMware, Inc. 3
4 VMware, Inc.
The Port Adapter Installation and Configuration Guide describes how to install and configure the port adapter for vcenter Operations Manager. Intended Audience This information is intended for anyone who needs to install or configure the port adapter. VMware, Inc. 5
6 VMware, Inc.
Updated Information The Port Adapter Installation and Configuration Guide is updated with each release of the product or when necessary. This table provides the update history of the Port Adapter Installation and Configuration Guide. Revision EN-000893-01 EN-000893-00 Description Changed the product name to reflect the new licensing model for the 5.6 release. Initial release. VMware, Inc. 7
8 VMware, Inc.
Introduction to the Port Adapter 1 The port adapter is an embedded adapter for vcenter Operations Manager. The adapter monitors the availability state and response time of ports on hosts. This chapter includes the following topics: How the Adapter Monitors Ports, on page 9 Resources that the Adapter Creates, on page 9 Metrics that the Adapter Creates, on page 10 How the Adapter Monitors Ports The port adapter uses sockets to monitor the availability state and response time of ports on hosts. You define the hosts, and the ports to monitor on those hosts, in a text file named host_port_list.txt. The host_port_list.txt file contains a list of host names or IP addresses and the ports to monitor, for example: 123.456.789.10 = 162,1433 myhost.domain.com = 443,80 Resources that the Adapter Creates The port adapter creates a resource in vcenter Operations Manager for each host listed in host_port_list.txt. Each host resource is a resource of the port adapter instance resource. The host name or IP address becomes the resource name and the resource identifier of the host resource. In this example, the port adapter instance is named PortAdapterInst1 and the host resource names are the IP addresses of the hosts. Figure 1-1. Port Adapter Resource Example VMware, Inc. 9
Metrics that the Adapter Creates The port adapter creates a metric group called Port for each host resource. The ports that you define for each host in the host_port_list.txt file become instances of the Port group. The instance names in the user interface are blank by default. Each port instance has a Port Availability and a Port Response Time (ms) metric. IMPORTANT Leave the instance names blank. If you configure port numbers for the instance names in the user interface, vcenter Operations Manager ignores the port numbers that you define for the host in the host_port_list.txt file and receives data only for the port numbers that you configure for the instance names. Figure 1-2. Port Metric Group Example 10 VMware, Inc.
Installing the Port Adapter 2 How you install the port adapter depends on whether you have a vcenter Operations Manager Standalone or vapp installation. This chapter includes the following topics: Install the Adapter in a Standalone Installation, on page 11 Install the Adapter in a vapp Installation, on page 12 Port Adapter Folders and Files, on page 13 Install the Adapter in a Standalone Installation If you have a standalone installation, you install the port adapter by extracting the adapter installation files from a TGZ file and running an installation utility. Prerequisites Download the adapter installation TGZ file anonymously from ftp://ftp.integrien.com/. Make a note of the build number in the TGZ file name. The build number appears after the adapter name, for example, adaptername-buildnumber.tgz. Read the release notes that are included with the TGZ file. Procedure 1 Open the TGZ file and extract the TAR file to a temporary folder on your vcenter Operations Manager server. 2 In the temporary folder, open the TAR file and extract and run the installer for your operating system platform. 3 Log in to the Custom user interface as an administrator. 4 Select Admin > Support. 5 On the Info tab, find the Adapters Info pane and click the Describe icon ( ). The Describe icon is located at the top right of the Adapters Info pane. 6 Click Yes to start the describe process and click OK. The Custom user interface finds the adapter files, gathers information about the abilities of the adapter, and updates the user interface with information about the adapter. If you have remote collectors, it installs the adapter on the remote collectors. The describe process might take several minutes. When the describe process is finished, the adapter appears in the Adapters Info pane. The build number is in the Adapter Version column. VMware, Inc. 11
7 Verify that the build number in the Adapter Version column for the adapter matches the build number in the TGZ file that you downloaded. The installation utility creates the port_adapter3 folder and port_adapter3.jar file in the vcenterops/user/plugins/inbound folder. Install the Adapter in a vapp Installation If you have a vapp installation, you install the port adapter from a PAK file. Prerequisites Download the adapter installation PAK file anonymously from ftp://ftp.integrien.com. Make a note of the build number in the PAK file name. The build number appears after the adapter name, for example, adaptername-buildnumber.pak. Read the release notes that are included with the PAK file. Procedure 1 Save the PAK file in a temporary folder. 2 Log in to the Admin user interface as the admin user. For example: https://ipaddress/admin/ 3 On the Update tab, click Browse to locate the temporary folder and select the PAK file. 4 Click Update and click OK to confirm the update. The Admin user interface uploads the PAK file. The upload might take several minutes. 5 Read and accept the EULA and click OK. 6 Click OK to confirm and start the update process. The update might take several minutes. Status information appears on the Update tab when the update is finished. 7 Log in to the Custom user interface as an administrator. For example: https://ipaddress/vcops-custom/ 8 Select Admin > Support. 9 On the Info tab, find the Adapters Info pane and click the Describe icon ( ). The Describe icon is located at the top right of the Adapters Info pane. 10 Click Yes to start the describe process and click OK. The Custom user interface finds the adapter files, gathers information about the abilities of the adapter, and updates the user interface with information about the adapter. The describe process might take several minutes. When the describe process is finished, the adapter appears in the Adapters Info pane. The build number is in the Adapter Version column. 11 Verify that the build number in the Adapter Version column for the adapter matches the build number in the PAK file that you uploaded. The installation process creates the port_adapter3 folder and port_adapter3.jar file in the vcenterops/user/plugins/inbound folder. 12 VMware, Inc.
Chapter 2 Installing the Port Adapter Port Adapter Folders and Files The installer places the port adapter files in the vcenter-ops/user/plugins/inbound/port_adapter3 folder. The port_adapter3 folder contains the conf subfolder and several files. Table 2-1. Port Adapter Folders and Files Folder File Description conf port_adapter.properties Contains adapter configuration properties. describe.xml version.txt history.txt host_port_list.txt Describes the adapter. Contains the adapter version. Contains the history of the adapter changes. Defines the ports that the adapter monitors. VMware, Inc. 13
14 VMware, Inc.
Configuring the Port Adapter 3 To configure the port adapter, you add an adapter instance in vcenter Operations Manager and define the ports that the adapter instance monitors. You can optionally modify the alert notification setting. This chapter includes the following topics: Add an Adapter Instance, on page 15 Creating the Host and Port List, on page 15 Configuring Alert Notifications, on page 16 Start Data Collection, on page 16 Add an Adapter Instance You must create an adapter instance for the port adapter. The adapter instance defines the adapter type. Prerequisites Install the port adapter. See Chapter 2, Installing the Port Adapter, on page 11. Procedure 1 Log in to the Custom user interface as an administrator. 2 Select Environment > Configuration > Adapter Instances. 3 Select the collector to use from the Collector drop-down menu. Unless you added additional collectors, the only available collector is vcenter Operations Server. You can change the name of this collector when you install the standalone version. 4 Select Port from the Adapter Kind drop-down menu. 5 Click the Add New Adapter Instance icon. 6 Type a name for the adapter in the Adapter Instance Name text box. 7 Click OK to save your configuration. What to do next Define the ports that the adapter instance monitors. See Creating the Host and Port List, on page 15. Creating the Host and Port List You define the ports that the adapter monitors in a text file named host_port_list.txt. Type each entry in the host_port_list.txt file on a separate line and use the following format: VMware, Inc. 15
host = port_number,port_number,... host can be a host name or IP address. If you define multiple port numbers for a single host, use a comma to separate each port number. A sample host_port_list.txt file is in the port_adapter3 folder. Configuring Alert Notifications The port adapter generates a Port Down alert notification when a port that it monitors becomes unavailable. If all of the ports on a host become unavailable, the GENERATE_RESOURCE_DOWN_ALERT property in the port_adapter.properties file determines how the port adapter generates alert notifications for those ports. Set GENERATE_RESOURCE_DOWN_ALERT to false to generate Port Down alert notifications for each unavailable port. Set GENERATE_RESOURCE_DOWN_ALERT to true to generate one Resource Down alert for the host instead of generating Port Down alert notifications for each unavailable port. This is the default setting. NOTE In a vapp installation, you modify the port_adapter.properties file on the Analytics virtual machine. Start Data Collection After you add an adapter instance and define the ports that the adapter monitors, you can start data collection for the adapter instance resource in vcenter Operations Manager. Prerequisites Add an adapter instance. See Add an Adapter Instance, on page 15 Define the ports that the adapter monitors. See Creating the Host and Port List, on page 15. Procedure 1 Log in to vcenter Operations Manager as an administrator. 2 Select Environment > Environment Overview. 3 In the left pane, expand Adapter Instances and click the port adapter instance. 4 On the List tab, select the port adapter instance and click the Start Collecting icon. 16 VMware, Inc.
Troubleshooting the Port Adapter 4 Known troubleshooting information can help you diagnose and correct problems with the port adapter. Log files contain valuable information about adapter instance operation. This chapter includes the following topics: Troubleshooting a Port Adapter Instance, on page 17 Viewing System Log Files, on page 17 Port Adapter Classes, on page 18 Troubleshooting a Port Adapter Instance Perform these general troubleshooting steps to diagnose and correct problems with a port adapter instance. View the collection status and collection state for the adapter instance resource on the Environment Overview page in the Custom user interface. Check the adapter and collector logs for errors. See Viewing System Log Files, on page 17. For information about how to view resources, see the online help. Viewing System Log Files You can view port adapter errors in the vcenter Operations Manager adapter and collector logs files. You can view adapter and collector log files in the Custom user interface or in an external log viewer. The port adapter log files are in the vcenter-ops/user/log/adapters/portadapter folder. The collector log file is in the vcenter-ops/user/log folder. The logging level is set to ERROR by default. To troubleshoot issues, set the logging level to INFO. To view detailed messages, including micro steps, queries, and returned results, set the logging level to DEBUG. NOTE If you set the logging level to DEBUG, log files can become large very quickly. Set the logging level to DEBUG only for short periods of time. For information about viewing log files and modifying logging levels, see the online help. VMware, Inc. 17
Port Adapter Classes The port adapter uses certain adapter classes. Table 4-1. Port Adapter Classes Class com.integrien.adapter3.port.portadapter com.integrien.adapter3.port.portconstants com.integrien.adapter3.port.portadapterproperties com.integrien.adapter3.port.devicenotavailableexceptio n com.integrien.adapter3.port.miscutils com.integrien.adapter3.port.netutils com.integrien.adapter3.port.socketconnector com.integrien.adapter3.port.socketserver com.integrien.adapter3.port.threadutils Description Adapter entry class. Contains the main functionality methods. Contains all of the constant values that the adapter uses. Reads the properties in the port_adapter.properties file. Special exception class that indicates when a device is not available. Contains utility methods. Checks the availability of a device by attempting to connect to a specified port. Represents a socket connector. Contains methods such as getresponse(). Represents a socket server. Includes fields such as port and id. Contains thread utility methods. 18 VMware, Inc.
Index A adapter classes 18 adapter instance 15 audience information 5 C collecting data 16 configuration steps 15 G GENERATE_RESOURCE_DOWN_ALERT property 16 H host-port-list.txt 9 host-port-list.txt file 15 I installing the adapter 11, 12 introduction 9 L log files 17 M monitoring ports 9 P Port Availability metric 10 Port group 10 Port Resource resource kind 9 Port Response Time metric 10 port_adapter3 folder 13 T troubleshooting steps 17 U updated information 7 VMware, Inc. 19
20 VMware, Inc.