1. Manuals
  2. Brands
  3. VMware Manuals
  4. Software
  5. VCENTER APPLICATION DISCOVERY MANAGER 6.1.1 -...
  6. Administration manual

VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1.1 Administration Manual

Hide thumbs Also See for VCENTER APPLICATION DISCOVERY MANAGER 6.1.1:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Reference Manual, User Manual
Application Discovery Manager
Administration 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.
EN-000451-01

Advertisement

Table of Contents
loading

Related Manuals for VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1.1

Summary of Contents for VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1.1

  • Page 1 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. EN-000451-01...
  • Page 2 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.

  • Page 3: Table Of Contents

    Installing the vSphere Client 16 Disabling vMotion 16 Preparing the Environment 17 Preparing an ESX Configuration 17 Deploying the Virtual Appliances 18 Deploying the ADM Virtual Appliances 19 Installing Windows Collector 20 Setting Up ADM 23 Process 23 Order of Setup 23 ADM Setup Procedures 23 Launching the First Boot Configuration Tool 24 Configuring the Root Password 24 Configuring Static Network Settings 25 Configuring the Timezone and Time 25 Configuring the Appliance Role 26 Post‐Installation Steps 27 Logging In to the ADM Console 27 Initiating Passive Discovery 27 VMware, Inc.
  • Page 4 Post‐Upgrade Steps 43 Migrating to a New Appliance 45 Overview 45 Supported Migration 45 Licenses 45 System Architecture 45 Process 46 Preliminary Procedures 46 Data Restoration 47 Single‐Box Solution 47 Distributed Solutions 47 Distributed Solution with Remote Database 48 Post‐Migration Steps 48 Troubleshooting ADM 49 Troubleshooting ADM by Using the Product Support Package 49 Troubleshooting Error Messages During WMI Discovery 49 Detail Discovery Troubleshooting 49 Using ADM Console 50 WMI 50 VMware, Inc.
  • Page 5 Contents single.sh 50 snmpdump 53 nlcapture 53 Uninstalling ADM 55 Uninstalling the ADM Appliance 55 Time Zones 57 ADM API Tutorial 59 API Features 59 Insight_control 59 Asynch API 60 Dump API 60 Bulk API 61 Web Services API 61 Index 63 VMware, Inc.
  • Page 6 Application Discovery Manager Administration Guide VMware, Inc.

  • Page 7: About This Book

    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. The installation procedures in this document must be performed by IT professionals familiar with  virtualization and VMware technologies such as VMware ESX™ servers and related virtual and physical  equipment. VMware Technical Publications Glossary VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions  of terms as they are used in VMware technical documentation go to http://www.vmware.com/support/pubs. Document Feedback VMware welcomes your suggestions for improving our documentation. If you have comments, send your  feedback to docfeedback@vmware.com. Technical Support and Education Resources The following sections describe the technical support resources available to you. To access the current version  of this book and other books, go to http://www.vmware.com/support/pubs. Online and Telephone Support To use online support to submit technical support requests, view your product and contract information, and  register your products, go to http://www.vmware.com/support. Customers with appropriate support contracts should use telephone support for the fastest response on  priority 1 issues. Go to http://www.vmware.com/support/phone_support. Support Offerings To find out how VMware support offerings can help meet your business needs, go to ...
  • Page 8 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. To access information about  education classes, certification programs, and consulting services, go to http://www.vmware.com/services. VMware, Inc.

  • Page 9: Overview

    Overview This chapter describes the different VMware vCenter Application Discovery Manager (ADM) architecture  solutions and configuration. This chapter includes the following topics:  “System Architecture” on page 9  “Virtual and Physical Appliance Solutions” on page 11  “vCollector” on page 12  “Mixed Environment” on page 13  “Where To Go Next” on page 13 System Architecture The ADM provides system architecture solutions to meet the requirements of different environments as  shown in Figure 1‐1. Figure 1-1. ADM Components Passive Discovery Active Database Aggregator Discovery-Unix Active Discovery-Windows VMware provides ADM on one or more appliances. The mode of the appliance determines which component  is running. ADM components are described in Table 1‐1. VMware, Inc.
  • Page 10 ADM VM2 Role = single-box Role=Windows collector (running Win2008 Aggregator on any ESX) Active Discovery- Database Windows Active Discovery- Unix Passive Discovery Runs on (Virtualization) Logical monitoring Physical Physical port connectivity switch 1 switch 2 ADM Connectivity Chapter 3 provides the configuration instructions.  VMware, Inc.

  • Page 11: Distributed Appliance Solutions

    ESX) Logical monitoring switch 1 switch 2 port connectivity Active Discovery- ADM Connectivity Windows    In a Distributed with remote database setup, there is a designated appliance to host the database. Also,  Passive and Detail Discovery can run on single or multiple Collectors. Virtual and Physical Appliance Solutions You can set up ADM either:   On your ESX or ESXi servers as described in “Virtual Appliance Deployment” on page 11  On existing IBM physical appliances, only upgrading is supported as described in “Upgrading ADM” on  page 13. Virtual Appliance Deployment ADM version 6.1.x is delivered as VA, which is a virtual machine image that includes an operating system and  the relevant ADM software components installed on it. A VA can run one or multiple ADM components  depending on the appliance role selected. Deploying a virtual machine template in an Open Virtualization Format (OVF) onto the ESX or ESXi server  creates an ADM Virtual Appliance. After deployment, power up the VA and then configure the standard  appliance settings, network, and user information.  VMware, Inc.

  • Page 12: Physical Appliance Deployment

    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.  Collector ADM Template: A smaller OVF template that includes the Passive Collector and Active and  Passive Collector and you can configure as passive and active discovery Collector and Passive Discovery  Collector.  Windows Collector Installer: An executable file that installs the Windows Collector component on top of  the Windows 2008 R2 operating systems. Physical Appliance Deployment ADM supports the upgrading of existing IBM single box and Distributed solutions (including those that use  a remote database). Mirrored Network Traffic The method in which the appliance performs passive discovery is by analyzing mirrored traffic from a switch  or router. Network devices that have the ability to configure a mirrored port (sometimes called as a Switched  Port Analyzer, span port or monitor port) can forward a copy of all the network traffic from all (or selected)  ports to one or more mirrored ports. Typically, each network device has all its ports mirrored to one port. These  mirrored ports are then connected directly to one of the network interfaces on the ESX server.     Consult IT professionals of your organization to ensure that the appropriate switches or routers  MPORTANT that contains the network traffic is used for Discovery are configured properly for port mirroring and are  accessible to the ADM appliance. Perform one of the following steps if you have to connect multiple monitor ports:  Connect the monitor ports to an aggregate switch (A‐Switch), which is also configured with a monitor ...

  • Page 13: Mixed Environment

    Chapter 1 Overview Mixed Environment The ADM 6.1.x 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.1.x appliances  like mixed environment. This additional virtual appliance can play a role of Passive Collectors (vCollectors)  or an additional Passive and Active Collectors.    All ADM appliances that participate in mixed environemnt mode must run the same 6.1.x version of  the ADM. Where To Go Next This section provides links that contains more information on the topics listed. Installation of New or Additional ADM Components Continue by configuring initial appliance settings as described in Chapter Licenses You need a new license to use ADM after upgrading or migrating. Obtain the license from your VMware Sales  representative. For more information, see “Licenses” on page 39. Upgrading ADM Continue with upgrade procedures as described in Chapter Migrating to a New Appliance Continue with migration procedures as described in Chapter Security For more information on ADM security, see Chapter VMware, Inc.
  • Page 14 Application Discovery Manager Administration Guide VMware, Inc.

  • Page 15: Installing Adm

    Configure the virtual machine on your ESX server according to the deployment model with resources as  described in Table 2‐1. Table 2-1. Virtual Appliance Deployments ADM Virtual Appliance (VA) Memory (GB) Number of vCPUs NICs Disk (GB) OVF Template Single‐Box Core  Aggregator + DB Core  Aggregator Core  Database Core  Passive Collector  Collector  Linux Active + Passive Collector Collector  Windows Active Discovery  Collector    VMware provides WinApe installer instead of OVF template for Windows 2008 R2 (Datacenter,  Enterprise, and Standard) operating systems that hosts the WinApe. VMware, Inc.

  • Page 16: Installing The Vsphere Client

    To download and install the vSphere Client Launch Internet Explorer browser.    ADM supports Windows Internet Explorer 6.0 and later browsers. In the address bar, type the IP number of the ESX Server where the virtual machine is installed, for  example: https://ESX Server IP Click the Download vSphere Client link, and then save the client executable file to your local hard disk.  Run the executable file. Accept the license and click Next. Type the user name and organization details if they do not appear by default. Click Next. At the next screen, click Next without selecting Install vSphere Host Update Utility.  If different from the default, specify the installation folder, and then click Next.  Click Install.    The vSphere client installation can take several minutes. 10 Click Finish to close the wizard. Disabling vMotion    ADM virtual appliances are not supported by vMotion. If the ADM virtual appliance is installed  MPORTANT on a VMware DRS cluster, perform the following steps to disable automatic vMotion. To disable automatic vMotion In the vSphere client, select the cluster, right‐click on it and select Edit Settings. In the VMware DRS section, select Virtual Machine Options. Select the ADM virtual appliances. Select Disable from the Automation Level list box. Click OK. VMware, Inc.

  • Page 17: Preparing The Environment

    To configure the vSwitch general settings for Passive Discovery Open the new vSwitch Properties window. Select the vSwitch and click Edit. Navigate to the Security tab and change the Promiscuous Mode from Reject to Accept and click OK. Click the network adapters tab, select the relevant vmnic and click Edit. Change the Configured Speed, Duplex to 10 MB, Full Duplex.  Click OK and then Close. Configuring the vSwitch for Passive Collector Connect the Passive Collector to a port group. To define a port group Create a port group in the vSwitch as follows: Log in to the ESX Server or vCenter using vCenter Client. The Virtual Infrastructure Client screen  appears. Click the Configuration tab.  Select Networking from the Hardware list.    Perform the following steps to connect to vSwitches that span the internal traffic  MPORTANT between virtual machines running on the ESX Server. From the preceding screen, select Properties. Select Ports and click Add. Select Virtual Machine and click Next. VMware, Inc.

  • Page 18: Deploying The Virtual Appliances

    2‐2. Table 2-2. VLAN Support Parameter Value Specified Name A name for port group (ADM span port). The name must be same as in vSwitch procedure. Number of ports One for each ESX in data center VLAN type VLAN Trunking VLAN ID 0‐4094 Click Next to finish and return to the dvSwitch Network Configuration screen. Select the ADM span port group and click Properties. Click the Security tab on the ADM span port Properties window. Select Promiscuous Mode, and then select Accept from the list box. 10 Click OK and then Close. Deploying the Virtual Appliances The ADM virtual appliance contains and runs one or more of the following components:  Aggregator  Database  Active Discovery UNIX  Passive Discovery “System Architecture” on page 9 describes the appliance architecture.  Perform the following procedures by using a Windows machine with remote access to the ESX server. VMware, Inc.

  • Page 19: Deploying The Adm Virtual Appliances

    Passive Discovery Passive and Active  ADM Collector UNIX Active and Passive Discovery Discovery Collector    Install a separate Windows Collector using an installation wizard as described in “Installing Windows Collector” on page 20.    Performance of ADM Collectors is affected by distance and network latency between the  MPORTANT Collectors and objects being discovered. For more information, see VMware vCenter Application Discovery  Manager Peformance and Scalability Guide. Before You Begin Ensure all requirements are met as described in “ESX Resources” on page 15.    You can deploy ADM components in any order or even simultaneously by using the vSphere client. Deployment Procedure Repeat the following steps on each ADM virtual appliance, except the Windows Collector that is installed  separately as described in “Installing Windows Collector” on page 20: Download the ADM virtual appliance files from VMware Web site and extract the files to a local folder.  The extracted Zip files include an OVF and a VMDK file. The VA files are in Zip format with the following naming convention: OVF Template‐build number where:  OVF Template is as described in Table 2‐3.  build number is the ADM version and build number.    Ensure that the build number is identical for all appliances deployed. MPORTANT Log in to the ESX server by using the vSphere client.    If an SSL Certificate Warning message appears, click Ignore.  In the File menu, select Deploy OVF Template. Browse to the OVF file and select it.  VMware, Inc.

  • Page 20: Installing Windows Collector

    11 Click Close in the message dialog box when deployment successfully completes. Repeat this procedure until all components are deployed, and then continue with “Installing Windows  Collector” on page 20. Installing Windows Collector Before You Begin Ensure that the Windows machine on which the Collector is being installed meets the minimum requirements  as described in “ESX Resources” on page 15. Deployment To deploy Windows Collector on a Windows machine Download the VMware vCenter ADM Windows Collector executable file from VMware Web site to your  local Windows machine. Double‐click the executable file.     If a warning appears about an unknown publisher, click Run to proceed.  The InstallShield Wizard screen appears. Click Next. The License Agreement screen appears.     Use the scroll bar to view all of the license text. If you do not want to accept the license, you will  be prompted to confirm this before the installation program closes. Read the license, select I accept the terms of the license agreement, and click Next. The Choose  Installation Folder screen appears.     The default installation path is: C:\Program Files\VMware\ADM. If you want to change the default installation location, click Change and select the preferred installation  directory. Click Next. The Host Information screen appears. VMware, Inc.
  • Page 21 Chapter 2 Installing ADM Type the following information to configure the Windows Collector:  Aggregator IP Address  Windows Collector unique ID    This is the same identifier that was defined on the Aggregator side for WMI discovery. The  default value is 200.  Click Next. The Installation screen appears.  Click Install to begin the installation.    The process of installing and configuring the Windows Collector can take several minutes. 10 Click Finish to close the InstallShield Wizard screen when the installation process is complete. Uninstall To uninstall the ADM Windows Collector Open the Windows Control Panel. In the Control Panel window, select Program > Uninstall a Program. The Uninstall or change a porgram  screen appears. Double‐click or right‐click and select Uninstall to initiate removal of the ADM Windows Collector.    The removal of the Windows Collector can take several minutes. Click Finish to close the InstallShield Wizard screen when the uninstallation process is complete. VMware, Inc.
  • Page 22 Application Discovery Manager Administration Guide VMware, Inc.

  • Page 23: Setting Up Adm

    “Order of Setup” on page 23.  “ADM Setup Procedures” on page 23  “Configuring the Root Password” on page 24  “Configuring Static Network Settings” on page 25    ADM only supports using a static IP address for the ADM virtual machine.  “Configuring the Appliance Role” on page 26   “Uploading a License” on page 40 Order of Setup Repeat the setup procedures for all ADM components in the following order for all virtual appliances:  Database (where remote database is used) Aggregator Collectors (Passive, Active and Passive Collector) The Windows Collector is set up as described in “Installing Windows Collector” on page 20. ADM Setup Procedures Before you begin ensure that you have performed the following. Ensure all relevant components are deployed as described in “Deploying the Virtual Appliances” on  page 18. Obtain the required information for each appliance deployed in Step 1 and record these values as shown  in Table 3‐1. VMware, Inc.

  • Page 24: Launching The First Boot Configuration Tool

     right‐clicking and selecting Power > Power On    Status of various tasks appear in the Recent Tasks pane on the bottom of the vSphere Client main  screen. Right‐click the relevant appliance and select Open Console tab to monitor this procedure. The appliance and relevant services start up. A Welcome message for the ADM first boot configuration  tool (wizard) appears.  To launch the tool and configure the initial appliance settings, type yes. The wizard asks you to change  the default password. You can change the default password by following the instructions described in  “Configuring the Root Password” on page 24.      If you type no for the initial appliance settings message, you can run the initial configuration later by  running the system_setup command.    If you type no for the change password message, the wizard prompts you to add network information.  You can add the network information as described in “Configuring Static Network Settings” on page 25. Configuring the Root Password Perform the following procedure to change the root password. User Name and Passwords Passwords must contain a minimum of eight characters and it is recommended to include the following  character types:  numeric  uppercase  lowercase  non‐alphanumeric such as # or ! VMware, Inc.

  • Page 25: Configuring Static Network Settings

    CLI prompt Notes and Values IP address  Type the IP address. Netmask Type the netmask. Gateway Type the gateway. DNS  Type the DNS. Hostname  Fully qualified hostname to be used by ADM, for example  localhost.localdomain.com If all the network information is correct, the wizard prompts you to set up the timezone. You can set up the  timezone as described in “Configuring the Timezone and Time” on page 25. Configuring the Timezone and Time This prompt asks you to set up the timezone, type yes. The wizard displays the current timezone and prompts  you to set up the time zone by clicking the number of your choice. The options available are as follows: From zone list: If you select 1, all possible zones are listed and you can enter the number of timezone that  you want to set. The wizard displays the selected timezone and asks for confirmation. If you type yes, the  timezone is selected and a message to set up the local time appears. Manually: If you select 2, a message that asks you to enter major world city in continent/city format  appears. Enter the details as per the format and press Enter. If the timezone entered is present in the  database, the timezone is selected and a message to set up the local time appears. Exit TimeZone settings: If you select 3, the wizard exits the timezone configuration and a message to set  up the local time is displayed. For more information about timezones, see Appendix A, “Time Zones,” on page 57. The wizard displays the current time and asks to set up the local time. Enter the current date and local time in  YYYY/MM/DD‐HH:MM:SS format, and press Enter. VMware, Inc.

  • Page 26: Configuring The Appliance Role

    Remind me later Skips appliance role configuration for now. You must run the role_setup  command to set up the appliance role. To configure the appliance role for Core Type yes at the appliance role prompt and press Enter. Type the role number and press Enter.    If you select 4, the wizard also asks to enter the database IP. The wizard starts configuring appliance role and creates the initial database schema. This process might take  some time. The appliance role is then created. This process might take some time. For Collector appliances deployed in “Deploying the Virtual Appliances” on page 18, the appliance role  choices are shown in Table 3‐4. Table 3-4. Collector Appliance Roles Select Role Configures Passive and Active  Single Collector for active and passive discovery Discovery Collector Passive Discovery  This option also configures Passive Collector Internal. Collector  Remind me later Skips appliance role configuration for now. You must run the role_setup  command to set up the appliance role. VMware, Inc.

  • Page 27: Post-Installation Steps

    After you complete the appliance installation, login to the system by using the browser and perform the  following steps: Type the IP address of the management appliance in the address bar and click Go. The login screen  appears. Type admin in the Username field and default password 123456 in the Password field.  Click Login.    You might be required to upload a new license. Before proceeding, review the criteria and  MPORTANT if necessary, perform the steps described in“Licenses” on page 39. Initiating Passive Discovery Only one Passive Discovery Policy Definition is present in the ADM. The first time you use ADM, you must  set up the policy definition and start it. To initiate Passive Discovery Click Manage, and then select the Passive Discovery menu.  Select the components on which ADM performs Passive Discovery from the Scope Component field. Based on your selection, type the appropriate IP information:  IP range: Use Notation to type a group of hosts with similar IP addresses. For example, 192.0.2.*  includes all hosts with IPs starting with 192.0.2. You can also search all hosts by typing an asterisk in  each field. Use IP range to include a group of hosts within a defined IP range.  IP: Add a single specific host to the group to include or exclude from the scope.  Subnet NetMask: Configure the IP address scope by providing the base network address with the full  dotted decimal notation for the subnet mask,  Subnet Slash Notation: Configure the IP address scope by providing the base network address with  the Classless Inter‐Domain Routing (CIDR) notation for the subnet mask. Click Include to include the components in the discovery or Exclude to exclude them from it. Repeat Step 2 through Step 4 for each component that you are including or excluding from discovery. VMware, Inc.
  • Page 28 Application Discovery Manager Administration Guide Optionally, use the rules and rule templates to further define the scope criteria:  Y: Instructs ADM to include the components in the Passive Discovery.   N: Excludes the components from discovery.  I: Allows you to ignore the rule. If you select a rule template, click the blue link to customize the rule.  Click Update to save the settings. Optionally, add a Passive Discovery Plan. 10 Restart Passive Discovery. Navigate to the Manage > System page, and click Restart Discovery. 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. The VMware vCenter Application Discovery Manager User’s Guide  provides an overview of Passive Discovery, and the online help provides more detail on the actions that  you can perform. VMware, Inc.

  • Page 29: Securing Adm

    Changing the Root Password To change the root password Log in to the ADM appliance by using a Secure Shell (SSH) client. Run the passwd command: The wizard asks to enter a new password. Retype the password. If both the passwords match, the password is changed and all authentication tokens gets updated. Resetting the ADM Root Password To reset the ADM root password Using the VMware vSphere client, start or restart the virtual machine. After the virtual machine restarts, click any key in the console window.    If you do not click any key in the console window immediately after the virtual machine restarts,  you must restart the virtual machine and perform step 2 again. To give you additional time when clicking a key in the console window, you can manually add a line to  the VMX file. Adding the line to the file causes the BIOS to delay. For example, to cause a 10 second delay,  power down the virtual machine, open the VMX file in a text editor, type the following line in the VMX  file: bios.bootDelay="10000" The boot screen appears.  Press e to enter the GRUB boot menu. The GNU GRUB loader screen appears. Highlight (2.6.24.7‐9.smp.pae.gcc3.4.x86.i686), and press e. Select the kernel line and press e to edit the entry. VMware, Inc.

  • Page 30: Openssl Self-Signed Test Certificates

    The VMware vCenter Application Discovery Manager default installed certificate is created during the  installation and is valid for one year to use the appliance until you acquire a local Certificate Authority (CA).  Public‐facing secure Web sites must use a third‐party CA. If you want to use the appliance in test environment  and then deploy that appliance to a production environment, you must not change the hostname as the ADM  does not support changing the hostname. Instead, you can set up an alias in the DNS to resolve the appliance  hostname. CA Signed Test Certificates To create CA signed certificates, you must generate a certificate request file (csr). The certificate request file  provides details about the requester of the certificate and the certificate is signed by the private key above to  your trusted certificate authority. Create the certificate request by typing: openssl req -new -key server.key -out server.csr Fill in the X.509 attributes as specified previously. For more details consult your CA. To install the certificate provided by your CA, perform the steps described in “Copying the .key and .crt Files”  on page 31. Free CA providers, as http://www.cacert.org exist. Self-Signed Certificates Use self‐signed certificates only in the test environments, or where only a limited number of connections is  established. For example, peer‐to‐peer relationships can be a custom VPN or AS2 link between two companies,  or between two different sites of the same company. Self‐signed certificates become impractical as the number  of certificates necessary to manage grows linearly with the number of peering relationships. A local CA, while  more complex to setup, reduces the number of keys required to be distributed for verification, and replicates  a real‐world certificate environment. A CA can cost less to manage than hundreds or thousands of individual  certificates on each peer system.    Do not use the self‐signed certificates in production environments. Certificate creation requires the openssl utility. The openssl utility is located in the ADM appliance folder. /usr/bin/openssl VMware, Inc.
  • Page 31 Prompt Answer Country name (2 letter code) [AU]: State or province name (full name) [Some‐State]: Massachusetts Locality name (eg, city) [ ]: Boston Organization name (for example, company) [Internet Widgits Pty Ltd]: YourCompanyOrg Organizational unit name (for example, section) [ ]: ‐ Common name (for example, YOUR name) [ ]: hostname.domain E‐mail address [ ]: postmaster@yourcompany.org For web services, the common name field must exactly match the hostname (or VIP name, for hosts associated  with a load balancer) of the system certificate is used on; otherwise, a certificate to hostname mismatch can  occur. In peer‐to‐peer setups for AS2, this field can usually be set to a descriptive string. The certificate data in the server.crt file must be transferred to all client systems that need to verify the key  of the server to which it is connected. If this method does not scale, setup a CA, and distribute the signing  certificate to the clients instead of each self‐signed certificate. Optionally, you can extract the metadata. Copying the .key and .crt Files Type the following commands to copy the .key and .crt files: cp server.crt /etc/httpd/conf/ssl.crt cp server.key /etc/httpd/conf/ssl.key To make the certificate effective, restart the Apache service by typing adm_control.pl --restart apache VMware, Inc.
  • Page 32 Application Discovery Manager Administration Guide VMware, Inc.

  • Page 33: Maintenance

    Table 5-1. ADM Services Service name Description apache Web server service. active_probe Service responsible for performing Detail Discovery and runs on Linux Collectors and the Windows  virtual machine . This service performs:  WMI‐based discovery on the Windows Collector  SSH‐, SNMP‐, VI‐SDK‐, and Telnet‐based discovery on the UNIX Collector engine The core of ADM and includes the following components:  User interface  Management  Reconciliations  Analytic listener Service responsible for the Passive Discovery mechanisms. oracle  Database service. Physical IBM Collectors only. The vnc service enables VNC access to the Windows instance so that the IP address can be configured. vmware Physical IBM Collectors only. The Windows instance on the appliance is installed on a virtual machine. The vmware service starts  VMware so that the Windows instance can start. watchdog Service that monitors the health of the other services. If another service has a problem, watchdog  service tries to identify the service and resolve the problem. VMware, Inc.

  • Page 34: Product Support Packages

    Type the adm_control.pl command as demonstrated in Table 5‐2, for example: adm_control.pl --stop all All services that are listed in Table 5‐1 stop.  Product Support Packages Create the product support packages to back up, restore, or troubleshoot the ADM.  Product support packages contain a real‐time capture of the ADM database, configuration files, customization  files, and logs. Table 5‐3 describes the files the product support package contains and its use. Table 5-3. Product Support Packages Files and Uses File Database data Back up and restore of the ADM database. Active Probe and Passive Listener definition files Back up and restore of the required ADM configurations.  Detail discovery and Passive Discovery fingerprints Back up and restore of the custom ADM configurations. Logs Troubleshooting. License file Serial number used for managed server host. VMware recommends that you create and save a support package prior to performing any maintenance  procedures, such as an upgrade, restore, and fresh installations or before contacting VMware Customer  Support. Support packages are backups of the ADM and relevant configuration files. These packages contain  troubleshooting log files and are used to restore your ADM environment. VMware, Inc.

  • Page 35: Using The Adm Console

       The UI option is relevant only to the appliances with Aggregator component.  Log in to the ADM Console. Navigate to Manage > System > Create Product Support Package.  Wait for a few minutes and then refresh the page to see if the Status has changed from Pending to Success. Click the appropriate product support package Zip file displayed in the table and download it. By default, the filenames are listed from the most current back date. Each product support package Zip  filename includes the ADM database schema version, date, and timestamp for easy recognition.  Click Save.    By default, the ADM saves the product support packages only for seven days. Ensure to save to  the product support package to another location if you want to save the information for longer duration. Using the CLI Use the CLI to create support packages for each collector or database in a distributed ADM deployment, or for  the Aggregator, database, or Single‐Box deployment when the Aggregator is not available through the ADM  Console. Chapter 1 describes the different ADM deployment options: Log in to the Collector or Aggregator appliance as user root.    Log in to the Aggregator to create a backup of the ADM database. You are not required to login to  the remote database appliance to create a backup of the database files.  Change the directory to the /home/nlayers/Seneca/management/APIs directory. Type the following command: ./InSight_control.sh supportpackage --get --output filename filename.zip is created at the same location. Copy and save the zip file from the ADM appliance to a different location.    Ensure to save to the product support package to another location if you want to save the  information for longer duration. The ADM saves the package only for seven days if you select the default  location. VMware, Inc.

  • Page 36: Restoring An Adm Environment By Using A Product Support Package

    1 describes the different ADM deployment options: Log in to the Aggregator or Single‐Box appliance as user root.    Distributed deployment only: In a distributed deployment the database or remote database is  restored through the Aggregator.  Create a temporary directory: mkdir supportpackagedir Copy the support package into the temporary directory that you created in Step 2.  Extract the support package into the temporary directory:  unzip support_package__version_date_and_timestamp.zip where version_date_and_timestamp is the unique identifier of the package.  When prompted for the password, type the password you retrieved from VMware Customer Support.  After extraction completes, copy the database backup file:  supportpackagedir/supportpackage/backup.db_dump-main-db_schema_build-db_dump.gz where db_schema_build is the database schema version and build number. Place the copied file in the following directory: /home/nlayers/Seneca/Control/bin/home/nlayers/Seneca/db_scripts/oracle Type the following command to stop the engine service: /adm_control.pl --stop engine Type the following command to switch to the nlayers user: su - nlayers 10 Change directory to: cd /home/nlayers/Seneca/db_scripts/oracle 11 Type the following command to restore the db backup: ./db_restore.sh backup.db_dump-main-db_schema_build-db_dump.gz prod where db_schema_build is the database schema version and build number.    The database restore process can take up to 30 minutes.  VMware, Inc.
  • Page 37 If the feature can be customized, the ./custom/* directory contains the files. If the directory is empty, no  customization files are associated with the feature. Create a temporary directory: mkdir supportpackagedir Copy the support package into the temporary directory you created in Step 2.  Extract the support package into the temporary directory:  unzip support_package__version_date_and_timestamp.zip where version_date_and_timestamp is the unique identifier of the package.  When prompted for the password, type the password you retrieved from VMware Customer Support.  Copy all files from: supportpackagedir/supportpackage/listener/custom/conf Place the copied files to:  /home/nlayers/Seneca/probe Copy all files from: supportpackagedir/supportpackage/listener/custom/kb Place the copied files to: /home/nlayers/Seneca/probe/resources 10 Copy all files from: supportpackagedir/supportpackage/active_discovery/custom/conf 11 Place the copied files to: /home/nlayers/Seneca/ActiveProbe/conf 12 Change directory to: /home/nlayers/Seneca/management/APIs 13 Type the following command: ./InSight_control.sh adkb --checkout /tmp 14 Copy all files and subdirectories from: supportpackagedir/supportpackage/active_discovery/custom/kb/custom VMware, Inc.

  • Page 38: Reconfiguring An Adm Deployment

    42. Restore the backed‐up database to the new database appliance as described in “Restore the ADM  Database” on page 36.  Converting a Single-Box or Aggregator to a Remote Database Beware of the following before converting an existing component to a remote database:    You cannot restore the data from a component that you are converting. All of the data on the  AUTION Single‐Box or Aggregator component that you are converting to a remote database is lost during conversion.   You can only convert an Aggregator component that is not part of the ADM deployment into a remote  database. For example, if you have an Aggregator appliance that you are using in a test environment, and  another that you are using in your production environment, you can convert the test component into a  remote database.  You can convert an Aggregator component into a remote database when you already have more than one  Aggregator appliance.   You can convert an appliance that is running an Single‐Box setup into a remote database.  To convert the component to a remote database Setup the database appliance as described in the “ADM Setup Procedures” on page 23. Log in to the database appliance as user root. VMware, Inc.

  • Page 39: Moving A Database To A Remote Appliance

    To move a database to a remote appliance Backup the database from the existing database as described in “Product Support Packages” on page 34. Copy the database backup file backup.db_dump-main-db_scheme_version-db_dump.gz to the Remote  Database appliance.  Restore the database on the Remote Database appliance as described in “Restore the ADM Database” on  page 36. Log in to the database appliance as user root. Type the following command to ensure that the database mode is set to the correct mode: /home/nlayers/Seneca/tools/appliance_conf.pl --status If the mode is database, continue with the following step. If the mode is not database, type the following  command to change the mode: /home/nlayers/Seneca/tools/appliance_conf.pl -mode=d Note the IP address of the remote database. Continue to perform the steps described in “Adding a Remote Database to an Existing ADM Deployment”  on page 38. Licenses You must renew the licenses when:  reaching the expiration date  expanding the customer‐discovered network scope. This procedure for uploading a new license must be performed following each:  initial installation  migration of ADM for 6.1.x release.  upgrade from ADM 6.0.x It is not necessary to perform this procedure when upgrading from ADM versions 6.1.x or later. VMware, Inc.

  • Page 40: Uploading A License

    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. Uploading a License    Before you begin, obtain the serial number for managed server host. MPORTANT Perform the following procedure to upload a license. Log in to the ADM UI as an admin user. Navigate to the Manage > System screen and click Licensing. The License Properties screen appears Click Upload a new License. The Upload a new license screen appears. Enter the serial number and click Apply. If the serial number is valid, the serial number is uploaded and  License Properties page is displayed. VMware, Inc.

  • Page 41: Upgrading Adm

     “Overview” on page 41  “Upgrading Appliances” on page 42  “Post‐Upgrade Steps” on page 43 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 42. Mixed Environments Some sites can have a combination of physical and virtual appliances. You must upgrade them to the same  ADM version by using the procedures described in “Upgrading Appliances” on page 42. For more  information about mixed environment, see “Mixed Environment” on page 13. Licenses You need a new license to use ADM after upgrading from 6.0.X. Obtain the license from your VMware Sales  representative. “Licenses” on page 13 provides more information. Appliance Migration Chapter 7 describes procedures for migration to virtual appliances. Backing Up Data Backup the data to prevent loss during the migration and upgrade process. “Product Support Packages” on  page 34 describes backup and restore procedures. VMware, Inc.

  • Page 42: Upgrading Appliances

    -f /var/log/nlayers/update.log This SSH session is in addition to any other session opened for the purpose of upgrading. The above script  also prints success or failure messages along with other useful information to stdout. Perform all upgrades by using the CLI procedures as described in “Upgrading Appliances Using CLI” on  page 42. Upgrading Appliances Using CLI To upgrade all appliances by using CLI Download the update_runner.pl and InSightUpdate-version.upd files from  http://downloads.vmware.com/Application Discovery Manager into:  /home/nlayers/rpms/versionX.x/ Change file access: chmod 744 update_runner.pl Upgrade VMware ADM services: ./update_runner.pl -u -f InSightUpdate-version-build.upd Wait for the upgrade to complete. For distributed solutions, repeat the upgrade procedures for all  remaining appliances as described in “Upgrading Appliances” on page 42.    The upgrade process can take several minutes to complete. You cannot access the ADM Console  while the upgrade is in progress. Proceed with “Post‐Upgrade Steps” on page 43.    WinApe is upgraded as part of aggregator upgrade and you are not required to upgrade it  separately. VMware, Inc.

  • Page 43: Post-Upgrade Steps

    Chapter 6 Upgrading ADM 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.    You might be required to upload a new license if you are upgrading from 6.0.x. Before  MPORTANT proceeding, review the criteria and if necessary, perform the steps described in“Licenses” on page 13. You can now begin using the ADM. VMware, Inc.
  • Page 44 Application Discovery Manager Administration Guide VMware, Inc.

  • Page 45: Migrating To A New Appliance

     “Preliminary Procedures” on page 46  “Data Restoration” on page 47  “Post‐Migration Steps” on page 48 Overview Additional documentation as described below is available at http://downloads.vmware.com/ Supported Migration Appliance migration is supported from ADM 6.0.x. Upgrade earlier versions to the latest 6.0.x version by using  the procedures described in the “Upgrading ADM” on page 41.     Part of the upgrade procedure to ADM 6.0.x can include upgrading custom fingerprints created in  earlier version. Additional information on fingerprints is available in the VMware vCenter Application Discovery  Manager Fingerprint Developers Guide. Licenses You need a new license to use ADM after migrating to a new appliance. Obtain the license from your VMware  Sales representative. More information is provided in “Licenses” on page 13. System Architecture Detailed descriptions are provided in “System Architecture” on page 9. Migration steps differ for different  appliance setups:  Single‐Box  Distributed   Distributed with remote database    The new virtual appliance solutions feature separate virtual appliance components for  MPORTANT Collectors, Database, and the Aggregator. Initial setup and data restoration is therefore performed  separately for each component. VMware, Inc.

  • Page 46: Process

    Backup Windows Collector fingerprints as described in “Backing Up WinApe Migration Files” on page 46  and shutdown all old appliances. Install and deploy the new virtual appliance as described in “Deploying the Virtual Appliances” on  page 18. Restart the appliance and performing initial setup tasks as described in Chapter Restore UNIX Collector fingerprints. Restore Windows Collector fingerprints as described in “Restoring WinApe Migration Files” on page 47. Preliminary Procedures    Backup of existing data is essential to prevent data loss during the migration process. AUTION For all solutions, back up files are needed for WinApe migration to another computer as shown in table  Table 7‐1. The following table describes the WinApe migrations files. For virtual appliance, the default location is  C:\Program Files\VMware\ADM. For physical appliance, the default location is C:\Program Files\nLayers\InSightActiveDiscovery. Table 7-1. WinApe Migration Files File Remark \lib\java\adkbcustom.jar Always Backing Up WinApe Migration Files    You can only manually backup the WinApe migration files. Log in to the WinApe appliance. Navigate to the folder where WinApe is installed. Create the backup of adkbcustom.jar file present in \lib\java folder. VMware, Inc.

  • Page 47: Data Restoration

    Copy the adkbcustom.jar backup file. Navigate to the \lib folder. Replace the current file in \lib folder with the copied file. Run the services.msc command. Restart the service VMware vCenter ADM Windows Collector. Data Restoration This section provides information about data restoration for Single‐Box, distributed, and distributed with  remote database solution. Single-Box Solution Restore the ADM database as described in “Restoring an ADM Environment by Using a Product Support  Package” on page 36.  Restore the custom discovery and configuration files as described in “Restoring the Custom Discovery  and Configuration Files” on page 37. For WinApe, first create the backup as described in “Backing Up WinApe Migration Files” on page 46 and  then restore it as described in “Restoring WinApe Migration Files” on page 47. Distributed Solutions These steps apply to distributed solutions without a remote database. Perform the following steps on all  appliances in the following order: Collectors, WinApe, and Aggregator. Collectors Repeat the following steps for each Collector appliance: Log in to the Collector virtual appliance. Restore the custom discovery and configuration files as described in “Restoring the Custom Discovery  and Configuration Files” on page 37. WinApe Repeat the following steps for each Windows appliance: Log in to the WinApe appliance. Backup the WinApe migration files as described in “Backing Up WinApe Migration Files” on page 46. Restore the WinApe migration files as described in “Restoring WinApe Migration Files” on page 47. VMware, Inc.

  • Page 48: Distributed Solution With Remote Database

    Distributed Solution with Remote Database These steps apply to distributed solutions with a remote database. Perform the following steps on all  appliances in the following order: Collectors, WinApe, database, Aggregator. Collectors Repeat the following steps for each Collector appliance: Log in to the Collector virtual appliance. Restore the custom discovery and configuration files as described in “Restoring the Custom Discovery  and Configuration Files” on page 37. WinApe Repeat the following steps for each Windows appliance: Log in to the WinApe appliance. Backup the WinApe migration files as described in “Backing Up WinApe Migration Files” on page 46. Restore the WinApe migration files as described in “Restoring WinApe Migration Files” on page 47 Database Log in to the database virtual appliance. Restore the ADM database as described in “Restoring an ADM Environment by Using a Product Support  Package” on page 36. Aggregator Log in to the Aggregator virtual appliance. 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. Post-Migration 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.    ADM default groups does not get refreshed during the upgrade. The Management chapter of the  VMware vCenter Application Discovery Manager User’s Guide provides more information on groups  administration. You can now begin using the ADM. VMware, Inc.

  • Page 49: Troubleshooting Adm

    Troubleshooting ADM by Using the Product Support Package You can use the ADM product support package for troubleshooting:  Create an ADM product support package as described in “Product Support Packages” on page 34.  Contact your VMware Customer Support representative and provide them with the product support  package that you generated in Step Troubleshooting Error Messages During WMI Discovery WMI Discovery might fail on a target Windows XP machine with an Access Denied error message even if you  provide valid credentials. This issue occurs because the Use simple file sharing option is selected by default  for some of the Windows XP deployments. To troubleshoot WMI Discovery failure On the Tools tab, select Folder Options. Select the View tab. In the Advance settings box, deselect the Use simple file sharing option. Click OK. Detail Discovery Troubleshooting This section describes utilities and programs that help with troubleshooting. Create an ADM detail discovery product support package as described in “Using ADM Console” on  page 50. Contact your VMware Customer Support representative and provide them with the product support  package that you generated in Step VMware, Inc.

  • Page 50: Using Adm Console

    Management IP] [--ExU Unix Exclude Directories] [--ExW Windows Exclude Directories] [-G CI Groups] [-h] [-i] [--IncU Unix Search Scope] [--IncW Windows Search Scope] [-j classpath] [-l] [-M maxdepth] [-n path] [-p ports] [-P Access profile] [-r filename] [-t timeout] [-T Discovery result translator class] [-v] [-w] VMware, Inc.
  • Page 51 -l, planhelp Prints information about available artifacts and artifact groups. Maximum depth for search in file system. -M, -maxdepth maxdepth -n, -outputPrefix path Specifies the path prefix of the output file (for example, /tmp/).  Note: The directory path must end with a backslash (/). If this  option is not used, a predefined filename is used, and the file is  created in the current working directory. One or more ports to use when connecting to the target host (for  -p, -ports port scanning as well). Use commas as separators. These ports applies  even if the connection details are fetched from the management. -P, -accessProfile Access profile Discovery parameters or policy/access profile name to fetch from  the management. -r, -read filename Read from a playback or snmpdump file instead of going out to the  network. Connect timeout to use when connecting to the target host. If  -t, -timeout timeout connection details are fetched from the management, they will  override this parameter. VMware, Inc.
  • Page 52 -P \"wmi:domain=il.nlayers.com,username=administrator,password=54321\" -a 1.2.3.4 (default locator credentials will be used from properties file) To probe target IP 1.2.3.4 using protocol VI-SDK ./single.sh -P \"visdk:username=administrator,password=54321\" -a 1.2.3.4 Create debug package: single.sh -a address -P Access profile Read from playback file: single.sh -r filename Access profile can have one of the following formats:  Name of a Detail Discovery policy. In this case the necessary information is read from a Detail Discovery  policy defined in the user console.  Full definition of the needed discovery details in a protocol‐specific format: protocol-name:prop1=value1,prop2=value2,... The following protocol names are supported: SSH, Telnet, SNMP, VI‐SDK and WMI. In addition, all protocols supports the ‐timeout parameter with a default value of 20000 milliseconds. The ports  parameter is supported for all protocols except WMI and VI‐SDK, with default ports of 22 for SSH, 23 for  Telnet, and 161 for SNMP. VMware, Inc.

  • Page 53: Snmpdump

    /pcfs, /sys, /usr/kvm/sys, /stand, /var/news, /var/log, /var/run, /var/lock, /var/www, /var/cache, /var/tmp, /etc/gconf] snmpdump The snmpwalk program is bundled with Linux, which runs SNMP on a given IP address and creates a textual  dump of the whole tree of results. This program is often used while extending and debugging the SNMP  portion of the Detail Discovery knowledge base. A new Detail Discovery feature allows VMware Customer Support to record a complete snapshot of the SNMP  responses of a network host, using snmpwalk. You can use the resulting dump file to fix SNMP Detail  Discovery problems encountered by VMware Customer Support. A standardized script called snmpdump.sh is now supplied with ADM to create this snmpwalk dump file. Location /home/nlayers/Seneca/ActiveProbe/bin/snmpdump.sh Usage Running snmpdump.sh on the command line yields the following usage information: ./snmpdump.sh host_ip output_file The first parameter is the host IP to query. The second parameter is the name of the file in which to save the results. Examples Create an snmpwalk dump for IP 1.2.3.4 and save the results into file snmpdump.1.2.3.4.txt: ./snmpdump.sh 1.2.3.4 snmpdump.1.2.3.4.txt nlcapture You can use the nlcapture utility in place of tcpdump to capture network activity. This utility supports the  same default parameters as tcpdump, but sets the snaplen to be large enough so as to not truncate packets. In addition, this utility provides a parameter not supported by tcpdump: ‐R, which filters packets based on  their protocol (for example, HTTP) or based on protocol‐specific attributes. VMware, Inc.
  • Page 54 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.dump As explained earlier, nlcapture supports all common tcpdump parameters such as ‐i. Additionally, it  supports the -R parameter to filter on the network protocol or according to the value of specific protocol fields.  Protocol names are written in lowercase. The following URL provides details on the filters that you can use: http://www.ethereal.com/docs/man‐pages/ethereal‐filter.4.html The filters of nlcapture utility are different from the tcpdump filters. They are easier to use and understand. VMware, Inc.

  • Page 55: Uninstalling Adm

    Uninstalling ADM This chapter provides information for uninstalling the ADM appliance and includes “Uninstalling the ADM  Appliance” on page 55. Uninstalling the ADM Appliance To uninstall the ADM appliance, follow the procedure of your organization for removing a virtual machine. VMware, Inc.
  • Page 56 Application Discovery Manager Administration Guide VMware, Inc.

  • Page 57: Time Zones

    Europe/Monaco Pacific/Kosrae Asia/Kamchatka Atlantic/Madeira Europe/Paris Pacific/Majuro Asia/Karachi Atlantic/St_Helena Europe/Riga Pacific/Marquesas Asia/Kashgar Atlantic/Stanley Europe/Samara Pacific/Midway Asia/Katmandu Atlantic/Reykjavik Europe/Simferopol Pacific/Nauru Asia/Krasnoyarsk Atlantic/Jan_Mayen Europe/Sofia Pacific/Niue Asia/Novosibirsk Australia/Lindeman Europe/Stockholm Pacific/Norfolk Asia/Kuching Australia/West Europe/Tallinn Pacific/Noumea Asia/Kuwait Australia/LHI Europe/Tirane Pacific/Palau Asia/Magadan Australia/Perth Europe/Uzhgorod Pacific/Ponape VMware, Inc.
  • Page 58 Canada/Saskatchewan Europe/Mariehamn US/Central Asia/Thimphu Canada/Atlantic Indian/Antananarivo US/Alaska Asia/Thimbu Canada/Eastern Indian/Chagos US/Aleutian Asia/Tehran Canada/Mountain Indian/Christmas Asia/Taipei Chile/EasterIsland Indian/Cocos Asia/Singapore Chile/Continental Indian/Comoro Asia/Shanghai Etc/Universal Indian/Kerguelen Asia/Seoul Etc/Zulu Indian/Mahe Asia/Riyadh89 Etc/UCT Indian/Maldives Asia/Riyadh88 Etc/UTC Indian/Mauritius Asia/Riyadh87 Etc/GMT0 Indian/Mayotte Asia/Nicosia Etc/Greenwich Indian/Reunion VMware, Inc.

  • Page 59: Adm Api Tutorial

    Population of third party applications with data of ADM.  Dumping of entire database tables and uploading to an FTP server; “Dump API” on page 60.  Access to filtered data by bulk (paginated); “Bulk API” on page 61. You can divide the API into three sections, where two are dedicated to querying the ADM (Dump and Bulk),  and the third is in charge of tracking those queries (Asynch). Insight_control The Insight_control utility writes the system status into an XML output file. To run Insight_control utility Log in to the appliance as user root.  Change the directory by typing: cd /home/nlayers/Seneca/management/APIs Type the following command to generate a system status output file: ./InSight_control.sh systemstatus --get --output /tmp/systemstatus    You can substitute a different file and path for /tmp/systemstatus. Service Status Service status can be:  Running: The service is running.  Disabled: The ADM intentionally stops the service.  Not Running (Purposely Stopped): The service was stopped intentionally, for example, a service was  manually stopped by the adm_control.pl --stop command.  VMware, Inc.

  • Page 60: Asynch Api

    Tasks are uniquely identified by a Universal Unique Identifier, whose string representation is returned upon  a task creation. Future references to a task must be done using this same string. Tasks have predefined parameters regarding their life‐span in every state, for example, a finished task waits  in the system for 24 hours before its resources are recalled and the task is deleted. A task can have any of the  following states, which you can retrieve by using getTaskState ( String id):   PENDING: The task is created and initialized and is waiting to be executed by ADM.  RUNNING: A getTaskProgress() returns an Integer between 0 and 100.  CANCELLED: System can cancel a task if it takes too long to execute.  RUNNING: The task is being executed. You can track the process by calling getTaskProgress(String id).  A task can be in this state for a limited amount of time; system cancels all the offending tasks.  FINISHED: The task has finished running successfully, and its produce is ready and waiting to be  collected by the client.  ERROR/CANCEL: The task has either failed or been canceled (using cancelTask( String id) ). Dump API The Dump API provides you with the possibility of dumping the complete contents of a table (or small set of  tables) that corresponds to a given entity (HOSTS, SERVICES, CONNECTIONS, and so on.). In this API,  flexibility has been traded for speed, and it is intended for those cases where an application intends to mirror  ADMʹs data, and periodically synchronize with it. The Dump API works as follows: Select the type of entities that it needs and a discovery date (optional) for those entities. Call dump( ) with those parameters, and obtain the task UUID in a string form. Track the progress of the task using the Asynch API (getTaskState( ) and getTaskProgress( ) ). Repeat Step 3 until the task reaches the FINISHED or ERROR state. If the task is in the FINISHED state, then the files containing the dumped database tables are ready and  waiting to be collected (either using SSH or in the FTP server if supplied). The files are stored in a  subdirectory whose name is identical to the task ID. VMware, Inc.

  • Page 61: Bulk Api

    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. The Bulk API works as follows Create the filter object and select the level of granularity of the results. Call query( ) with the filter object and obtain the task UUID in string form. After the task is FINISHED, you can retrieve the maximum amount of pages available in this result set by  calling getPageAmount( ). At this moment, there is an iterator in ADM that you can control by the following calls, and the results  retrieved from them: hasNextPage( ) getNextPage( ) After finishing retrieval of all the data with the specific query, you must call closeQuery() to release all  resources associated with this query.  Web Services API The preferred method to access ADMʹs API is through the web services API, which provides for a  standardized way of communication and high interoperability. This API is not locked in a given programming  language. ADM offers a description of the API in a machine‐readable document formatted in Web Services Description  Language (WSDL). With this document, automated tools available for the popular programming languages  can create the low‐level code necessary to access transparently the functionality provided by the ADM.  VMware, Inc.
  • Page 62 Application Discovery Manager Administration Guide VMware, Inc.

  • Page 63: Index

    38 Dump API 60 Engine service 33 installation backup 35 Listener service 33 managing services 34 Oracle service 33 performing an installation backup 35 restore 36 ADM database 36 services 33 time zones 57 VMware, Inc.
  • Page 64 Application Discovery Manager Administration Guide VMware, Inc.

Table of Contents