Application Discovery Manager Repository Reference Guide vCenter Application Discovery Manager 6.1 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.
ADM Repository Reference 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 © 2010 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
Contents About This Book 5 1 Introduction 7 Overview 7 How Data Is Collected 7 Synchronizing the External Database 8 2 Set Up the External Reports Scheme Configuration Policy 11 Set Up and Monitor the External Reports Scheme Configuration Policy 11 Creating the External Reports Scheme Configuration Policy 11 Check the Status of the Synchronization Process 13 3 External Database Setup 15 External Database System Requirements 15 Minimum Hardware Requirements 15 Software Requirements 15 Installing and Con
ADM Repository Reference Guide Port 36 Property 37 Service 37 Storage_Device 38 Switch_Address_Forwarding 38 Time Dimension 39 Usage Metric 39 Usage_Metric_Baseline 40 Virtual_System_Settings 40 5 ADM Custom Reports 41 Creating Custom Reports 41 Host Inventory 41 Connection Inventory 41 Most Used Services 41 Application Dependency 42 4 VMware, Inc.
About This Book The VMware vCenter™ Application Discovery Manager (ADM) Repository Reference Guide provides information about setting up and configuring the ADM external repository. It describes the table structure and dependencies within the ADM external database and also illustrates the tables. To help you with the custom reports, the book provides examples of reports that can be generated from the ADM external database.
ADM Repository Reference 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 Introduction This chapter introduces the VMware vCenter™ Application Discovery Manager (ADM) repository and provides an overview that includes descriptions of data collection, table types, and key fields. This chapter includes the following topics: “Overview” on page 7 “Synchronizing the External Database” on page 8 Overview The ADM provides standard reports based on the data collected and stored in the ADM Repository.
ADM Repository Reference Guide Figure 1-1. Collection, Management, and Storage of ADM Data Discovery Management Database passive detail The data stored in the ADM database cannot be customized or manipulated for creating custom reports. Therefore, ADM provides functionality for exporting the data into an ADM external repository, from which custom reports are created. The data transferred to the external repository is not real‐time data.
Chapter 1 Introduction 4 The system running the external database periodically checks the FTP server for data files based on the synchronization schedule defined on the external database system. 5 When a data file is found, the following process takes place on the external database system: a The latest Zip file is downloaded. b The Zip file is extracted to the decompressed .csv data files. c The database loading is performed using the database specific loader.
ADM Repository Reference Guide 10 VMware, Inc.
2 Set Up the External Reports Scheme Configuration Policy 2 The ADM Console provides the necessary functionality to: “Set Up and Monitor the External Reports Scheme Configuration Policy” on page 11 “Check the Status of the Synchronization Process” on page 13 Set Up and Monitor the External Reports Scheme Configuration Policy The External Reports Scheme Configuration policy defines the FTP site where the database files are sent and how often extraction is performed.
ADM Repository Reference Guide 3 In the Publisher tab, enter the FTP site to which the data files are published as shown below. where: Target Host — the system hosting the FTP server. Target Directory — the directory on the FTP server host to which the files are sent. User Name — the name of a user with access to the FTP server. Password — the password associated with the user name.
Chapter 2 Set Up the External Reports Scheme Configuration Policy 3 Enter the time of day the synchronization occurs. In the above example the synchronization automatically begins every Saturday at 11:00 A.M. 4 Click Update to save the setting. Running the Synchronization Process Now To start the synchronization process on demand After creating the External Reports Scheme Configuration policy, click Complete Synchronization under the Actions menu in the left pane.
ADM Repository Reference Guide 14 VMware, Inc.
3 External Database Setup 3 To use the external database functionality you need to perform the following steps: “External Database System Requirements” on page 15 “Installing and Configuring the External Database for Oracle” on page 16 “Installing and Configuring the External Database for MS SQL” on page 20 “Manually Loading Data to the External Database” on page 23 “Checking the Status of the External Database Load Process” on page 24 “Upgrading the External Database” on page 24
ADM Repository Reference Guide Perl with the Archive::Zip module: Perl is bundled with RHEL 4.0, but the Archive::Zip module for handling Zip files needs to be installed manually. To verify that the Archive::Zip module is loaded, run the following: perl -MArchive::Zip -e 'print' If the result is: Archive::Zip module is installed, then the module is installed correctly. If the result starts with: canʹt find Archive/Zip, then it is not installed.
Chapter 3 External Database Setup Create the External Reporting Database User To create an external reporting database user NOTE You must have database administrator permissions to create an adm_olap user and have $ORACLE_HOME/bin dir in the PATH to install and configure the host on which the external database is installed.
ADM Repository Reference Guide Configure the Synchronization Process To configure the synchronization process 1 Configure the sync.properties file located in the adm_olap directory: NOTE An example file, sync.properties.example, is provided in adm_olap, to use as a template to configure the synchronization process. a Make a copy of the sync.properties.example file and name it sync.properties: cp sync.properties.example b sync.properties Modify the following information in the sync.
Chapter 3 External Database Setup b If you had defined a custom adm_olap user name and password when you had created the database user as described in “Create the External Reporting Database User” on page 17, then change the user name and password credentials accordingly: user.id=adm_olap/adm_olap c Change the delete.data.files parameter to =true if you want to delete the data files after they are loaded.
ADM Repository Reference Guide Installing and Configuring the External Database for MS SQL Use the following procedures to install and configure the external database for MS SQL. Install the Client-Side Scripts To install the client-side script NOTE You must have administrator privileges to install the client‐side scripts on Windows. 1 Copy the ADM external database installation file (adm_olap_v.X.X-XXX.zip) from http://downloads.vmware.com/Application Discovery Manager. 2 Unzip the adm_olap_v.X.X-XXX.
Chapter 3 External Database Setup Configure the Synchronization Process To configure the synchronization process 1 Configure the sync.properties file located in the unzip_path/adm_olap directory. NOTE An example file, sync.properties.example, is provided in unzip_pathadm_olap to use as a template for configuring. a Make a copy of the sync.properties.example file and name it sync.properties: copy sync.properties.example b sync.properties Modify the following information in the sync.
ADM Repository Reference Guide 2 Configure the database loader for MS SQL Servers. The SQL Server loader script is configured using the sqlserver.properties file, that is located in the unzip_path/adm_olap/load/ directory. An example file, sqlserver.properties.example, is provided in unzip_path/adm_olap/load/: a Make a copy of the sqlserver.properties.example file and name the file as sqlserver.properties. b Change the delete.data.
Chapter 3 External Database Setup f Select how often you want to run the task from the options and click Next. g Depending on the interval selected, define the time, days, and the date to start the task. h Enter the user credentials of the host administrator to ensure that environment settings are configured correctly. i If the user name and password is recognized, a message is displayed confirming the task has been scheduled.
ADM Repository Reference Guide Checking the Status of the External Database Load Process Use the following log files to check the status of the load process to the external database: For Oracle, check: /unzip_path/adm_olap/load/oracle/log For MS‐SQL, check: unzip_path\adm_olap\load\sqlserver\log Upgrading the External Database IMPORTANT The upgrade process requires a complete uninstall of the existing database version and an installation of the new database version.
Chapter 3 External Database Setup 7 Proceed with the installation instructions in “Installing and Configuring the External Database for MS SQL” on page 20. CAUTION Do not copy the new configuration files over the backed up configuration files. Only use the backed up configuration files as a reference to manually update the new file.
ADM Repository Reference Guide 26 VMware, Inc.
4 ADM ERD Schema 4 This chapter illustrates the table structure and dependencies within the ADM external database.
ADM Repository Reference Guide Overview of External Database Tables This chapter provides information about the external database tables. Database Structure and Dependencies Figure 4‐1 illustrates the structure and dependencies of the ADM external database. Arrow heads are used to identify the table keys. It is important to note that some of the commonly accessed data is duplicated in many tables to avoid unnecessary joins. For display purposes, some data is aggregated to a comma‐separated list.
Chapter 4 ADM ERD Schema Figure 4-1. External Database Structure and Dependencies VMware, Inc.
ADM Repository Reference Guide Address This table identifies information of a network element consisting of the host name, IP address, and MAC address if known. Table 4‐1 lists the contents of the Address table. Table 4-1.
Chapter 4 ADM ERD Schema Table 4-3. CPU Table (Continued) Name Datatype Description VENDOR VARCHAR2 FAMILY VARCHAR2 CLOCK_SPEED_HZ NUMBER Max clock speed in Hertz CACHE_SIZE NUMBER Cache size in Bytes STEPPING VARCHAR2 Identifies the type and version of the CPU. DESCRIPTION VARCHAR2 COUNT NUMBER Number of processors of this type Where: ID is a Primary key NE_ID is a Foreign key Database This table contains database server and instance information.
ADM Repository Reference Guide Table 4-5.
Chapter 4 ADM ERD Schema Table 4-6.
ADM Repository Reference Guide Table 4-8. IP_Route Table Name Datatype Description DEST_MASK VARCHAR2(100) Destination Mask GATEWAY VARCHAR2(100) Gateway IP METRIC NUMBER(10) IS_LOCAL VARCHAR2(1) Y/N GATEWAY_NE_ID NUMBER(19) Gateway Network Element Where: ID is a Primary key NE_ID, NIC_ID, and GATEWAY_NE_ID are Foreign key Java_EE This table contains Java Enterprise Edition components: Application Server, JEE Application, and modules (jar, war, ear, etc).
Chapter 4 ADM ERD Schema Table 4-10. Network_Element Table (Continued) VMware, Inc. Name Datatype Description HOSTNAMES VARCHAR2(4000) Comma‐separated list of all hostnames HOST_IPS VARCHAR2(4000) Comma‐separated list of all IP addresses GROUPS VARCHAR2(4000) Comma‐separated list of all groups the element belongs to.
ADM Repository Reference Guide Where: ID is a Primary key IS_VIRT_CONTAINER and IS_VIRTUAL are Foreign key (New in 6.0 and later versions) Network_Interface This table identifies a network interface card or a switch port. Table 4‐11 lists the contents of the Network_Interface table. Table 4-11.
Chapter 4 ADM ERD Schema Where: ID is a Primary key NE_ID and SERVICE_ID are Foreign keys Property This table contains general purpose properties (name‐value pairs), such as URLs on http‐servers and tables on database‐related dependencies. Table 4‐13 lists the contents of the Property table. Table 4-13.
ADM Repository Reference Guide Table 4-14. Service Table (Continued) Name Datatype Description SHARED_INSTALL_PATH VARCHAR2(512) Shared installation path. IS_UNIDENTIFIED VARCHAR2(1) Indicating this is a placeholder for an unidentified service (values: Y/N). IS_CLIENT VARCHAR2(1) Indicating a client service (values: Y/N). KNOWLEDGE_LEVEL NUMBER(10) Indicates the level of knowledge of the service.
Chapter 4 ADM ERD Schema Table 4-16. Switch_Address_Forwarding Table Name Datatype Description MAC VARCHAR2(100) Forward MAC address V_LAN NUMBER(10) Virtual LAN TRG_NE_ID NUMBER(19) Forward network element Where: ID is a Primary key NE_ID, NIC_ID and TRG_NE_ID are Foreign keys Time Dimension This table provides the time dimension. Table 4‐17 lists the contents of the Time dimension table. Table 4-17.
ADM Repository Reference Guide Where: ENTITY_ID is a Foreign key (network_element service, dependency (id)) TIME_ID is a Foreign key (time (time_id)) BASELINE_TIME_ID is a Foreign key (usage_metric_baseline (baseline_time_id)) Usage_Metric_Baseline This table describes the baseline usage, composed of the entityʹs usage metric accumulated within the first 24 hours since detected by the system. Table 4‐19 lists the contents of the Usage_Metric_Baseline table. Table 4-19.
5 ADM Custom Reports 5 This chapter provides information on “Creating Custom Reports” on page 41. Creating Custom Reports Most reports are generated from the four core tables demonstrated in Figure 4‐1. The reports cover inventory, dependency, and usage. The rest of the data is joined for special reports without much complication. The following are examples of reports that are generated from the ADM external database.
ADM Repository Reference Guide Application Dependency For the specified Business Application, this report shows each host and service the application depends on and each host and service that depends on it (if any): select distinct 0 as degree, grp.group_name, service.name, service.version, service.vendor, service.category, service.primary_host_ip, service.primary_hostname, service.discovery_time from dependency dep inner join group_membership grp on grp.entity_id = dep.
