Application Discovery Manager Administration Guide vCenter Application Discovery Manager 6.2.2 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.
Application Discovery Manager Administration Guide 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.
Contents About This Book 7 1 Overview 9 System Architecture 9 Distributed Appliance Solutions 11 Virtual and Physical Appliance Solutions 11 Virtual Appliance Deployment 11 Physical Appliance Deployment 12 Mirrored Network Traffic 12 vCollector 12 Mixed Environment 13 Where To Go Next 13 Installation of New or Additional ADM Components 13 Licenses 13 Upgrading ADM 13 Migrating to a New Appliance 13 Security 13 2 Installing ADM 15 ADM Installation Requirements 15 Installation Personnel 15 ESX Resources 1
Application Discovery Manager Administration Guide 4 Securing ADM 31 Changing the Root Password 31 Resetting the ADM Root Password 31 OpenSSL Self‐Signed Test Certificates 32 CA Signed Test Certificates 32 Self‐Signed Certificates 32 5 Maintenance 35 ADM Services 35 Product Support Packages 36 Using the ADM Console 37 Using the CLI 37 Restoring an ADM Environment by Using a Product Support Package Reconfiguring an ADM Deployment 40 Adding a Remote Database to an Existing ADM Deployment 40 Converting a Sin
Contents single.sh 52 snmpdump 55 nlcapture 55 9 Uninstalling ADM 57 Uninstalling the ADM Appliance 57 A Time Zones 59 B ADM API Tutorial 61 API Features 61 Insight_control 61 Asynch API 62 Dump API 62 Bulk API 63 Web Services API 63 Index 65 VMware, Inc.
Application Discovery Manager Administration Guide 6 VMware, Inc.
About This Book The VMware vCenter™ Application Discovery Manager (ADM) Administration Guide provides information that the administrators are required to install and configure the ADM. Intended Audience This document is part of the VMware vCenter Application Discovery Manager documentation set, and is intended for use by system administrators and integrators responsible for installing ADM.
Application Discovery Manager Administration Guide VMware Professional Services VMware Education Services courses offer extensive hands‐on labs, case study examples, and course materials designed to be used as on‐the‐job reference tools. Courses are available onsite, in the classroom, and live online. For onsite pilot programs and implementation best practices, VMware Consulting Services provides offerings to help you assess, plan, build, and manage your virtual environment.
1 1 Overview This chapter describes the different VMware vCenter Application Discovery Manager (ADM) architecture solutions and configuration.
Application Discovery Manager Administration Guide Table 1-1. ADM Components Component Description Active Discovery‐ UNIX Collects data from the configuration objects in your data center. The following discovery types apply: IP discovery: A method for detecting hosts or other configuration items with a specific IP address when Passive Discovery fails to discover them. Detail discovery: Extends the information obtained using Passive and IP Discovery.
Chapter 1 Overview Distributed Appliance Solutions The distributed appliance solution has at least one designated appliance enabled as a Collector, and another appliance enabled as an Aggregator and Database as shown in Figure 1‐3. Figure 1-3.
Application Discovery Manager Administration Guide Download the following artifacts from the VMware Web site: http://downloads.vmware.com/Application Discovery Manager Core ADM Template: An OVF template that includes all ADM components except for the Windows Collector and you can configure as Aggregator, Aggregator with remote database, Database, or Single‐Box.
Chapter 1 Overview Mixed Environment The ADM 6.2.2 release introduces ADM as a virtual appliance, but it also supports upgrading from 6.0 on a physical IBM appliances. You can upgrade your physical environment with additional virtual 6.2.2 appliances like mixed environment. This additional virtual appliance can play a role of Passive Collectors (vCollectors) or an additional Passive and Active Collectors. . NOTE All ADM appliances that participate in mixed environemnt mode must run the same 6.2.
Application Discovery Manager Administration Guide 14 VMware, Inc.
2 2 Installing ADM This chapter describes installation and deployment of the ADM. This chapter includes the following topics: “ADM Installation Requirements” on page 15 “Disabling vMotion” on page 16 “Preparing the Environment” on page 17 “Deploying the Virtual Appliances” on page 18 “Installing Windows Collector” on page 20 ADM Installation Requirements ADM is an appliance that can run in a VMware infrastructure.
Application Discovery Manager Administration Guide Installing the vSphere Client Install the vSphere client to work with VMware environment. To download and install the vSphere Client 1 Launch Internet Explorer browser. NOTE ADM supports Windows Internet Explorer 6.0 and later browsers.
Chapter 2 Installing ADM Preparing the Environment Perform the following procedures before you set up the ADM. Preparing an ESX Configuration Create and configure a new vSwitch for each physical span port. Repeat the following procedures for each new vSwitch. Creating a New vSwitch for Passive Discovery To create a new vSwitch for Passive Discovery 1 Connect the monitor ports to available network interfaces on the ESX server. 2 Connect to the ESX server or vCenter by using vSphere client.
Application Discovery Manager Administration Guide 2 g Set the Network Label, for example, ADM span port and click Next. h Verify that the port group is listed, and click Finish. Change the Promiscuous Mode to Accept. This value is set to Reject by default. a Select the port group that you created; for example, ADM span port. b Click Edit and select Security tab. c Select Promiscuous Mode, and then select Accept from the list box. d Click OK and then Close.
Chapter 2 Installing ADM Deploying the ADM Virtual Appliances Virtual appliances are installed on the ESX server according the configurations in Table 2‐3. Table 2-3.
Application Discovery Manager Administration Guide 4 Click Next. The OVF Template Details screen appears. 5 Click Next. The Name and Location screen appears. 6 Type a unique virtual appliance name according to the IT naming convention of your organization and with relevance to the appliance type as described in Table 2‐3. 7 Click Next. The Datastore screen appears. NOTE If there is more than one datastore, select the datastore where you want to install the virtual machine. 8 Click Next.
Chapter 2 Installing ADM 7 Type the following information to configure the Windows Collector: Aggregator IP Address Windows Collector unique ID NOTE This is the same identifier that was defined on the Aggregator side for WMI discovery. The default value is 200. 8 Click Next. The Installation screen appears. 9 Click Install to begin the installation. NOTE The process of installing and configuring the Windows Collector can take several minutes.
Application Discovery Manager Administration Guide 22 VMware, Inc.
3 Setting Up ADM 3 This chapter provides information for setting up the ADM virtual appliance deployments. This chapter includes the following topics. “Process” on page 23 “Post‐Installation Steps” on page 27 Process After the ADM appliance is deployed on the ESX Server, perform the following procedures: “Order of Setup” on page 23.
Application Discovery Manager Administration Guide Table 3-1. Network Values Parameter Value Network IP address Network netmask Network gateway Domain Name Server (DNS) NOTE: You can enter up to three Domain Name Servers separated by comma. Fully Qualified (FQ) hostname Launching the First Boot Configuration Tool Repeat the following steps for each ADM virtual appliance: NOTE The Windows Active Collector is set up as described in “Installing Windows Collector” on page 20.
Chapter 3 Setting Up ADM To change the root password 1 Type a new password for the root user and press Enter. 2 Retype the password and press Enter to confirm. The wizard now asks to add network information, type yes. The wizard prompts you to add network information and you can add the network information as described in “Configuring Static Network Settings” on page 25.
Application Discovery Manager Administration Guide The wizard displays all the settings that you have completed and asks for your confirmation to save the information. If you type yes, the wizard saves the settings and the system starts rebooting. After completion, the wizard displays the message to set the appliance role setting. You can configure the appliance role as described in “Configuring the Appliance Role” on page 26.
Chapter 3 Setting Up ADM To configure the appliance role for Collector 1 Type yes at the appliance role prompt and press Enter. 2 Type the role number and press Enter. 3 If you select 1, you have to enter the Collector ID of your choice and press Enter. The default value is 100. 4 Type the Aggregator IP and press Enter. The appliance role is then created. This process might take some time.
Application Discovery Manager Administration Guide If Active Directory configuration is valid, the management service is restarted. After successful Active Directory configuration, access to the UI is lost for few minutes as the management service restarts. The VMware vCenter Application Discovery Manager Online Help provides detailed information about adding an Active Directory user.
Chapter 3 Setting Up ADM 11 Click OK in the message box that states: Starting a new Passive Discovery deletes all existing discovery data. This might take a few minutes. The system is unavailable to all users during this process. Continue? 12 Click OK to begin the discovery process. The dashboard reappears with the Discovery status (initially “Discovering”) in the top status bar of the ADM Console. 13 You can now begin using the ADM.
Application Discovery Manager Administration Guide 30 VMware, Inc.
4 Securing ADM 4 This chapter provides information on securing ADM appliance. This chapter includes the following topics: “Changing the Root Password” on page 31 “Resetting the ADM Root Password” on page 31 “OpenSSL Self‐Signed Test Certificates” on page 32 “CA Signed Test Certificates” on page 32 Changing the Root Password To change the root password 1 Log in to the ADM appliance by using a Secure Shell (SSH) client.
Application Discovery Manager Administration Guide 6 Place your cursor at the end of the line and append the line by typing: single 7 Press Enter to commit the change. 8 Press b to start the system. Your system starts without requiring a password. 9 Type the following command to reset the password: passwd 10 Follow the prompts as they appear on the screen to set the password. 11 Type the following command to restart the system: reboot Your password is changed and restarts the system.
Chapter 4 Securing ADM To create a certificate 1 To generate the Rivest, Shamir, and Adleman (RSA) key type: cd /etc/httpd/conf/ssl.prm/ openssl genrsa 2048 > server.key chmod 400 server.key The openSSL utility can generate a Digital Signature Algorithm (DSA) key by using the gendsa option. For compatibility, VMware recommends RSA keys by using 2048‐bits as the key size. 2 Create the certificate by typing: openssl req -new -x509 -nodes -sha1 -days 365 -key server.key > server.
Application Discovery Manager Administration Guide 34 VMware, Inc.
5 Maintenance 5 This chapter describes the necessary concepts and procedures to maintain an ADM deployment. This chapter includes the following topics: “ADM Services” on page 35 “Product Support Packages” on page 36 “Restoring an ADM Environment by Using a Product Support Package” on page 38 “Reconfiguring an ADM Deployment” on page 40 “Licenses” on page 41 ADM Services Table 5‐1 describes the main ADM services. Table 5-1.
Application Discovery Manager Administration Guide Managing Services with adm_control ADM provides the adm_control.pl script to start, stop, and monitor ADM services. You can start or stop any service, but if you stop any service all dependent services are stopped as a result. All dependent services is listed during the stop process. Table 5‐2 lists and describes the commands for the ADM services. Table 5-2. ADM Service Commands Use the Following Command To adm_control.
Chapter 5 Maintenance You can create support packages either through the ADM Console or through the Command Line Interface (CLI). NOTE Product support packages require a password for extraction. Contact VMware Customer Support to retrieve the password if you use the product support package to restore ADM or the ADM database as described in “Restoring an ADM Environment by Using a Product Support Package” on page 38.
Application Discovery Manager Administration Guide Restoring an ADM Environment by Using a Product Support Package To restore an ADM configuration 1 Backup your ADM environment as described in “Product Support Packages” on page 36. 2 Contact VMware Customer Support to retrieve the password for extracting the product support package. 3 Follow the steps in “Restore the ADM Database” on page 38. 4 If necessary, “Restoring the Custom Discovery and Configuration Files” on page 39.
Chapter 5 Maintenance 12 Exit from the nlayers user. 13 Type the following adm_control.pl command to start the services: /home/nlayers/Seneca/Control/bin/adm_control.pl --start all NOTE If the ADM configuration being restored has custom configuration files or fingerprints, you must complete the steps outlined in “Restoring the Custom Discovery and Configuration Files” on page 39.
Application Discovery Manager Administration Guide 15 Place the copied files to: /tmp/adkb/custom 16 Overwrite any files or folders in the destination directory if prompted to do so. 17 Type the following command to check in the custom fingerprints: /home/nlayers/Seneca/management/APIs/InSight_control.sh adkb --checkin /tmp 18 Type the following adm_control.pl command to restart the relevant services: /home/nlayers/Seneca/Control/bin/adm_control.
Chapter 5 Maintenance 3 Ensure that the database mode is set correctly, as follows: a Type the command: /home/nlayers/Seneca/tools/appliance_conf.pl --status b If the mode is not database correct it by typing: /home/nlayers/Seneca/tools/appliance_conf.pl -mode=d 4 Make a note of the IP address of the remote database. 5 Run the appliance_conf.pl script on the Aggregator appliance: a Edit the file /home/nlayers/Seneca/tools/remote.db.conf.
Application Discovery Manager Administration Guide Access the Licenses Properties screen from the Manage > System > Licensing menu in the ADM UI that displays the license information, which includes the licensed feature, quantity of available licenses, and expiry date. The appropriate warning message appears on the Dashboard, Inventory and License Properties page. An ADM UI administrator can login to review license limitations and upload new licenses as required.
6 Upgrading ADM 6 This chapter describes the necessary concepts and procedures to upgrade an ADM deployment. This chapter includes the following topics: “Overview” on page 43 “Upgrading Appliances” on page 44 “Post‐Upgrade Steps” on page 46 Overview The following considerations apply for appliance upgrades and migration. Appliance Type You can upgrade ADM on physical ADM on virtual appliances running versions 6.1.x or later as described in “Upgrading Appliances” on page 44.
Application Discovery Manager Administration Guide Upgrading Appliances This section describes the upgrading of Application Discovery Manager versions 6.0.x or later for physical appliances and 6.1.x or later for virtual appliances. Important Notes All appliances in your current environment must run ADM version 6.0.x or later. Also, upgrade all appliances to the same ADM version. Before upgrading the ADM, familiarize yourself with “Overview” on page 43.
Chapter 6 Upgrading ADM 4 Wait for the upgrade to complete. For distributed solutions, repeat the upgrade procedures for all remaining appliances as described in “Upgrading Appliances” on page 44. NOTE The upgrade process can take several minutes to complete. You cannot access the ADM Console while the upgrade is in progress. 5 Proceed with “Post‐Upgrade Steps” on page 46. NOTE WinApe is upgraded as part of aggregator upgrade and you are not required to upgrade it separately. VMware, Inc.
Application Discovery Manager Administration Guide Post-Upgrade Steps Before you login to the ADM console: Clear the cache of your browser to prevent the possible appearance of incorrect information in the displays, application errors, and other error messages when opening the ADM. IMPORTANT You might be required to upload a new license if you are upgrading from 6.0.x. Before proceeding, review the criteria and if necessary, perform the steps described in“Licenses” on page 13.
7 Migrating to a New Appliance 7 This chapter provides instructions on migration of an existing physical or virtual ADM appliance to a virtual appliance supplied by VMware. This chapter includes the following topics: “Overview” on page 47 “Preliminary Procedures” on page 48 “Data Restoration” on page 49 “Post‐Migration Steps” on page 50 Overview Additional documentation as described below is available at http://downloads.vmware.
Application Discovery Manager Administration Guide Migrate or upgrade all appliances to the same ADM version in the following order: 1 Remote database (for Distributed with remote database solution) 2 Collectors (for all Distributed solutions) 3 Aggregator Process The migration process is as follows: 1 Record the current appliance network settings as described in “ADM Setup Procedures” on page 23. 2 Backup your data as described in “Product Support Packages” on page 36.
Chapter 7 Migrating to a New Appliance Restoring WinApe Migration Files NOTE Backup your ADM environment as described in “Backing Up WinApe Migration Files” on page 48. The following procedures describes the restoration of WinApe migration files. 1 Log in to the WinApe appliance. 2 Copy the adkbcustom.jar backup file. 3 Navigate to the \lib folder. 4 Replace the current file in \lib folder with the copied file. 5 Run the services.msc command.
Application Discovery Manager Administration Guide Aggregator 1 Log in to the Aggregator virtual appliance. 2 Restore the ADM database as described in “Troubleshooting ADM by Using the Product Support Package” on page 51. 3 Make the necessary changes in the Active probe configuration screen under the Manage > System menu of the ADM console to reflect the new collector appliance. The VMware vCenter Application Discovery Manager User’s Guide.
8 Troubleshooting ADM 8 This chapter provides instructions on troubleshooting of the ADM.
Application Discovery Manager Administration Guide Using ADM Console You must first create a detail discovery product support package for detail discovery troubleshooting. To create a detail discovery product support package 1 Log in to the ADM console. 2 Navigate to Discovery > Inventory. 3 Click a host that is already discovered using detail discovery method. 4 On the Detail Discovery Policies tab, select name of the policy for which you need to create a support package. 5 Click Support Package.
Chapter 8 Troubleshooting ADM Table 8‐1 lists and describes parameters for the single.sh utility. Table 8-1. single.sh Parameters Parameter Description -A,--planArtifacts Attribute Artifacts Attribute artifacts to discover. -a, -address address Address(es) of the discovery target. Use commas as separators. -AddExU Additional UNIX Exclude Directories Additional Exclude directories from search in the UNIX file system.
Application Discovery Manager Administration Guide Table 8-1. single.sh Parameters (Continued) Parameter Description -T, -translator Discovery result translator class Specify the discovery result translator class. Predefined translators are available through their aliases, for example: class com.nlayers.seneca.ap.mediation.DoNothingDiscoveryResult Translator adm class com.nlayers.seneca.ap.mediation.cim.AdmToCimXmlDiscove ryResultTranslator cimxml class com.nlayers.seneca.ap.mediation.cim.
Chapter 8 Troubleshooting ADM Note the following: Escaped double‐quotes surround the protocol information—these must be used. Unknown arguments are ignored. Omitted password fields are requested by the application interactively without echoing.
Application Discovery Manager Administration Guide Similar to tcpdump, you can use nlcapture to filter an existing capture file and transform it to a new, filtered file. See usage below. Location /home/nlayers/Seneca/tools/nlcapture.pl Usage Running nlcapture on the command line yields: nlcapture.pl tcpdump options [-R ethereal display filter string] For example: To listen on eth1 and capture all HTTP and ICMP packets into the file bla.dump: nlcapture.pl -i eth1 -R "http||icmp" -w myoutput.
9 Uninstalling ADM 9 This chapter provides information for uninstalling the ADM appliance and includes “Uninstalling the ADM Appliance” on page 57. Uninstalling the ADM Appliance To uninstall the ADM appliance, follow the procedure of your organization for removing a virtual machine. VMware, Inc.
Application Discovery Manager Administration Guide 58 VMware, Inc.
A A Time Zones This appendix lists ADM time zones as shown in Table A‐1. Table A-1. Time Zones for ADM VMware, Inc.
Application Discovery Manager Administration Guide Table A-1.
B ADM API Tutorial B This appendix describes the ADM API and explains how to access and use it. Topics include: “API Features” on page 61 “Web Services API” on page 63 API Features The API of ADM allows clients to query its database and export parts of it by means of a web services API. The following cases are explained in the following sections: Writing the system status into an XML output file; “Insight_control” on page 61.
Application Discovery Manager Administration Guide Sample Status Output 6.1.0-6013 09:20:15 up 7 days, 18 min, 1 user, load average: 1.36, 2.17, 1.71 Running Not Running (Purposely Stopped) Not Running (Purposely Stopped) Running Running Running Asynch API Operations in ADMʹs API are asynchronous.
Appendix B ADM API Tutorial Bulk API The Bulk API provides you with the possibility of querying the ADM with more sophisticated filters, and browsing the result set by means of pagination. The results are delivered in subsets (pages) of a predefined size and formatted in XML CIM. This API is intended for those cases where an application intends to browse on finely‐filtered segment of the ADMʹs data.
Application Discovery Manager Administration Guide 64 VMware, Inc.
Index A U active_probe service 35 ADM architecture solutions 9 required time zones 59 restore 38 services 35 ADM API 61 adm_control.
Application Discovery Manager Administration Guide 66 VMware, Inc.