Foglight Cartridge for Active Directory Installation Guide

Transcription

1 Foglight Cartridge for Active Directory Installation Guide

2 2010 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser s personal use without the written permission of Quest Software, Inc. The information in this document is provided in connection with Quest products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest products. EXCEPT AS SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Quest does not make any commitment to update the information contained in this document. If you have any questions regarding your potential use of this material, contact: Quest Software World Headquarters LEGAL Dept 5 Polaris Way Aliso Viejo, CA legal@quest.com Refer to our Web site for regional and international office information. Trademarks Quest, Quest Software, the Quest Software logo, Foglight, vfoglight, and VizionCore are trademarks and registered trademarks of Quest Software, Inc in the United States of America and other countries. For a complete list of Quest Software s tradmarks, please see Other trademarks and registered trademarks are property of their respective owners. Third Party Contributions The Cartridge for Active Directory contains some third-party components whose authors require attribution. These components are listed in the following table, and the licenses may be found on our web site at: legal/third-party-licenses.aspx. Component License or Acknowledgement Apache Commons 2.4 Apache 2.0 jaxb-api.2.1 Common Developer and Distribution License (CDDL) 1.0 jaxb-impl Common Developer and Distribution License (CDDL) 1.0 j-interop 2.02 GNU Lesser General Public License v3 SAAJ 1.3 Common Developer and Distribution License (CDDL) 1.0 Wiseman 1.0 Apache 1.1 Installation Guide July 2010 Version

3 Table of Contents 3 Table of Contents Introduction to this Guide...5 About Quest Software, Inc....6 Contacting Quest Software...6 Contacting Quest Support...6 Installation...7 Before You Begin...7 Requirements and Compatibility...8 Foglight Management Server...8 vfoglight...8 Agent Components...9 Installation and Setup...9 Install Foglight or vfoglight...10 Install the Cartridge for Active Directory...10 Enable the Cartridge...11 Deploy Agent Packages...11 Create Agents, Activate Agents and Start Data Collection...12 Configure Agent Properties (if not using vfoglight)...13 Alternative Method for Creating and Activating Agents...14 Prerequisites and Troubleshooting Tips...17 Windows 2003 Prerequisite...17 Windows 2008 R2 Prerequisite...18 Register ESENT WMI Class Prerequisite...19 Permissions...20 Agent must be able to reach the target host...20 Remote scripting must be enabled...21

4

5 Introduction to this Guide 5 Introduction to this Guide This Installation Guide contains the procedures you must follow in order to integrate the Cartridge for Active Directory with Foglight or vfoglight. This guide is intended for any user who is responsible for installing and setting up the Cartridge for Active Directory. This guide is organized as follows: Chapter 1, Installation - provides procedures for installing the Cartridge for Active Directory. Chapter 2, Prerequisites and Troubleshooting Tips - provides information to assist you in troubleshooting issues that may be encounter when installing and using the Cartridge for Active Directory.

6 6 Foglight Cartridge for Active Directory Installation Guide About Quest Software, Inc. Now more than ever, organizations need to work smart and improve efficiency. Quest Software creates and supports smart systems management products helping our customers solve everyday IT challenges faster and easier. Visit for more information. Contacting Quest Software Mail Web site Quest Software, Inc. World Headquarters 5 Polaris Way Aliso Viejo, CA USA Refer to our Web site for regional and international office information. Contacting Quest Support Quest Support is available to customers who have a trial version of a Quest product or who have purchased a Quest product and have a valid maintenance contract. Quest Support provides unlimited 24x7 access to SupportLink, our self-service portal. Visit SupportLink at From SupportLink, you can do the following: Retrieve thousands of solutions from our online Knowledgebase Download the latest releases and service packs Create, update and review Support cases View the Global Support Guide for a detailed explanation of support programs, online services, contact information, policies and procedures. The guide is available at: support.quest.com.

7 1 Installation Foglight for Microsoft Active Directory (AD) provides performance and availability monitoring to help administrators detect, diagnose and resolve problems affecting the AD environment and underlying infrastructure for both virtual and physical environments. This chapter steps you through the installation procedure for the Cartridge for Active Directory. This chapter contains the following sections: Before You Begin Requirements and Compatibility Installation and Setup Before You Begin It is recommended that you perform the following steps before you begin the installation procedure: If you do not already have the Cartridge for Active Directory, you can download it from the Quest website at Before you can download the product, you must register with Quest. If you are a registered Quest user, log on using your address and password. Once you have registered or logged in, locate the product and version that you want to download from the product list. In the download windows, click the link and save the file to an appropriate directory (e.g., C:\temp). Review the Requirements and Compatibility section.

8 8 Foglight Cartridge for Active Directory Installation Guide Read the Release Notes for updated or additional information about this version of the cartridge. Ensure you have the appropriate license file to enable the Cartridge for Active Directory. Requirements and Compatibility The following are the requirements to successfully integrate the Cartridge for Active Directory into Foglight or vfoglight. Foglight Management Server The Cartridge for Active Directory is compatible with Foglight Management Server It can be installed as a stand-alone cartridge on a Foglight platform. In this configuration, all Active Directory metrics are collected as well as basic host metrics from both physical and virtual domain controllers. Before installing the cartridge, ensure that your Foglight Management Server is properly installed and configured. For information on how to install and configure the Foglight Management Server, please refer to the appropriate Foglight Installation and Setup Guide. vfoglight The Cartridge for Active Directory can also be used with a vfoglight platform in order to gain in-depth insight into the health of the virtual machine, the virtual host and the virtual environment as a whole. In this configuration, vfoglight 6.1 is the minimum required version as it uses the version of Foglight Management Server.

9 Installation 9 Installation and Setup Agent Components In addition to meeting the minimum requirements for the Foglight Management Server, your system must meet the following minimum software requirements: Operating Systems The Foglight Agent Manager (FglAM) hosting the Cartridge for Active Directory must be installed on Windows Server 2003 SP2 or newer. (32-bit and 64-bit architectures are both supported.) Monitored domain controllers must be Windows Server 2003 or newer. Note If you are using Windows 2003 or Windows 2008 R2, please refer to the prerequisites described in Prerequisites and Troubleshooting Tips. Installation and Setup In order for the Cartridge for Active Directory data to appear on the Foglight browser interface, you must first: 1 Install Foglight or vfoglight 2 Install the Cartridge for Active Directory 3 Deploy Agent Packages 4 Create Agents* 5 Activate Agents and Start Data Collection* * These steps can be performed as a single operation using the Active Directory Agent Management view or as individuals steps using the Agent Status view. The Active Directory Agent Management view allows you to add new agents to multiple servers using the Agent Setup wizard. Whereas, the Agent Status view allows you to add and configure individual agents one at a time. The following procedure uses the Active Directory Agent Management view. The steps for using the Agent Status view are included as an alternative method.

10 10 Foglight Cartridge for Active Directory Installation Guide Install Foglight or vfoglight To install Foglight or vfoglight: 1 Obtain the Foglight installation package (Foglight or vfoglight 6.1). 2 Upload the installation package to your target machine, preferably a physical machine that will serve as the central collection point. 3 Click the executable file and follow the installation process using preferred settings (default settings are sufficient). 4 Ensure that the server has successfully started. Open your browser and navigate to where <yourserver> is the address of the machine where you installed and set up Foglight. Install the Cartridge for Active Directory To install the cartridge: 1 Log on to Foglight and using the navigation panel, navigate to Dashboards Administration Cartridges Cartridges Inventory. 2 On the Cartridges Inventory page, in the Install Cartridge area at the top of the page, enter the path and file name (Active-Directory-5_5_5.car) for the Cartridge for Active Directory. Type the path in the File on Local Computer field to upload the.car file from your local computer to the Foglight Management Server. Alternatively, select Browse to navigate to the.car file on your local computer. Type the path in the File on Server field to install the.car file from a directory on the machine hosting the Foglight Management Server. 3 To enable the cartridge when it is installed, leave the Enable on install check box selected. To enable the cartridge after the installation, clear this check box. 4 Click Install Cartridge. Note This may take some time to upload and validate, you will be notified of success. If the installation is successful, a Cartridge has been installed successfully message appears and the Active-Directory cartridge displays in the Cartridge Inventory table. 5 Press F5 to refresh the Dashboards navigation panel to add the newly installed cartridge.

11 Installation 11 Installation and Setup Enable the Cartridge Enabling a cartridge completes the process of adding it to Foglight and makes its components available for use. The following procedure should be performed only if you did not enable your cartridge during the installation process, as outlined in step 3 of the Install the Cartridge for Active Directory procedure. To enable a cartridge: 1 Using the navigation panel in Foglight, navigate to Dashboards Administration Cartridges Cartridge Inventory. 2 In the Cartridge Inventory table, select the row that corresponds to the Cartridge for Active Directory (Active-Directory). The row becomes highlighted. 3 Select Enable Selected at the bottom of the page. When the cartridge is enabled, a success message appears and an Enabled status icon appears in the Status column for the selected cartridge. Deploy Agent Packages Once the cartridge has been successfully installed, you will need to deploy agent packages for the cartridge. To deploy agent packages: 1 Using the navigation panel of Foglight, navigate to Dashboards Administration Agents Agent Status. 2 Click Deploy Agent Package in the lower left of the Agent Status view. 3 On the Deploy Agent Package dialog, select the FglAM host and package file (e.g., ActiveDirectory.gar). Select Deploy. 4 Wait for positive feedback from the web application. Select OK to close the Deploy Agent Package dialog and return to the Agent Status list. Note Because you are only deploying agent packages at this time, the newly deployed package will NOT appear in the Agent Status list.

12 12 Foglight Cartridge for Active Directory Installation Guide Create Agents, Activate Agents and Start Data Collection Once the agent packages for the cartridge have been successfully installed, you will need to create and activate agents, and start collecting data. To perform these steps in a single operation on one or more servers, use the Active Directory Agent Management view. Note If you would prefer to perform these steps as individual operations on a single server, use the Agent Status view. Please skip to Alternative Method for Creating and Activating Agents. 1 Using the navigation panel in Foglight, navigate to Dashboards Active Directory Agent Management. 2 In the Active Directory Agent Management table, select Add to launch the Agent Setup wizard. 3 On the Domain to Search for Domain Controllers page, enter the following information: Domain - enter the fully qualified name of a domain to search for domain controllers (e.g., mydomain.com) User - enter the user name to be used to query Active Directory on the selected domain (e.g., mydomain\myusername) Password - enter the password associated with the user name entered above 4 On the Domain Controllers to Monitor page, select one or more domain controllers that are to be monitored. All selected servers will use the same user credentials for access. 5 On the Credentials for Domain Controller(s) page, enter the user credentials of an account that has access to the selected domain controller(s). 6 On the Foglight Agent Manager Host page, select the Foglight Agent Manager (FglAM) host for the new Active Directory agents. 7 Select Finish to close the wizard and create the selected Active Directory agents. 8 Back on the Active Directory Agent Management view, select the Active Directory agents to be activated and select the Activate button. 9 To start collecting data, select the agents from the list and select the Start Data Collection button.

13 Installation 13 Installation and Setup 10 Select the Refresh button. The Active and Data Collection cells will contain a green check mark when the selected Active Directory agents are successfully activated and have started collecting data. Note Neither the Browser refresh icon nor F5 will refresh the agent management table. 11 Navigate to Active Directory Active Directory Environment to view dashboards. Note Once an agent has been successfully set up, it may take a couple of minutes to collect a large enough sample to observe. Configure Agent Properties (if not using vfoglight) The Cartridge for Active Directory needs the basic Host metrics (CPU, Memory, Network, Storage). If vfoglight or an OS cartridge is collecting these metrics, the Cartridge for Active Directory will use these host metrics. However, if no other cartridge is collecting host metrics, you must configure the agent s properties in order to collect host metrics. 1 Using the navigation panel of Foglight, navigate to Dashboards Administration Agents Agent Status. 2 Select an agent in the list and click Edit Properties. 3 If the target machine is a virtual machine, set the Is Host A Virtual Machine setting to True. Note The Cartridge for Active Directory can collect data from virtual machines that are not monitored by the VMWare cartridge and also from physical machines. Therefore, this setting must reflect the type of target machine being used. That is, if the target machine is a physical machine, set this setting to False. 4 Scroll down to the Data Collection Scheduler area, select a Collector Config and click Edit. 5 Set the following host collection intervals to a value between 3 and 10 minutes: Host Hardware Detail Host Service Detail Dot Net Frameworks Detail Host Process Detail 6 Select Save Changes and use the close button in the upper right-hand corner to close the dialog. 7 Select Save and click Back to Agent Status to return to the Agent Status view.

14 14 Foglight Cartridge for Active Directory Installation Guide Alternative Method for Creating and Activating Agents If you would prefer to create and activate individual agents one at a time, use the Agent Status view as described below. Create Agents Once the agent package has been successfully deployed, you will need to create an agent for each domain controller to be monitored. To create an agent: 1 Using the navigation panel of Foglight, navigate to Dashboards Administration Agents Agent Status. 2 Click Create Agent in the lower left of the view. 3 On the Create Agent dialog, select the FglAM host, select the Agent Type (ActiveDirectory) and enter an Instance Name for the agent. Select Create. 4 Wait for positive feedback that the agent was installed. Select OK to close the Create Agent Results dialog and return to the Agent Status view. 5 After the agent is created, select the agent in the list and click Edit Properties. 6 Click the Modify the properties for this agent only link and enter the following information: Host Name (<servername> or the IP address) Host Domain Name (<domain.local>) Host User Name Host Password 7 If you are NOT using the VMWare Cartridge and the target machine is a virtual machine, set the Is Virtual Machine setting to True. Note The Cartridge for Active Directory can collect data from virtual machines that are not monitored by the VMWare cartridge and also from physical machines. Therefore, this setting must reflect the type of target machine being used. That is, if the target machine is a physical machine, set this setting to False. 8 Scroll down to the Data Collection Scheduler area, select a Collector Config and click Edit. Set the following host collection intervals to a value between 3 and 10 minutes: Host Hardware Detail Host Service Detail

15 Installation 15 Installation and Setup Dot Net Frameworks Detail Host Process Detail 9 Select Save Changes and use the close button in the upper right-hand corner of the dialog to close the dialog. Note If this step is not performed, the cartridge will not collect host metrics. 10 Select Save and click Back to Agent Status to return to the Agent Status view. Activate Agent and Start Data Collection 1 From the Agent Status view, select the agent from the list and click Activate. 2 Select the agent from the list and click Start Data Collection. Note The first two columns in the Agent Status view should show green icons for an active and healthy agent that is collecting data. It may be necessary to stop and start data collection, based upon agent state, configuration errors, etc. before the agent becomes active and successfully collects data. 3 To refresh the agent status, click Refresh in the upper right corner of the view. Note Neither the Browser refresh icon nor F5 will refresh the agent status.

16

17 2 Prerequisites and Troubleshooting Tips This chapter provides additional information to assist you in troubleshooting issues that may be encountered when installing or using the Cartridge for Active Directory. Windows 2003 Prerequisite This is Microsoft Known Issue. HotFix must be installed on monitored Windows 2003 domain controllers or NTDS metric collections will fail. Symptoms NTDS metric collections fail. This will most obviously affect Database and Replication metrics. 0x errors appear in the logs, which is general WMI script error so it could indicate other problems as well. Resolution See This resolves the issue when you use a WMI script to query the Win32_PerfFormattedData_NTDS_NTDS class on a Windows Server 2003-based domain controller and the script returns a 0x error. Install the hot fix. At the command line, enter: wmiadap.exe /f

18 18 Foglight Cartridge for Active Directory Installation Guide Windows 2008 R2 Prerequisite This is a permissions issue on registry keys which will cause collections to fail. Symptom Depending on the prerequisite, you will encounter a complete failure to collect data (missing servers) or subsets of missing values (empty charts). Resolution For CLSIDs: 76A6415B-CB41-11d1-8B D9B6 and 72C24DD5- D70A-438B-8A B88AFB8 do the following: Login to the target remote host as an Administrator. Run the program Regedit (Click Start Run and enter: Regedit). If you are asked to allow the Regedit program to make changes to the computer, click Yes. Navigate to the registry item: HKEY_CLASSES_ROOT\CLSID\{your CLSID here}. Right-click on this registry item and select Properties. Click Advanced. Open the Owner tab. In the Change Owner to... box, highlight the account you are currently logged in as. Click OK. Click OK. Right-click the registry item again and select Permissions. Highlight the Administrators group. Give Full Control permissions to this group by checking the Allow box. Click OK.

19 Prerequisites and Troubleshooting Tips 19 Register ESENT WMI Class Prerequisite Extensible Storage Engine (ESE) is the database engine used by Active Directory. By default, Active Directory does not automatically register it s ESE database instrumentation with WMI. If ESENT is not registered the cartridge queries will fail. Symptoms Database is not an available Performance Object in the Performance Monitor on the domain controller being monitored. Missing Database and Replication charts have no values. Resolution Note This class must be registered/checked for every domain controller. Check for the Database performance object. Start Run and enter: perfmon Click the plus (+) tool bar button. On the Add Counters dialog, click the Performance object drop-down menu and search for a Database entry. If the Database object is listed, the class is registered and there is likely another problem. If a Database entry is not present, register the following WMI class: Win32_PerfRawData_ESENT_Database WMI.

20 20 Foglight Cartridge for Active Directory Installation Guide Run the RegisterEsentWmiClass.vbs script included with the Cartridge for Active Directory. At a command line, enter: wmiadap /f At a command line, enter: mofcomp %windir%\system32\wbem\scm.mof This procedure sets registry keys and refreshes the WMI database so it is aware of the changed. Permissions Remote script execution requires an Active Directory account with Domain Administrator permissions. Symptoms An agent s Data Collection status will not remain healthy. Empty charts or missing server objects. Resolution Ensure that the account has Domain Administrator permissions. Re-enter passwords to guard against fat-finger mistakes. Agent must be able to reach the target host Server objects do not appear until at least one piece of data has been collected and recorded. If communication fails completely, you will not see objects. Symptoms Agent activation or data collection status will not stay green. Servers do not appear in the Cartridge for Active Directory views. Resolution Test Ping by IP. You must be able to ping the collection target from the FglAM hosting the agent instance. If ping by IP fails, there are routing issues. Test Ping by host name. A DNS server or hosts file must be available to the FMS server in order to resolve names. If ping by host name fails, there are DNS or Hosts file issues.

21 Prerequisites and Troubleshooting Tips 21 If a hosts file is used it should contain an entry for each domain where hosts reside. For example: domain.local childdomain.domain.local In addition, individual servers must resolve to the NetBIOS names and the FQDN. For example: server server.domain.local The hosts file is located at %windir%\system\drivers\etc Remote scripting must be enabled Since the Cartridge for Active Directory uses an agent-less design, remote execution of scripts must be enabled on all domain controllers. If communication fails completely, you will not see server objects. If partial data is collected, the server object will appear in the UI and the metrics will values will be displayed. Symptoms Agent activation or data collection status will not stay green. Servers do not appear in the Cartridge for Active Directory views There will be a log entry prompting you to read the getting started literature. If queries partially succeed, you may see some charts with no values and others with values. Resolution Enable Distributed COM Start Run dcomcnfg Expand Components Servers and then Computers Right-click the My Computer object and select Properties On the Default Properties tab, check the Enable Distributed COM on this computer option

22 22 Foglight Cartridge for Active Directory Installation Guide Enable Remote Script host At a command line, enter: wscript -regserver Create the registry String Value Remote with a value of 1 in the following registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows Script Host\Settings Reboot

23 Index 23 A activate agents using Agent Setup wizard 12 using Agent Status view 15 Active Directory Management view 12 agent components requirements 9 Agent Setup wizard 12 alternate method for creating and activating agents 14 C compatibility 8 configure agent properties if not using vfoglight 13 create agents using Agent Setup wizard 12 using Agent Status view 14 D deploy agent packages 11 E enable the cartridge 11 F Foglight Management Server compatibility 8 I install cartridge 10 install Foglight 10 install vfoglight 10 installation procedure 9 P permissions 20 Prerequisites register ESENT WMI class 19 Windows Windows 2008 R2 18 R register ESENT WMI class prerequisite 19 reguirements 8 remote scripting 21 S start data collection using Agent Setup wizard 12 using Agent Status view 15 support 6 T technical support 6 V vfoglight compatibility 8 W Windows 2003 prerequisite 17 Windows 2008 R2 prerequisite 18