Application Discovery Manager Repository Reference Guide vCenter Application Discovery Manager 6.1.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 35 Property 35 Service 36 Storage_Device 36 Switch_Address_Forwarding 37 Time 37 Usage_Metric 38 Usage_Metric_Baseline 38 Virtual_System_Settings 38 5 ADM Custom Reports 41 Creating Custom Reports 41 Host Inventory 41 Connection Inventory 41 Most Used Services 41 Application Dependency 42 Index 43 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 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. Performance and Scalability The following steps indicate the amount of time required to complete each process: Extraction and flat file creation: This step utilizes the ADM resources to the maximum.
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 23 “Upgrading the External Database” on page 24
ADM Repository Reference Guide 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 sync.properties b In the sync.properties file, modify the FTP information.
Chapter 3 External Database Setup 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. If you keep the default, you need additional dataspace than defined in “External Database System Requirements” on page 15: delete.data.files=false 3 Load the time data. The current adm_olap schema has a time dimension table that is static. Fill the time table once and leave it unchanged thereafter.
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 sync.properties b In the sync.properties file, modify the FTP information.
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 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. j Select Open advanced properties for this task when I click Finish option. k Click Finish. l From the Windows Start menu, navigate to Setting > Control Panel > Scheduled tasks. m Right‐click the task and click Properties.
ADM Repository Reference Guide 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. Perform the following steps to upgrade the external database.
Chapter 3 External Database Setup Upgrading for Oracle When upgrading the external database for Oracle: 1 Ensure the sync_adm_olap task is removed from the cron job as follows: a At the command prompt, type: crontab -e b Delete the task from the file. c Save and exit. 2 Log in to the ADM Console as admin user. 3 From the ADM Console, navigate to Connectors > Reports > External Reports Scheme Integration Status and check if the Synchronization Status is complete.
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. The arrows originate from a foreign key and arrow head points to the table keys. Figure 4-1. External Database Structure and Dependencies ADM_OLAP.
Chapter 4 ADM ERD Schema Address Address table contains information about a network element consisting of the host name, IP address, and MAC address. Table 4‐1 lists the contents of the Address table. Table 4-1.
ADM Repository Reference Guide Table 4-3. CPU Table (Continued) Name Datatype Description DESCRIPTION VARCHAR2(256) Name of the processor COUNT NUMBER(10) Processor count detected by the operating system (multi‐core CPU is usually detected by the operating system as several separate CPUs) Database Database table contains database server and instance information. Several instances might exist for each server. Table 4‐4 lists the contents of the Database table. Table 4-4.
Chapter 4 ADM ERD Schema Table 4-5.
ADM Repository Reference Guide Installed_Software Installed_Software table contains the information of software installed on a network element. Installed software can appear as both installed software and as a service on the network. Software information might also exist in the service table. Table 4‐7 lists the contents of the Installed_Software table. . Table 4-7.
Chapter 4 ADM ERD Schema Java_EE Java_EE table contains Java Enterprise Edition components such as Application Server, JEE Application, and modules (jar, war, ear, and so on). Table 4‐9 lists the contents of the Java_EE table. Table 4-9.
ADM Repository Reference Guide Table 4-10.
Chapter 4 ADM ERD Schema Table 4-11.
ADM Repository Reference Guide Service Service table contains information about a software service running on the network element (usually exposed through a network port). Table 4‐14 lists the contents of the Service table. Table 4-14.
Chapter 4 ADM ERD Schema Table 4-15.
ADM Repository Reference Guide Usage_Metric Usage_Metric table is a multi‐dimensional OLAP fact table for capturing the demand of Dependency, Service, and Network Element. The granularity of the data is of a single hour. Together with the time table and the related entities, it is sliced and diced as needed. Table 4‐18 lists the contents of the Usage_Metric table. Table 4-18.
Chapter 4 ADM ERD Schema Table 4-20. Virtual_System_Settings Table (Continued) VMware, Inc.
ADM Repository Reference Guide 40 VMware, Inc.
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.
Index A S ADM components 7 scheduling 12 SFTP 12 software requirements 15 status of the load process 23 synchronizing the external database 8 C configuration 16 for MS SQL 21 for Oracle 18 custom reports 41 T table join 28 D database dependencies 28 database structure 28 E U upgrading the external database 24 for MS SQL 24 for Oracle 25 ERD schema 27 external database 28 external reports 11 F flat file creation 9 foreign key 28 FTP 8, 11 H hardware requirements 15 I installation 16 for MS SQL 2
ADM Repository Reference Guide 44 VMware, Inc.
