EMC Data Protection Search

Transcription

1 EMC Data Protection Search Version 1.0 Installation and Administration Guide REV 02

2 Copyright 2015 EMC Corporation. All rights reserved. Published in USA. Published July, 2015 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. EMC², EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other countries. All other trademarks used herein are the property of their respective owners. For the most up-to-date regulatory document for your product line, go to EMC Online Support ( EMC Corporation Hopkinton, Massachusetts In North America EMC Data Protection Search 1.0 Installation and Administration Guide

3 CONTENTS Preface 7 Chapter 1 Getting Started 9 Data Protection Search Introduction Product architecture...10 Elasticsearch...12 Replication...13 Elasticsearch analyzers and tokenization Data Protection Search cluster components Environment and system requirements Data Protection Search node component requirements Data Protection Search licensing...16 Chapter 2 Installation 17 Data Protection Search installation planning and considerations Virtual Appliance deployment preparation...21 Deploy the Data Protection Search Virtual Appliance on the vcenter server...22 Deploying the virtual machine from a template...23 Customizing the Virtual Machine after deployment...23 Adding virtual disks Initializing the Data Protection Search environment...24 Installing the Common Index Service (CIS) Installing Index Data components Installing Worker components...29 Installing additional Worker nodes...30 Update LDAP configuration...30 Updating LDAP configuration in the DPSearch Admin UI Updating the Data Protection Search Admin Group...31 Chapter 3 DPSearch Admin User Interface 33 Data Protection Search Administration Web Application...34 Logging in to the Data Protection Search Admin user interface Data Protection Search Admin UI home Data Protection Search dashboard Chapter 4 Sources 39 Sources...40 Adding an Avamar server to Data Protection Search Updating an Avamar or NetWorker server Removing a server from Data Protection Search...42 Chapter 5 Roles 43 Roles...44 Adding Index Admins Removing an Index Admin...45 EMC Data Protection Search 1.0 Installation and Administration Guide 3

4 CONTENTS Data Protection Search Admin role Chapter 6 Indexes 47 Adding an index Data Protection Search Admin role Editing an index Removing an index...49 Chapter 7 Collections 51 Collections activities Adding a collection activity...52 Collection activity fields Editing a collection activity...55 Chapter 8 System 57 Data Protection Search System...58 Chapter 9 Jobs 59 Jobs overview Jobs views...60 Data Protection Search job types...62 Chapter 10 Options 65 Options overview Configuring System notifications...66 Chapter 11 Search 69 Search overview Logging in to the Search user interface Search by using keywords Restore files in Data Protection Search Using Lucene to search Data Protection Search indexing...73 Search results Search criteria management...75 Search performance factors...78 Appendix A Troubleshooting 79 The Data Protection Search log files Copying log files by using WinSCP...80 Copying log files by using PuTTy Viewing and filtering log files with Data Protection Search log viewer Troubleshooting the Data Protection Search Web server...81 Data Protection Search configuration files...82 Troubleshooting web services for collector issues Increasing the maximum memory for the DPWorker service Troubleshooting Elasticsearch EMC Data Protection Search 1.0 Installation and Administration Guide

5 CONTENTS Glossary 87 EMC Data Protection Search 1.0 Installation and Administration Guide 5

6 CONTENTS 6 EMC Data Protection Search 1.0 Installation and Administration Guide

7 Preface As part of an effort to improve its product lines, EMC periodically releases revisions of its software and hardware. Therefore, some functions described in this document might not be supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information on product features. Contact your EMC technical support professional if a product does not function properly or does not function as described in this document. This document was accurate at publication time. Go to EMC Online Support ( support.emc.com) to ensure that you are using the latest version of this document. Revision history This revision history provides a description for each revision of this Installation and Administration guide. Revision Date Changes 02 July 9, 2015 Updated values in the Memory use based on index table on page April, 2015 Initial revision of the Data Protection Search Installation and Administration Guide. Purpose This document describes how to install, configure and use Data Protection Search. Audience This document is intended for the administrator and index administrator who will be involved in managing Data Protection Search. Related documentation Data Protection Search Installation and Administration Guide Data Protection Search Security Configuration Guide Data Protection Search Release s Data Protection Search Online Help Special notice conventions used in this document EMC uses the following conventions for special notices: NOTICE Addresses practices not related to personal injury. EMC Data Protection Search 1.0 Installation and Administration Guide 7

8 Preface Presents information that is important, but not hazard-related. Typographical conventions EMC uses the following type style conventions in this document: Italic Monospace Use for full titles of publications referenced in text Use for: System code System output, such as an error message or script Pathnames, file names, prompts, and syntax Commands and options Monospace italic Monospace bold Use for variables Use for user input [ ] Square brackets enclose optional values Vertical bar indicates alternate selections - the bar means or { } Braces enclose content that the user must specify, such as x or y or z... Ellipses indicate non-essential information omitted from the example Where to get help EMC support, product, and licensing information can be obtained as follows: Product information For documentation, release notes, software updates, or information about EMC products, go to EMC Online Support at Technical support Go to EMC Online Support and click Service Center. You will see several options for contacting EMC Technical Support. that to open a service request, you must have a valid support agreement. Contact your EMC sales representative for details about obtaining a valid support agreement or with questions about your account. Online communities Visit EMC Community Network at for peer contacts, conversations, and content on product support and solutions. Interactively engage online with customers, partners, and certified professionals for all EMC products. Your comments Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Send your opinions of this document to DPAD.Doc.Feedback@emc.com 8 EMC Data Protection Search 1.0 Installation and Administration Guide

9 CHAPTER 1 Getting Started This section includes the following topics: Data Protection Search Introduction Product architecture...10 Elasticsearch...12 Data Protection Search cluster components Getting Started 9

10 Getting Started Data Protection Search Introduction Data Protection Search (DPSearch) is a scalable, fault-tolerant, indexing and search virtual appliance. DPSearch provides a fast and powerful way to search backup data across one or more Avamar and/or NetWorker servers, and then restore or download the search results. Scheduled collection activities are used to gather and index the metadata and/or content of backups, which is then stored within the DPSearch node or cluster. Index DPSearch indexing provides the following support and capabilities: Processes content from multiple input sources for Avamar and NetWorker servers in Data Protection Suite Supports both metadata only, and full-content indexing: Metadata only index is a light weight search for the name, location, size and date for files Full-content index expands on metadata only index by drilling into the body of files to index the content Leverages Elasticsearch, a scalable, fault tolerant open source indexing technology Search DPSearch provides the following search support and capabilities: A simple, familiar Google-like search interface Complex, advanced search queries Cross server and cross platform searches Supports the following actions on search hits: Preview Download Restore to both original and alternate locations Product architecture Data Protection Search (DPSearch) is a pre-installed, Linux-based virtual appliance. Additional configuration is required during deployment. DPSearch can be deployed as a single node, or multiple nodes can be used to form a fault-tolerant cluster. The following figures illustrate the architectural components of Data Protection Search and the data flow. 10 EMC Data Protection Search 1.0 Installation and Administration Guide

11 Getting Started Figure 1 Data Protection Search architecture Figure 2 Data Protection Search system The following table lists the components that make up the Data Protection Search architecture. Table 1 Data Protection Search components Component Elasticsearch Common Index Service (CIS) Collector Service Description Highly scaleable full-text index and search platform with RESTful web interface, schema-free documents, and built-in replication. An abstraction layer above Elasticsearch that provides the ability for multiple applications to share the same Elasticsearch cluster, enabling cross-platform searches. CIS also provides a security layer in front of Elasticsearch to prevent unauthorized access. Manages scheduled jobs to collect metadata and, optionally, full content of backup files. The collector service leverages connector interfaces to interact with backup platforms. Product architecture 11

12 Getting Started Table 1 Data Protection Search components (continued) Component Apache Tika NGINX web server DPSearch Admin app DPSearch Search app LDAP Unicorn Description Open source toolkit to extract full text content and applicationspecific metadata from a wide variety of file types. Open source reverse proxy web server, hosting the web-facing components of DPSearch. Web application that serves as the primary interface for DPSearch and Index Administrators to manage the configuration of the product. This includes managing backup servers, scheduling collection activities, roles, options and monitoring the system. Web application that serves as the primary interface for Search Admins to search, preview, download, and restore indexed content. Searches may be on basic file or backup metadata, such as keyword, name, type, location, size, and backup server/client, or full text content of the files. Also supported is visual filtering and analysis, and a powerful text-based query language. All administrators (users and groups) leveraging the DPSearch Admin and Search applications are selected from an existing LDAP server, such as Microsoft Active Directory. The CIS components of Data Protection Search use Unicorn, an HTTP server for Rack applications. The Unicorn service must be running on the Data Protection Search Index Master node for CIS to work. At the terminal, the status of the service can be checked by using service unicorn status, and if necessary it can be started with service unicorn start. Elasticsearch At the core of Data Protection Search is Elasticsearch, an open source, scalable technology that supports indexing, searching, and analytics. Elasticsearch leverages Apache Lucene for its indexes. Elasticsearch does work well on a single node, however to leverage its built in replication functionality, at least two Index Data nodes are required. Additional nodes improve search performance. The various elements and concepts of an Elasticsearch cluster are described in the following table. Table 2 Elasticsearch cluster concepts and elements Term Cluster Description A single node or collection of nodes. Node An Elasticsearch process running on the JVM. For DPSearch, Master node (1 per cluster) and Data nodes are the primary nodes. 12 EMC Data Protection Search 1.0 Installation and Administration Guide

13 Getting Started Table 2 Elasticsearch cluster concepts and elements (continued) Term Description All indexing a query traffic must pass through the Master node. If this node fails, all activity stops until such time it becomes available. To avoid failure on the Master node, it is recommended to add extra Data nodes to balance the work load. Shard Primary shard Replica shard A Lucene index. Indexed documents go to the primary shard first. A copy of the primary shard that increases both performance and failover capability. The way Elasticsearch organizes indexed content is similar to that of a relational database, although the terminology differs somewhat. The following table describes the terms used for indexing, and the equivalent relational database terms. Table 3 Elasticsearch index terminology Term Relational database equivalent Description Index Database Similar concept to a relational database with mappings. Physical indexes are implemented as shards. Mapping Schema The schema/definition for the index. Optional -- Elasticsearch makes a best guess. Type Table Multiple types can exist within a single index. Document Row A JSON object representing an item. Comprised of key/ value pairs, for example, Name: filename.docx. Field Column For the example, Name: filename.docx, Name is the field. Term N/A Term is the value stored in the index. Replication Replication in Elasticsearch provides built-in fault-tolerance. In order for replication to work, there must be at least two Indexing nodes deployed. Multiple replicas are supported if there are at least the number of replicas + 1 nodes available. Each index is divided into shards (5 is the default). The shards are distributed over the available Index nodes. For each replica, there is a Replica shard. Replica shards must be stored on a different node from the corresponding Primary shard. For example, an index with 5 shards, and 2 replicas has a total of 15 shards. The shards are distributed among the available nodes. If the cluster does not include least 3 nodes, DPSearch marks the cluster and index with a yellow warning state, as it is not possible to create all requested replicas. Replication 13

14 Getting Started Elasticsearch analyzers and tokenization When indexing occurs, each item is written to at least the primary and replica shards. Therefore, the item must have been written successfully to a majority of the primary and replica shards before returning. In the example above, the item must have been written to the primary shard and one replica before returning. The item is replicated to the final replica later on. When an Elasticsearch node becomes unavailable, replica shards are automatically promoted to replace any unavailable primary shards without required administrator interaction. When an item is indexed, Elasticsearch converts the various elements into a form that can be stored in the index and used to search later on. The process of breaking up text along word boundaries and removing punctuation is called tokenization. Internally, various filters are used in this process. The groupings of rules that determine which filters and transformations run are called analyzers. Elasticsearch has a number of built in analyzers, and Data Protection Search provides the ability for analyzers to be selected for a particular index if required. Although the default standard analyzers are recommended for the majority of use cases, advanced users can select different analyzers for specific indexes if required. One example scenario in which an alternate analyzer selection might be appropriate is to apply stemming and/or stop words for full-content indexing. Stemming modifies words to their basic root or stem. This provides the ability for keyword searches to match a broader set of hits. For example, searching for run will return a match if the index includes any of the following: run runs running runner Stop words prevent unnecessary words from being indexed. This results in smaller indexes, faster queries, and broader matches. For example, indexing "The cat sat on the mat" will only index "cat", "sat", and "mat". Similarly, searching for "The cat sat on the mat" automatically strips out "the" and "on" from the search query. Stemming and stop words are supported for many different languages. Supported DPSearch analyzers are listed in the following table. Table 4 Supported DPSearch analyzers Analyzer type Standard (default) Description The standard analyzer: Lower cases Handles text and numeric tokens Tokenizes , and other text strings correctly 14 EMC Data Protection Search 1.0 Installation and Administration Guide

15 Getting Started Table 4 Supported DPSearch analyzers (continued) Analyzer type Description It is strongly recommended that you use the Standard DPSearch Analyzer. Simple The simple analyzer: Lower cases Discards numeric values Splits text into tokens on non-letter characters Whitespace Languages The whitespace analyzer does not support lowercases and splits text into tokens on whitespace characters only. The languages analyzer: Supports stemming as appropriate for the language Removes stop words as appropriate for the language Supports a very large selection of languages Data Protection Search cluster components Configure a Data Protection Search cluster with multiple nodes or deploy all components on a single node. The three main components of the Data Protection Search cluster environment are: Worker nodes (worker nodes can be restricted to either web server only, or collection service only) Index Master nodes (including CIS) Index Data nodes Extra Worker nodes can be added to improve the speed of collections. Extra Data nodes can be added to: Improve the speed of indexing Improve the speed of queries Store more indexed content Provide replication Environment and system requirements Data Protection Search requires the following to configure and run: Supported browsers: Mozilla FireFox 34 and 35 are the minimum required browser versions (Firefox is the recommended browser for DPSearch) Internet Explorer 10 and 11 Ensure that the pop-up blocker is disabled to allow UI and online help pop-ups. Data Protection Search cluster components 15

16 Getting Started VMWare environment: VMWare vcenter 5.1, 5.5 for the Data Protection Search appliance deployment in a virtual environment ESXi 5.x and vcloud Data Protection Search node component requirements There are several factors to consider when planning your Data Protection Search cluster. The following table describes the Data Protection Search node requirements. Table 5 Data Protection Search node requirements Node CPU Memory Disk All in one GB+ Disk 1: 40 GB A second disk is required for nodes running as Elasticsearch data nodes, including all in one nodes. Disk 2 is mounted to a directory for Elasticsearch at deployment. Worker GB 40 GB Index Master GB Disk 1: 40 GB The current deployment script sets the Index Master node as an Index Data Node as well. If you choose to set this node as an Index Master, a second disk is required. Index Data GB Disk 1: 40 GB A second disk is required for nodes running as Elasticsearch data nodes. Disk 2 is mounted to a directory for Elasticsearch at deployment. Data Protection Search licensing DPSearch does not require its own license, and is free with a Data Protection Suite license. 16 EMC Data Protection Search 1.0 Installation and Administration Guide

17 CHAPTER 2 Installation Data Protection Search is a virtual appliance that can be deployed to VMWare vcenter or vcloud with one or more VMDKs. Review Environment and system requirements on page 15 before beginning the deployment. This section includes the following topics: Data Protection Search installation planning and considerations Virtual Appliance deployment preparation...21 Deploy the Data Protection Search Virtual Appliance on the vcenter server...22 Customizing the Virtual Machine after deployment...23 Adding virtual disks...24 Initializing the Data Protection Search environment...24 Update LDAP configuration...30 Installation 17

18 Installation Data Protection Search installation planning and considerations When planning the Data Protection Search deployment, there are a number of factors to consider. How large is the environment At a basic level, this involves how many backup servers are in the environment, and, more importantly, the total number of clients to be indexed across those servers. Once you have this number, the next factor to consider is how many backup records exist on those clients. For example, if a particular client contains a million files, and there are daily backups retained for 30 days, there may be 30 million backup records for that client. What is being indexed? Data Protection Search only indexes backups from traditional file system backups. Backups of VMs, databases, Microsoft modules, snapshots, and so on are ignored. Block-based and NDMP backups are also ignored. Only non- block-based backups from file system clients should be planned for. DPSearch allows flexibility as to what will be indexed from clients. It can be restricted to certain filetypes, and/or files modified within a certain date range. The range of backup dates can be specified, either per client, or across all clients. Processing all historical backups takes considerably longer than only indexing a short range of backups, or day-forward backups. By default, collection activities index backups no older than a week before the collection was created. This can be modified. To keep the index current, it is recommended that collections are scheduled to run on the same schedule as backups. For example, daily or weekly. Metadata or full-content indexing? You can specify the type of indexing for each collection activity. The default indexing method is metadata only where only the basic metadata for each file, including the filename, path, size, date, platform details of the server, client, and backups in which the file exists. This information is available from the Avamar or NetWorker databases, so processing is fast, and no backup storage access is required. The amount of space required to store the record in the index is minimal. As an alternative, you can select full-content indexing. This causes the full file data to be restored to the DPSearch Worker node, where it is scanned, and all text strings are extracted and indexed. The text is searchable, and a preview of the file, either text-based or an image thumbnail is stored in the index. This provides an enhanced search experience, at the expense of slower indexing, larger index size, and impact on backup storage. It is recommended that metadata-only be the primary approach, with targeted full content indexing, if needed. How many DPSearch Appliances are required? It is possible to deploy DPSearch as a single, all-in-one node, that handles both indexing and search. Such a node can handle many billions of backup records, if enough storage is provided. However, search performance is reduced as the number of records increases. Filtered searches might take a few seconds, or less, but broader searches and visual filters take longer. Adding additional Index Data nodes provides better search performance in these scenarios. The computing and memory requirements for searches are distributed across all nodes. This is particularly noticeable for concurrent searches. 18 EMC Data Protection Search 1.0 Installation and Administration Guide

19 Installation Also, adding additional DPSearch Worker nodes enable collection activities to process faster, as the work items are distributed across those nodes. If you have a two hour daily window for indexing, and DPSearch is unable to process all your clients in that time frame, adding additional Worker nodes will help. However, this is in some respects constrained by the backup servers themselves. Adding five Worker nodes to process full content indexing for a single Avamar server would be counterproductive, since the bottleneck would be the Avamar server rather than DPSearch. In this scenario, expect diminishing returns for added Workers. For example, you may see a 50%-70% indexing performance increase after adding one extra node, but only 40% for the next node, and so on. The initial collection (index) takes longer than subsequent collections. Just as with full and incremental backups, DPSearch must initially process all files, and subsequently only process newly added or changed files. In particular, indexing weeks or months worth of historical backups take much longer than later daily collections to process the latest daily backup. Are replicas required Elasticsearch provides the ability to automatically replicate indexes. Both replication and fail over are handled automatically, but the number of replicas to use must be specified. The default number of replicas is 1, but this be modified in the Options section of the Admin UI. If you plan for only a single DPSearch node and do not require replication, changing the number of replicas to 0 prevents the Elasticsearch cluster and indexes from displaying a yellow warning icon on the dashboard. It is strongly recommended that replicas is not set to 0. If there is no replica, fail over cannot be achieved. There must be at least replicas + one Index Master or Data nodes in a DPSearch cluster. Adding additional Index Data nodes for replication improves search performance. How much space is required for the indexes The space required for indexes varies widely based on a number of factors: Metadata only or full-content indexing For full-content indexing, the size and type of files being indexed must be considered For metadata indexing, the length of file names and path names specifically The amount of duplication (unchanged files appearing in multiple backups) Replication For metadata only, with 80% duplication, each backup record can take approximately 100 to 200 bytes. With zero duplication (all unique files) which is unlikely, the average can rise to 400 to 600 bytes. For full-content indexing, the range is often broader. Large multimedia files take up very little space in the index, while small documents use significantly more. With a typical data set at 80% duplication, each backup record might consume 1 to 4 KB. With zero duplication, that average could rise to 15 to 30 KB or more. Data Protection Search installation planning and considerations 19

20 Installation Table 6 Memory use based on indexing Backup records 1 billion 5 billion 10 billion 20 billion Metadata only index 100 bytes 93 GB 466 GB 931 GB 1.9 TB 200 bytes 186 GB 931 GB 1.9 TB 3.7 TB Full-content index 1 KB 854 GB 4.8 TB 9.5 TB 19 TB 4 KB 3.8 TB 12 TB 38 TB 76 TB How large will the indexes grow over time? If an activity is setup to recur (daily), DPSearch continues to process new backups/save sets as they are created. This results in new or modified items being added to the index, and references being added for items that are unchanged from previous backups. When a backup expires, or is deleted, any items no longer in any backups for that client are removed from the index. This is managed by daily garbage collection, and a monthly reconciliation job. The index size for a particular client initially grows until all current backups (for example, 30 days worth for monthly backup retention) are in the index. Then the index size stabilizes, and growth matches the data growth on that client. Adding more clients increases the size of the index. View the size of the index in its properties. Indexes can be deleted to recover space. How long will searches take? The DPSearch/Elasticsearch framework is very fast, with searches often taking less than a second. However, as the number of items in an index increases, search speed is often impacted as well, particularly on a single node. Generally, the broader the search is, the greater the impact of a large index is. The broadest possible search is a wildcard (*) search across all indexes. This can still complete in a few seconds even with hundreds of millions of indexed items, but as the item count rises to the billions, such broad searches can time out before completion. The recommendation is to use filters to narrow searches as much as possible. In a single node environment with 15 billion backup records (1.5 billion unique files), a wildcard (*) search can possibly take 30 to 60 seconds, while a search filtered by keyword, type, and client might take less than a second. Since millions or billions of results are not useful, the use of filters is recommended. Broad searches perform faster with a static index, rather than if indexing is currently running during the search. Visual filters in Search is impacted by a large number of items. Visual filters require that matching items from the current search are aggregated. This requires large amounts of memory and time. Filters can narrow the results being aggregated to reduce the impact on memory and time. If a visual filter is not completed in a timely manner (10 seconds), the current results are displayed with a warning message indicating that results are incomplete. 20 EMC Data Protection Search 1.0 Installation and Administration Guide

21 Installation Virtual Appliance deployment preparation Before beginning the Data Protection Search Virtual Appliance deployment, be sure to create or collect the necessary groups, users and information. Required information The following information is required throughout the deployment and configuration of Data Protection Search: Network: Hostname and IP DNS server Gateway Domain name LDAP: Hostname or IP Port Base domain name Username/password User account with the ability to query LDAP DPSearch Admins Group LDAP Groups and Users For any LDAP service including, Active Directory or OpenLDAP: Create a DPSearch Admin Group Create at least one Admin user and add the user to the DPSearch Admin Group A DPSearch Admin user can also be an Index Admin and a Search Admin (for evaluation) (Optional) Create the following: Index Admins (users and/or groups) Index Admins manage indexes, and manage and monitor collection activities and jobs. Index Admins receive notifications for those jobs they initiated. Search Admins (users and/or groups) Each index has a list of Search Admins (users/groups). Only Search Admins belonging to a given index can search that index. Search Admins are given Read only, or Full access permissions for a given index. Members of the DPSearch Admin Group are also Index Admins by default. Virtual appliance Data Protection Search is a virtual appliance comprised of an OVF and a single vmdk. It is recommended to convert the deployed VM to a template, and deploy the template as required for DPSearch nodes. You can partially configure the template to simplify, and speed up future node deployments: Virtual Appliance deployment preparation 21

22 Installation Accept the EULA Setup common networking values, such as domain, DNS, and routing Setup the date/time zone Update/change passwords Deploy the Data Protection Search Virtual Appliance on the vcenter server The DPSearch Virtual Appliance can be deployed to VMWare vcenter by following the wizard. Before you begin Review the following sections before deployment: Environment and system requirements on page 15 Data Protection Search node component requirements on page 16 Virtual Appliance deployment preparation on page 21 Use the following procedure to deploy the DPSearch Virtual Appliance on the vcenter server. Procedure 1. From a vsphere client that connects to a VMware vcenter server with ESX hosts, click File > Deploy OVF Template. A vcenter server is required to deploy the OVF. 2. Browse to the DPSearch.ovf file and click Next. 3. In the Name and Location window, specify a Name and an Inventory Location for the deployed template, and click Next. 4. Select a Host / Cluster on which to run the deployed template and click Next. 5. In the Storage window, select a destination storage for the virtual machine files, and click Next. 6. Select the Disk Format in which to store the virtual disk: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision (recommended) Eager Zero yields the best performance, but also takes the most time to initialize. Thick provisioning does not fill the drive unless eager zeroed is selected. The storage capacity for the entire virtual disk is allocated on the datastore at virtual disk create time if thick provisioning is selected. Thin provisioning means that the capacity on the datastore is allocated to the virtual disk as required, up to the full size of the virtual disk. 7. Click Next. 22 EMC Data Protection Search 1.0 Installation and Administration Guide

23 Installation 8. In the Network Mapping window, specify what networks the deployed template use, and click Next. 9. In the Ready to Complete window, verify that the options are correct and click Finish, or click Back to change options. 10.When the deployment completes successfully, right click the newly deployed Virtual Machine and select Template > Convert to Template. Converting the VM to a template provides the ability to deploy multiple nodes. 11.When the conversion completes, proceed to Deploying the VM from a template on page 23. It is recommended that you rename the template to something intuitive, for example DPSearch. Deploying the virtual machine from a template It is recommended that you deploy the virtual machine from the template to provide the ability to add additional nodes as required. Procedure 1. Right click the VM and select Deploy Virtual Machine from this Template In the Name and Location window, specify a Name and an Inventory Location for this virtual machine, and click Next. 3. Select a Resource Pool within which to run the virtual machine and click Next. 4. In the Storage window, select a destination storage for the virtual machine files, and click Next. 5. In the Guest Customization window: Do not click the check box to Power on this virtual machine after creation. Select the Do not customize option. Click Next. 6. In the Ready to Complete window, verify that the options are correct and click Finish, or click Back to change options. A virtual machine clone is created from the Template. 7. When virtual machine clone is creation completes, right click the machine and select Edit Settings Proceed to Customizing the Virtual Machine after deployment on page 23. Customizing the Virtual Machine after deployment Use the following procedure to customize the Virtual Machine (VM) after deployment. Before you begin It is recommended to complete the Virtual Machine configuration immediately after deployment as changing the VM settings later can cause the VM to become unstable. Deploying the virtual machine from a template 23

24 Installation Procedure Adding virtual disks 1. In the Virtual Machine Properties window, configure Memory, CPU, and Disk. Data Protection Search node component requirements on page 16 provides the specific recommendations for these settings. 2. Add and configure additional disks if required, as described in Adding virtual disks on page Click the newly deployed Virtual Machine in the vcenter server and choose Power on from the list of commands to open the console. If required, configure new virtual hard disks. Additional hard disks must be configured for all in one nodes and data nodes. Additional disks are not required for dedicated worker nodes. Procedure 1. Right click the virtual machine and select Properties. The virtual machine Properties window opens. 2. In the Hardware tab of the VM Properties, click Add, and select Disk from the list of device types to add. 3. In the Select a disk window, choose Create a new virtual disk, and click Next. 4. In the Create a disk window, complete the following sections, and click Next: Capacity (disk size) Disk Provisioning Location 5. In the Advanced Options window, click Next to accept the defaults. The settings on this page do not typically need to be changed. 6. Proceed to Initializing the Data Protection Search environment on page 24 to complete the installation. Initializing the Data Protection Search environment DPSearch configuration and general operation is handled through a web-based Administration console. However, some settings must be configured by using a menu system in the Linux terminal. Accepting the End User License Agreement (EULA), and configuring network settings must be completed before the rest of the options are displayed: Accepting the End User License Agreement Configuring network settings Configuring an LDAP server Providing LDAP Admin user and group accounts Specifying the criteria for the indexing subsystem Setting the local time and time zone Updating system passwords 24 EMC Data Protection Search 1.0 Installation and Administration Guide

25 Installation Procedure 1. Login to the DPSearch terminal: User name: dpsearch Password: dpsearch The default password is dpsearch, and it is strongly recommended that you change this as soon as possible for security reasons. 2. Type the following commands: cd download su Type the root password: linux The default password is linux, and it is strongly recommended that you change this as soon as possible for security reasons. 3. Type the bash dp_install.sh command. The option to Show EULA opens. 4. Type 1 to display the EULA. 5. Type q to exit the EULA, and type yes to accept the terms. 6. Type 2 to initialize the environment. The YaST2 menu opens to the YaST Control Center to configure network settings. Use the arrow keys, Tab and Enter keys to navigate and Alt-option to select items. 7. Tab to Network Devices and select Network settings from the list of devices. The Network Settings window displays details of the current DPSearch host: Device name and type IP address Bus ID 8. Type Alt-I to edit the eth0 device. 9. Set the following network options if you are using a static IP, and type Alt-N or tab to Next: IP address Subnet mask Hostname 10.Tab to Hostname/DNS and type Alt-S to set the following options: Hostname Domain name Name server(s) Initializing the Data Protection Search environment 25

26 Installation Domain search 11.Tab to Routing, and set the Default gateway. A default gateway is required. If one is not set, the deployment scripts display errors during firewall configuration. 12.Select OK, and quit the YaST2 tool. If you change the host name, a system reboot is required for the change to take effect, type yes to reboot. 13.Before continuing with installation on the DPSearch node, switch to your DNS server to configure the host lookup: Add a record to resolve the host name of the server to its IP address Ensure that nslookup returns the correct hostname/ip For NetWorker, the host IP address must resolve to the same hostname defined for the NIC 14.When the DPSearch node restarts, complete the following: cd download Log in with User name: dpsearch Password: dpsearch Log in as root, su Type the root password: linux Type the bash dp_install.sh command again to restart the installation process The default password is dpsearch, and linux for the root user, it is strongly recommended that you change both passwords as soon as possible for security reasons. 15.Proceed with the configuration process depending on the role you intend the DPSearch node to have: Single node (all in one) Follow the steps in Installing the Common Index Service (CIS) on page 27 Follow the steps in Installing Worker components on page 29 Multi node Dedicated Index Master node (Do not configure more than 1 Index Master node) Follow the steps in Installing the Common Index Service (CIS) on page 27. Dedicated Index Data node Follow the steps in Installing Index Data components on page 28. Dedicated Worker node, perform either of the following: Follow the steps to install Worker Components (first Worker Node) 26 EMC Data Protection Search 1.0 Installation and Administration Guide

27 Installation Follow the steps in install Additional Worker Nodes on page 30 (subsequent Worker Node) The CIS node must be installed on the first DPSearch node before any other nodes are installed. There can only be one Index Master node with these components. Installing the Common Index Service (CIS) CIS must be installed on one node in the environment, with DPSearch on an all in one node or on a separate node in a multi-node environment. In the dps_install.sh script on a terminal, use the following procedure to continue with the CIS installation. Procedure 1. Type 3 to begin the CIS installation. A submenu opens with the following options: Configure as Index Master Node (There can only be 1 CIS Master node) Configure as Index Data node (Many index data nodes can be added) Update LDAP Settings (This is usually used to update the LDAP query user password) 2. Respond to the following CIS installation prompts to configure the Elasticsearch nodes: Elasticsearch cluster Name Accept the default unless you are planning multiple clusters Elasticsearch node name Accept the default Elasticsearch node heap size As a general rule, choose half the physical memory of the node (usually this value is already the default) Number of index replicas The Number of index replicas (default is 1 and is hard coded here) is used to determine how many replicas will be made of each index. There must be at least one DPSearch Index Data node for each replica, plus an additional Index Data node. Therefore, replicas + 1, Index Data nodes are required and can be changed in the Options section of the UI. If you plan to have a single all in one DPSearch node, or a single index node, set this to 0. If there are not enough nodes to create the requested number of replicas, the status of the cluster and individual indexes will remain yellow in the DPSearch Admin UI Dashboard. Number of shards Accept the default if you do not plan to install more than 5 index data nodes 3. Respond to the prompts to configure the LDAP settings: LDAP Host name : Set to the name or IP of your Active Directory/LDAP server (FQDN) Installing the Common Index Service (CIS) 27

28 Installation LDAP Port: Port number (Active Directory is usually 389) LDAP Base DN : Base distinguished name of the domain or OU DPSearch will use when managing users and groups. For example: DC=domain,DC=com enables any users/groups in domain.com to be used OU=IT,DC=domain,DC=com enables any users/groups in the IT organizational unit of domain.com to be used LDAP Query Username : Account of a user that can query LDAP - Specify as username@fqdn This account is also the CIS Admin LDAP Login Password: Password for the account The LDAP settings will be validated. If the authentication fails, you are prompted to re-enter the information. After the validation completes, there can be a long delay. 4. Follow the Press Any key to continue... prompt. The Elasticsearch data storage location is set and the second disk drive for the VM (dev/sdb) is: Partitioned Formatted Installing Index Data components Mounted to /mnt/elasticsearch_data Elasticsearch settings (yml) are updated Elasticsearch service are restarted 5. Type 0 to return to the main menu when the new window is displayed. Use the following procedure to configure Index Data components. Before you begin The Index Master node must already have been installed and configured. The Index Master automatically includes the Index Data components. It is not necessary to perform these steps on the Index Master node. From the DPSearch & CIS Deployment script, you can install additional index data nodes. Procedure 1. Type 3 to open the CIS Install menu. 2. Type 2 in the CIS Install menu: Existing DP machine name: Enter the name of the Index Master node (the first node installed) Elasticsearch Cluster name: Accept the default (unless changed for first node) 28 EMC Data Protection Search 1.0 Installation and Administration Guide

29 Installation Installing Worker components Elasticsearch node name: Accept the default (name of this node) Elasticsearch node heap size: See nodes for the initial CIS install Number of Index Replicas: Same as the Index Master node Number of Index Shards: Same as the Index Master node 3. Repeat these steps to install additional index data nodes. Use the following procedure to install DPSearch Worker components.. Before you begin The Index Master components must already have been installed and configured on either this node, or on another node. Procedure 1. Type 4 to begin installing DPSearch. 2. Type 1 to configure as the initial, or the only DPSearch node. 3. Configure the initial DPSearch node: Install directory: It is recommended to accept the default although it can be modified. CIS URL: If CIS was installed on this node (Index Master), accept the default. If CIS was installed on another node, enter the URL of that node. Use the same format as the default, but change the node name. CIS Admin: Enter the username and password for the CIS Admin configured in Installing the Common Index Service (CIS) on page 27 DPSearch Application name: Accept the default Worker node: Accept the default (yes), unless you are creating customized Worker nodes Web Services node : Leave as default (yes), unless you are creating customized Workers DPSearch Admin Group name: The name of a security group in LDAP While the installation is validated, the following occurs: The CIS Admin is logged into CIS The DPSearch Admin group is validated in LDAP You are prompted to Press any key to Continue Follow the prompt to Press any key to Continue... The script will: Log in to CIS Create the DPSearch application Add the current node Setup system configuration Create the system index Initialize the system index mappings Configure the system index Create system activities Installing Worker components 29

30 Installation Configure the worker Configure LDAP The DPSearch & CIS Deployment Script opens. 5. Type 0 to open to the main menu. 6. Type 6 to change the date & time. Ensure that the date and time zone are the same as the backup servers. 7. Exit the installation script. Results Installing additional Worker nodes You can now log in to the DPSearch Admin UI. Use the following procedure to install additional Worker nodes. Before you begin The initial Worker node and the Index Master node must be installed and configured. Procedure Update LDAP configuration 1. Type 2 in DPSearch Install menu, and respond to the following prompts. Install directory: Can be modified, however it is not recommended CIS URL: The Index Master node (use the full URL as in default) CIS Admin: Same username and password used for the Index Master node DPSearch Application name: Accept the default (unless changed on initial node) Worker node: Accept the default (yes), unless you are creating customized Worker nodes Web Services node: Leave as default (yes), unless you are creating customized Workers 2. Repeat these steps to install additional Worker nodes. During deployment, the configuration of an LDAP server must be specified. At a later date, some of the specified settings might have to be updated. This is often the password of the LDAP query account, or the account name itself. There are two ways to update LDAP configuration as described in the following tasks. Updating LDAP configuration in the DPSearch Admin UI During deployment, the configuration of an LDAP server must be specified. At a later date, some of the specified settings might have to be updated. This is often the password of the LDAP query account, or the account name itself. Procedure 1. Navigate to the Options section of the Admin UI. 2. Update the values in the LDAP Options section. 30 EMC Data Protection Search 1.0 Installation and Administration Guide

31 Installation 3. Click OK to save the changes. Updating LDAP configuration in the DPSearch Admin installation script If the LDAP query user password has been reset, it may not be possible to login to the DPSearch Admin UI. That is because the LDAP user is required to authenticate the logon user against the directory service. If required, in a terminal session with an SSH tool such as PuTTy for the Data Protection Search Index Master VM: Procedure 1. Login as root (default password is linux). 2. Change to the install directory. cd /home/dpsearch/download/ 3. Run the dp_install.sh script: bash dp_install.sh 4. Select option 3, Configure CIS. 5. Select option 3, Update LDAP settings. 6. Follow the prompts to update the settings. Updating the Data Protection Search Admin Group If the LDAP host or domain changes, it might be necessary to change the DPSearch Admin Group. Procedure 1. Open a terminal session for any DPSearch worker node VM, using an SSH tool such as PuTTy, and log in as root (the default password is linux). 2. Change to the /bin subdirectory of the installation directory, The default is /usr/ local/dpsearch/bin. 3. Run the following command: ruby config_system.rb -o set_group -f config.json 4. Change the DPSearch Admin Group in the "admin_dn" field of "ldap_settings. 5. Save the file and exit the editor. Updating the Data Protection Search Admin Group 31

32 Installation 32 EMC Data Protection Search 1.0 Installation and Administration Guide

33 CHAPTER 3 DPSearch Admin User Interface The Data Protection Admin user interface provides a the ability to administer, configure and customize Data Protection Search. There is also a dashboard that provides an at-aglance health check for DPSearch components. This section includes the following topics: Data Protection Search Administration Web Application...34 Logging in to the Data Protection Search Admin user interface Data Protection Search Admin UI home Data Protection Search dashboard DPSearch Admin User Interface 33

34 DPSearch Admin User Interface Data Protection Search Administration Web Application When the DPSearch Virtual appliance is deployed and the web server is configured and running, you can access the DPSearch Admin web app hosted by any DPSearch worker node. Logging in to the Data Protection Search Admin user interface After completing the Data Protection Search virtual appliance deployment, use the following procedure to log in to the Admin UI. Before you begin To log in to the Admin UI initially, you must be a member of the DPSearch Admin group (LDAP user) configured during installation. Later, additional Index Admins can be created to log in and access the Admin UI. You must allow cookies in the browser. Figure 3 Data Protection Search login screen Procedure 1. Type the user name in the User names field. Log in by using any of the following formats: <samaccountname>, for example, myusername <domain>/<samaccountname>, for example, mydomain myusername <samaccountname@<fqdn>, for example, myusername@mydomain.com 2. Type the password in the Password field. 3. Click Login. At initial login, all options of the Data Protection Search Dashboard are available, as the DPSearch Admin user is also an Index Admin. 34 EMC Data Protection Search 1.0 Installation and Administration Guide

35 DPSearch Admin User Interface You must log in to the Data Protection Search UI each time it is opened, or after an inactivity time out (1 hour by default). The default inactivity timeout can be modified in the Options section of the Admin UI. Data Protection Search Admin UI home The DPSearch Admin UI is customized based on role. The following table lists and describes the sections of the DPSearch Admin UI. Table 7 DP Search Admin UI Admin Web UI tab Description Visibility based on Admin permissions DPSearch Admin Index Admin Sources Add, update, or remove Avamar and NetWorker servers. Yes No Roles Add, update, or remove Index Admins. DPSearch Admins are listed, but cannot be modified. Instead, they are managed with your LDAP solution. Yes No Indexes Add, update, or remove indexes. Manage permissions for each Search Admin No Yes Collections Schedule collections for Avamar and NetWorker backup servers. No Yes Systems Monitor DPSearch Worker and Index nodes. Yes No Jobs Lists running and completed activities and jobs. Details include type, Yes Yes Data Protection Search Admin UI home 35

36 DPSearch Admin User Interface Table 7 DP Search Admin UI (continued) Admin Web UI tab Description Visibility based on Admin permissions DPSearch Admin Index Admin status, duration, and more. Options Modify the number of Search hits to,display, Session (timeout), index and notifications, and LDAP host options. Yes No Help Access the DPSearch online help. Yes Yes Data Protection Search dashboard After logging into DPSearch Admin UI, the dashboard opens displaying the health of the components that make up DPSearch environment. The following table lists the dashboard components and visibility based on Admin permissions. Table 8 DP Search dashboard Component Description Visibility based on Admin permissions DP Search Admin Index Admin Both DP Search and Index Admin Source Servers Health DPSearch Workers Health Lists configured backup servers with information on platform, version and status. You can click the link below the Source Servers Health table for more complete details. The Sources section of the DPSearch UI opens. The last time the status of each backup server was updated is shown. A refresh icon can be clicked to force another refresh. Lists configured DPSearch Worker nodes and their status. You can click the link below the DP Search Workers Yes No Yes Yes No Yes 36 EMC Data Protection Search 1.0 Installation and Administration Guide

37 DPSearch Admin User Interface Table 8 DP Search dashboard (continued) Component Description Visibility based on Admin permissions DP Search Admin Index Admin Both DP Search and Index Admin Elasticsearch Cluster Health Index Status Upcoming Collections System Notifications Health table for more complete details. The System section of the DPSearch UI opens. Each Workers health segment provides a last updated time, and the ability to force a refresh and view unresponsive worker services. The last time the status of each Worker node was updated is shown. A refresh icon can be clicked to force another refresh. If the Worker node has been unresponsive for a long period, a red warning message is displayed. Lists configured Elasticsearch Cluster status. You can click the link below the Elasticsearch Cluster Health to view the individual Elasticsearch nodes in the cluster. The System section of the DPSearch UI opens. Hovering the mouse over the status icon provides more information about the state of the cluster. For example, a yellow warning status can indicate that replicas are configured, but there is only one Elasticsearch Index Data node that is unavailable. Lists configured indexes and their status. At initial login, no indexes will have been created so the list is empty. Lists the next time a scheduled collection will run. Displays the system notifications. Click to view additional details about the notification. System Notifications is enabled by default, and all notifications can be viewed from the dashboard. Configuring system notifications in the Options section of the Admin UI provides the ability to send notifications. You can open System Notifications, mark them as read, view Yes No Yes No Yes Yes No Yes Yes Yes Yes Yes Data Protection Search dashboard 37

38 DPSearch Admin User Interface Table 8 DP Search dashboard (continued) Component Description Visibility based on Admin permissions DP Search Admin Index Admin Both DP Search and Index Admin all notifications, or just unread notifications. Click the link below: Any dashboard item to view a complete list of the items. DPSearch Workers Health and Elasticsearch Cluster Health to view complete details provided in the System section of the DPSearch UI. Click the arrow to the right of Dashboard items to expand, or collapse the section. Click the refresh icon anytime to force a status update. Hover over Elasticsearch Cluster Health and Index Status for more details at a glance. For Source Servers Health a Last Updated Time field provides a time stamp for unresponsive servers. If the Last Updated Time value remains the same after approximately one hour, the status changes to red and a message similar to the following is displayed: One or more Worker services are unresponsive. For DPSearch Workers Health, a Last Heartbeat Time field provides a time stamp for unresponsive workers. If the Last Updated Time value remains the same after approximately 10 minutes, the status changes to red and a message similar to the following is displayed: One or more Worker services are unresponsive. 38 EMC Data Protection Search 1.0 Installation and Administration Guide

39 CHAPTER 4 Sources This section provides information on the Sources tab of the DPSearch UI for adding, editing and removing sources from Data Protection Search. At initial login, no sources are added and the DPSearch Admin is prompted to add sources. This section includes the following topics: Sources...40 Sources 39

40 Sources Sources Add, update and remove Avamar and NetWorker servers in the Sources tab of the Data Protection Search Admin Web UI. A checkmark icon in the Status column confirms that there is a connection to the respective Avamar or NetWorker server. If DPSearch is unable to connect to the server, a warning icon is displayed. You can also use Search by source name to quickly locate a server from the list. Adding an Avamar server to Data Protection Search Use the following procedure to add a new Avamar server to Data Protection Search. Procedure 1. In the Sources section of the UI, click Add. The Add Source window opens. 2. In the Add Source window complete the following steps: For an Avamar server you are required to complete the following fields: Source Name Type the hostname or IP of the Avamar server. Platform Choose Avamar from the drop down list. Port Default is Port User ID Password Confirm Password Timezone Choose a timezone from the dropdown list. Enable blackout window Click the check box to enable and select the specified time range each day that no collection jobs can run for that backup server. The blackout window is disabled by default. Enable only for full-content indexing Click the check box to restrict fullcontent collection activities during the blackout window. If checked, metadata only collections can run at any time. You can choose an existing Avamar admin user for that server or create your own in the server's Avamar Administrator. 3. Click Add. The new server is now available in the list of servers in Sources. When a server is added, a system job is added to register the Avamar client on each DPSearch Worker node to the new server. This can be monitored in Jobs on page 59 by clicking the System Jobs checkbox. 40 EMC Data Protection Search 1.0 Installation and Administration Guide

41 Sources Adding a NetWorker server to Data Protection Search Use the following procedure to add new NetWorker server to Data Protection Search. Before you begin 1. Register any DPSearch nodes as clients on the NetWorker server. 2. Specify a nominal file, or turn off scheduling (it is not required to back up any files). 3. For the User group: The root account on all DPSearch nodes must have the correct privileges. For example, user=root, host=dpsearchnode1.domain.com. For Option 1, add to the existing Application Administrators or Operators group. For Option 2, create a new DPSearch Admins User Group. Add necessary root accounts. Provide the necessary privileges. The root accounts must have at least the same privileges as the Operators group. Procedure 1. In the Sources section of the UI, click Add. The Add Source window opens. 2. In the Add Source window complete the following steps: Complete the following fields: Source Name Type the hostname or the IP of the NetWorker server. Platform: Choose NetWorker from the drop down list. Timezone Choose a time zone from the dropdown list. Enable blackout window Click the check box to enable and select the specified time range each day that no collection jobs can run for that backup server. The blackout window is disabled by default. Enable only for full-content indexing Click the check box to restrict fullcontent collection activities during the blackout window. If checked, metadata only collections can run at any time. Configure all DPSearch nodes as a client of the Networker server before adding it. 3. Click Add. The new server is now available in the list of servers in Sources. When a server is added, a system job is added for each DPSearch Worker node to complete the NetWorker registration process. This can be monitored in Jobs on page 59 by clicking the System Jobs checkbox. Adding an Avamar server to Data Protection Search 41

42 Sources Updating an Avamar or NetWorker server Use the following procedure to update an Avamar or NetWorker server that was previously added to Data Protection Search. Click the Avamar or NetWorker Source Name to update. In the Update window, perform one of the following: For an Avamar server, complete the following fields: Port User ID Password Timezone Blackout window (the update takes effect at the next runtime Removing a server from Data Protection Search You can choose an existing Avamar admin user for that server, or create your own in the Avamar Administrator for that server. For a NetWorker server, the Timezone and Blackout window fields can be updated. Use the following procedure to remove Avamar and NetWorker servers from Data Protection Search. When a backup server is removed, any items indexed from that server remain in the index until the backups expire. However, it is not possible to download or restore these items. This is the case even if the backup server is re-added as the newly added server has a different internal identifier. It is recommended that associated indexes are removed for deleted servers. Procedure 1. Select the server from the list and click Remove. 2. The following message is displayed: Selected items will be permanently deleted. Please type DELETE to confirm. A server cannot be removed if there are outstanding collection activities defined for it. Delete the collections first. Results The server is no longer listed. 42 EMC Data Protection Search 1.0 Installation and Administration Guide

43 CHAPTER 5 Roles This section provides information on the Roles tab of the Data Protection Search UI. Roles...44 Data Protection Search Admin role Roles 43

44 Roles Roles When you configure the Data Protection Search virtual appliance, you must configure a DPSearch Admin Group. The Admin Group and its associated users (created in your LDAP solution, such as Active Directory) are listed in the Roles section of the UI. Roles is also where you can add, remove and assign permissions to the Index Admin Groups. Adding Index Admins The DPSearch Admin Group is the default Index Admin. Members of the DPAdmin Group are listed and can not be edited directly. DPAdmin users are added and modified in any LDAP based directory service, such as Active Directory. DPSearch Admin role The DPSearch Admin role provides the ability to: Manage backup servers Manage roles Monitor system Monitor system jobs Set options Receive notifications Index Admin role Index Admins have permissions to: Create metadata only indexing collection activities (default) Create metadata only and full-content indexing collection activities (must specifically enable full-content indexing capability) Create and maintain indexes Monitor index jobs Receive index jobs related to notifications Use the following procedure to add Index Admins in the Index Admin section of Roles. Procedure 1. In the Index Admin window, click Add. 2. In the Select User window: a. Type a username or a substring. b. Click Find to display the list of Active Directory users. c. You can also restrict the search to Users only, Groups only, or both (the default). If you click find before specifying a substring, the entire directory will be returned, which can be slow. For example, type Admin and click Find to find all users and groups that begin with Admin. 44 EMC Data Protection Search 1.0 Installation and Administration Guide

45 Roles 3. Select the user or group to add and enable Metadata Index only (default) or Metadata and Full-content Index. Full-content index searches can take longer than Metadata index searches and put a substantial strain on the backup server and backup storage performance. Removing an Index Admin Use the following procedure to remove Index Admins from DPSearch. Before you begin You must have full DPSearch Admin privileges to remove Index Admin users or groups from DPSearch. Procedure 1. In the Index Admin window, click Remove. 2. Select checkboxes of users or groups to remove, and click Remove. Results The users or groups will no longer be listed. Data Protection Search Admin role DPSearch provides the ability to create multiple indexes if required, and to specify the particular users and/or groups able to access those indexes. These users/groups are referred to as Search Admins. When a Search Admin logs in to the Search UI, they can search only those indexes to which they have access. The following table lists the DPSearch Admin roles. Table 9 Admin roles Search Admin role Index Admin - All access Index Admin - Read only Description No restrictions are applied. Cannot view inline or full preview for search hits, download files locally, or restore files to an alternate location. The Data Protection Search Admin Group is the default Index Admin. Members of the Data Protection Search Admin Group are listed and can not be edited directly. DPAdmin users are added and modified in any LDAP based directory service, such as Active Directory. Removing an Index Admin 45

46 Roles 46 EMC Data Protection Search 1.0 Installation and Administration Guide

47 CHAPTER 6 Indexes Indexes hold the indexed metadata and/or content extracted from backup files. DPSearch provides the ability to create multiple indexes if required, and to specify the particular users and/or groups able to access those indexes. These users/groups are referred to as Search Admins. When a Search Admin logs in to the Search UI, they can search only those indexes to which they have access. This section includes the following topics: Adding an index Editing an index Removing an index...49 Indexes 47

48 Indexes Adding an index Use the following procedure to add a new index. Procedure 1. In the Index section of the UI, click Add. 2. In the New Index window, complete the following fields: Index Name Description Analyzer When an index is created, the user that logged in is added as the default Search Admin for that index, and is assigned an Admin - All Access role. If required, this user can be removed, or the role can be changed. 3. Additional or replaced users and/or groups can be added. Click Add in the Users/ Groups section of the window to add a new user for the index: a. In the Select user window, type the name of the user or group to add, and click Find. b. Click OK. The user or group is now listed in the Users/Groups section of the window. c. Click either Admin - Read only or Admin - All access in the Roles column for the user or group. Search Admin Roles on page 45 provides details on the restrictions applied to the Search Admin roles. 4. Select an Analyzer from the list. The Analyzer options include, Standard (recommended), Simple, Whitespace, and Language. Elasticsearch on page 12 provides complete details on the available types of Analyzers. 5. Click Finish. Results The new index is listed. Data Protection Search Admin role DPSearch provides the ability to create multiple indexes if required, and to specify the particular users and/or groups able to access those indexes. These users/groups are referred to as Search Admins. When a Search Admin logs in to the Search UI, they can search only those indexes to which they have access. The following table lists the DPSearch Admin roles. Table 10 Admin roles Search Admin role Index Admin - All access Description No restrictions are applied. 48 EMC Data Protection Search 1.0 Installation and Administration Guide

49 Indexes Table 10 Admin roles (continued) Search Admin role Index Admin - Read only Description Cannot view inline or full preview for search hits, download files locally, or restore files to an alternate location. The Data Protection Search Admin Group is the default Index Admin. Members of the Data Protection Search Admin Group are listed and can not be edited directly. DPAdmin users are added and modified in any LDAP based directory service, such as Active Directory. Editing an index Removing an index Use the following procedure to edit existing indexes from the Manage Indexes window. Procedure 1. Click the index for which to make changes. The following index details are displayed: Index name Index description Add, or change the Index description. Analyzer Not editable. Size Provides the size of the index. Item count Provides the number of items in the index. Users / Groups You can add to, or remove users or groups from the index. Apply or change the following permissions for a specified user or group: Admin: Read only Admin: All access 2. Make required changes, and click Finish. Use the following procedure to remove an index. Procedure 1. Select an index from the list of available indexes. 2. Click Remove, and then type DELETE to confirm the deletion, when prompted. Proceed with caution when removing an index; it is not reversible. Editing an index 49

50 Indexes Results The index is no longer listed. 50 EMC Data Protection Search 1.0 Installation and Administration Guide

51 CHAPTER 7 Collections The Collections section of the Admin UI provides the ability to create and configure collection activities for Data Protection Search. These collection activities are used to identify the backup clients to be indexed. The rules that define how indexing are applied, for example, the time and duration of the indexing. This section includes the following topics: Collections activities Adding a collection activity...52 Editing a collection activity...55 Collections 51

52 Collections Collections activities The following table lists the available Collections activity actions. Select the activity, or activities for the Add, Remove, Run now, Enable, and Disable actions. Table 11 Available actions for Collections activities Action Add Remove Run now Enable Disable Description Add a new Collection activity. Removes one or more existing Collection activities by selecting the activities and clicking Remove from the list of actions. Force one or more scheduled collection activities to run now (rather than waiting for the next scheduled time). Enable one or more collection activities. Activities that are enabled will run based on the schedule, and can also be forced to run now. Disable one or more collection activities. Activities that are disabled will not run, regardless of the schedule. Adding a collection activity You can filter activities by Name and Status. Click Reset filter to clear filter. Viewing collection activities Click the activity name to view its details. A list of jobs that have completed or are currently running are also listed. Click Edit from the details to enter the Manage Collection Activity wizard and modify the activity. This section provides the ability to select Avamar and NetWorker backup clients to index. The Manage Collection Activity wizard is a 4 step process. After each step is completed, the settings are saved to protect you from crashes or failures. The following are the 4 tasks to complete in the wizard: Select an index Select sources Choose scope Sources Schedule Use the following procedure to add a collection activity. Procedure 1. In the Manage Collection Activity window, click Add. The New Collection Activity window opens. 2. Complete the following fields in the New Collection Activity window: Activity name (required field) Description (optional field) 52 EMC Data Protection Search 1.0 Installation and Administration Guide

53 Collections Select an index: Select an index from the drop down list. 3. Click Save and continue. The Add backup clients to index window opens. 4. Click Add. 5. Click to select a Backup server, Avamar or NetWorker. You can search or filter on the Backup server or Clients list. 6. Select one or more backup clients from the list. 7. Click OK. 8. Click the value in the Backup Sets column to specify a date or a date range for the backup client. 9. To apply the same date to multiple/all backup sets, click Set backup sets and choose the applicable date or date range. 10.In the Choose content filters and indexing scope section: a. Specify which documents to index: Index all documents (*.*) (default) Index only the following documents: (specify file type separated by a semicolon, or by date range) Filter by document types (Use a semi colon (;) to specify multiple document types) Filter by last modification date (specify a date, a date range, or all dates before or after a given date) Specify which information to index from the selected files: Document level metadata only (recommended) Full-content, including metadata and text from the body of the content If you select Full-content, you can exclude file types separated by a semi colon, and accept this disclaimer: I have read and accept the impact that full-content indexing might have on backup servers and associated devices. Full-content indexing can be very time and resource consuming, and negatively impact Avamar and NetWorker backup server performance. It is recommended that metadata only indexing is the primary approach, with full content indexing enabled only as needed. Click impact in the disclaimer to obtain more information on selecting full-content indexing. From this dialog, click Calculate to obtain an estimate of the impact for your environment. Calculate can take a very long time to query Avamar and/or NetWorker for the estimate. Calculate provides a high estimate or worst case. Full content indexing is not suitable for large backup sets stored on tape. It can result in a very large number of recover sessions for those tapes. Full content indexing should be limited to disk or Data Domain based storage. Adding a collection activity 53

54 Collections b. Specify which information to index from the selected files: Document level metadata only (recommended) Full-content, including metadata and text from the body of the content If you select Full-content, you can exclude file types separated by a semi colon, and accept this disclaimer: I have read and accept the impact that full-content indexing might have on backup servers and associated devices. Full-content indexing can be very time and resource consuming, and negatively impact Avamar and NetWorker backup server performance. It is recommended that metadata only indexing is the primary approach, with full content indexing enabled only as needed. Click impact in the disclaimer to obtain more information on selecting full-content indexing. From this dialog, click Calculate to obtain an estimate of the impact for your environment. Calculate can take a very long time to query Avamar and/or NetWorker for the estimate. Calculate provides a high estimate or worst case. 11.Click Save and Continue. This is disabled until you accept the disclaimer. 12.In the Schedule section, specify when to index the selected content (ASAP is the default): The schedule section is used to define the time, duration and the collections recurrence schedule for indexing. It is recommended to set up collection activities to recur daily or weekly to match your backup schedule. Matching your backup schedule ensures that new backups are processed for indexing when they complete. Therefore, the indexing window should be scheduled to occur after the backup window. By default, the schedule is set up to run a single time, as soon as possible (ASAP). Start date Start time Duration, choose from the following: Run until completion Not more than n hours Recurrence pattern, select from: Once Daily Every n weeks on: Weekly Every n weeks on: Select the day of the week Range of occurrence: No end date 54 EMC Data Protection Search 1.0 Installation and Administration Guide

55 Collections End by, select a date for the schedule to end Collection activity fields A list of Collection Activities is displayed. The following table lists the information available for collections activities in the Collections section of the Admin UI. Table 12 Collection activity fields Field Name Description Index Schedule Next run Status Description Click the activity name to view a full summary of the activity details. Metadata only or full-content indexed and associated details. Lists the targeted index. Lists the specified schedule for when the indexing will occur. Lists the next scheduled run. This is NA for ASAP schedule with no recurrence. Status includes: Pending Incomplete (Not fully defined) Active (Waiting for next run) Inactive (Disabled from UI) Finished Expired (Does not reach end date or complete "run once") Editing a collection activity Use the following procedure to edit existing collection activities. Procedure 1. Click the activity name. A summary of the activity with a list of all associated jobs is displayed. 2. Click Edit to modify the collection activity. 3. Click OK to save the changes. Example 1 Actions for lack of activity Some of the possible actions for lack of activity include the following: remove run now enable disable Collection activity fields 55

56 Collections 56 EMC Data Protection Search 1.0 Installation and Administration Guide

57 CHAPTER 8 System The System section of the DPSearch Admin UI monitors and provides information on all DPSearch workers and Elasticsearch nodes. When you first open the System section of the Admin UI, Elasticsearch (CIS) nodes and details are displayed. You must click the arrow beside Worker nodes to display details. Data Protection Search System...58 System 57

58 System Data Protection Search System The System section of the DPSearch Admin UI provides information on the status of Worker and Elasticsearch nodes, components and agents. When you first open System, the Worker entries are minimized. Open them by clicking the down arrow next to each one. The values displayed on this page are gathered at hourly intervals, and therefore the might not be current. Specifically, memory and CPU utilization can appear to be usually high after a system restart. Data Protection Search Workers The threshold (hard coded) and current usage are listed for the following: CPU: >90% / >50% Memory: >90% / >60% Disk space: >90% / >60% The value in Current is color coded for when it is near or exceeds the acceptable threshold value. If enabled, notifications are sent when thresholds are exceeded. Notifications are also listed in, and can be viewed from System Notifications on the DPSearch Admin dashboard. Components The current version of the following components are listed: Worker Node Admin Web Admin API Search Web Search API Agents The status of agents for Avamar and NetWorker backup servers is listed. 58 EMC Data Protection Search 1.0 Installation and Administration Guide

59 CHAPTER 9 Jobs In the Jobs section of the DPSearch UI, you can view complete details and status for DPSearch collection, background and system maintenance jobs. This section includes the following topics: Jobs overview Jobs views...60 Data Protection Search job types...62 Jobs 59

60 Jobs Jobs overview Index Admins create collection activities, which can be recurring. Every time a collection activity runs, a job is created. One collection activity can have many jobs. There are background system jobs, which monitor the system components, refresh client lists and backups, and run garbage collection to remove expired backups from the index. Also, there are jobs triggered from the Search UI, including Restore, Download, and Query. The DPSearch Admin can view information and status for the following job types, if it is enabled by checking the System Jobs checkbox: Query jobs Restore jobs System maintenance jobs (garbage collection, source cache, node status) Index Admins are only able to view Index jobs (both metadata only and full-content). Available options for Jobs Available actions, located on the top left of the Jobs window, are listed in the following table. Table 13 Available actions for Jobs Available action Stop Description Stop long running, or very large jobs such as full-content index that send many requests. It will stop any further requests from being sent to the Source. It is not possible to stop requests that are already being processed on the backup server, just requests that are in the queue. Filter Reset filter Refresh You can filter on job type, status, the user who triggered the job, and activity name. Use Reset filter to return to a full view of all jobs. Refresh the list of jobs and their status. Jobs views Clicking View jobs beside Search results displays a list of search-related jobs directly in the Search UI. You can click the head of each field to sort the contents in a field. The following table lists and describes the columns available in the Jobs section of the UI. You can click the head of each field to sort the contents in a field. 60 EMC Data Protection Search 1.0 Installation and Administration Guide

61 Jobs Table 14 Jobs fields Field Description Sort by field Activity name Job type Status Triggered by Lists the activity name. Corresponds to either a collection job, or a background activity and will be prefixed with DPSearch System. Lists the index activity (full-content or metadata only) or system maintenance job. Also includes Search Admin initiated restore requests from the DPSearch UI. Both restore and download requests will be displayed as restore in Jobs. Lists the status of the activity. A list of status values and the respective descriptions are available in the Jobs status value table. Lists the user that created the job. System jobs will be displayed as System if it is selected. No Yes Yes Yes Start time Lists the time the job began. Yes End time Lists the time the job ended. No Processed Lists the number of items that were processed/indexed for the activity. No Succeeded Lists the number of processed items that succeeded. No Failed Lists the number of processed items that failed. No Duplicate Updated Lists the number of duplicate items. An item is a duplicate when it has already been indexed from another backup. For example, if an unmodified file exists in 30 backups, processing all 30 backups results in 29 duplicates for that file. Lists the number of updated items. An item is updated when it is initially added to the index with metadata only, and is later changed to full-content. No No Click the check box to list System jobs. The following table lists and describes the available values for the status column. Table 15 Jobs status values Status Pending Spawning Running Stopping Success Failed Description Waiting to be picked up by a worker component. A job has been claimed, and is preparing to run. A job is actively being processed. The worker process is attempting to stop the job, based on a user request. The job completed successfully. The job failed. Jobs views 61

62 Jobs Table 15 Jobs status values (continued) Status Stopped Timeout Description The job was stopped based on a user request. The job has timed out. Table 16 Jobs views based on Admin permissions Job type Visibility based on Admin permissions DPSearch Admin Index Admin Index (both metadata only and full-content) No Yes Restore Yes No System maintenance (includes garbage collection, source cache, and node status) Yes No Query Yes No The Jobs view can be filtered by the following criteria: Job type Job status Triggered by (user) Activity name There is a Reset filter option available to return to a view of all Jobs. Data Protection Search job types The Jobs section of the DPSearch UI provides information and status for indexing, search related, and system jobs. Indexing jobs When a collection activity is created, there are a number of scheduling options available. The collection can be scheduled to run immediately (ASAP) or at a future date, and can also be scheduled to recur, for example, daily, or weekly. Every time the collection activity runs, a job is created to process it. Clicking on the activity name displays a list of all jobs that ran for the activity. In the Jobs View, statistics are listed for each indexing job, including: The start time The end time The number of items processed, succeeded, and failed The number of succeeded items is further broken down into the number of duplicate items (unchanged items that appear in multiple backups) and updated items (items that were previously indexed for metadata only, and later updated to be full text indexed). When a large number of clients, or clients with a large number of backups or files are indexed, it is not unusual for it to take a significant amount of time for the statistics to be 62 EMC Data Protection Search 1.0 Installation and Administration Guide

63 Jobs updated. The indexing takes time to initially build up an internal list of files in the backups, and to break them down into tasks. Also, it takes additional time to query backup servers for the information. Search related jobs Using the companion search web UI, Search Admins can complete actions on selected search hits. The actions include downloading and restoring search hits, and creating long running queries filtered by the backup date. These jobs can be tracked in the Search UI, and are also listed in the Jobs View in the Admin UI. System jobs Data Protection Search runs regular background jobs to maintain the system. These system jobs include checking the status of DPSearch Worker nodes, configured backup servers, and garbage collection activities. Garbage collection removes files from the index that no longer exist on the backup server. Status jobs run hourly, garbage collection run jobs daily, and a special garbage collection reconciliation job runs monthly. The garbage collection reconciliation job synchronizes the backup information stored in DPSearch with the information in the backup servers. By default, system jobs do not appear in the Jobs View. To see them, check the System Job checkbox to the right of the view. Data Protection Search job types 63

64 Jobs 64 EMC Data Protection Search 1.0 Installation and Administration Guide

65 CHAPTER 10 Options This section includes the following topics: Options overview Configuring System notifications Options 65

66 Options Options overview The options section of the DPSearch Admin UI provides the ability to configure and modify system and search options. Click Modify to configure the options. You can also click Disable/Enable to configure Notification options. The following table lists the available options. Table 17 System and search options System or search option Search options Session options LDAP options Index options Notification options Description Set the max hits to restore, limits the number of files that can be restored in one session. You can set the range from 101 to 5000 files. Set the session inactivity time out for both the Admin UI and the Search UI. The default is 1 hour before a login is required. You can set the range from three minutes to 24 hours. Modify the LDAP users/options (host) specified at deployment. Specify file types to exclude from full-content indexing. Specify to update the number of replicas. This setting is applied to existing and future indexes. Enable notifications and set SMTP options. The following table lists jobs and activities that trigger notifications. Table 18 Supported notifications Activity Restore operation Collection job (metadata or fullcontent) Index state Backup server state Notification trigger When a restore operation completes. Succeeds, fails, stops or times out. The notification is sent to the Search Admin. When a collection job completes. Succeeds, fails, stops or times out. The notification is sent to the Admin that created the activity or forced a Run now. When an index changes state (health, warning or error), the notification is sent to all Index Admins. When the backup server changes state (healthy or disconnected), the notification is sent to all DPSearch Admins. Configuring System notifications Use the following procedure to configure Data Protection Search to send notifications to specified SMTP users and hosts. Procedure 1. Click Modify or Disable/Enable to configure notifications for Data Protection Search. 66 EMC Data Protection Search 1.0 Installation and Administration Guide

67 Options Notifications is disabled by default. 2. Click the check box to enable notifications, and complete the following fields: SMTP (IP of the SMTP host) Port SMTP User Password All configured notifications are also listed in System Notifications on the dashboard. Notifications are always on, you can enable or disable whether an is sent. 3. Click Validate. Results Click to select the notification and view its details. Notifications take affect 15 minutes after this setting is enabled. Configuring System notifications 67

68 Options 68 EMC Data Protection Search 1.0 Installation and Administration Guide

69 CHAPTER 11 Search Data Protection Search is a Google like search. This section includes the following topics: Search overview Logging in to the Search user interface Search by using keywords Data Protection Search indexing...73 Search results Search criteria management...75 Search performance factors...78 Search 69

70 Search Search overview DPSearch provides the ability to perform full index or metadata searches by using keywords and Lucene queries. Search results include a summary of certain fields for the file, such as filename, location, backup client, and so on. If a keyword or phrase is found in the filename or path, it is highlighted. If a file was full-content indexed, and a keyword or phrase is found in the body of the file, a snippet of the full contents is returned, displaying the words around the matched text. You can specify the number of hits to display per page. By default, the search is sorted by score, which is how well the hits match the search criteria. Click the Sort Score: drop down to change the sort order. Details on additional search criteria is available in Search Criteria on page 75. Logging in to the Search user interface After completing the Data Protection Search virtual appliance deployment, configuration and content indexing, use the following procedure to log in to the Search UI. Before you begin To log in to the Search UI, you must be a Search Admin for at least one index. Figure 4 Search login screen Procedure 1. Point the browser at: 2. Type the user name in the User names field. Log in by using any of the following formats: <samaccountname>, for example, myusername <domain>/<samaccountname>, for example, mydomain/myusername 70 EMC Data Protection Search 1.0 Installation and Administration Guide

71 Search for example, 3. Type the password in the Password field. 4. Click Login. Search by using keywords The Search web window appears. Log in to the Search UI each time it is opened, or after an inactivity time out (1 hour by default). The default inactivity timeout can be modified in the Options section of the Admin UI. Use the following procedure in Data Protection Search to search by using keywords: Procedure 1. Type the keywords in the Search field. The results are returned with the keywords highlighted in both the filename and the contextual snippet of the original text located underneath the filename, location and item specific metadata. 2. Click Preview to view a larger preview of the original text pulled from the index. Full-content indexing provides all of the text without the original application formatting. A near real representation of the file is displayed with enough data to identify the file. Image files have a thumbnail instead. It is not be possible to create a preview for all files. In some cases, a preview will not be available. If a full-content indexed file contains less than 2 MB of text, the preview includes the original formatting, where possible. If there is more than 2 MB of text, only the text itself is included in the preview, without formatting. Embedded images are never included in the preview, regardless of file size. 3. Click the filename to download the entire file (full access permissions are required). This action retrieves the file from the backup server to the DPSearch node. A pop-up window opens briefly in the bottom left corner of the browser indicating that the download is in progress. The View Jobs dialog can be used to monitor progress of the download. Once the download is complete, there is a link in the View Jobs dialog for file to be downloaded to the client from which the web browser is connecting. Most browsers provide the ability to open or save the file. If you open the file, it is opened in a registered application for that file type, if one exists. 4. Click Add Criteria to refine the search and narrow the search results. Search criteria management on page 75 provides complete details on the available search criteria and how to use them. 5. Click the Search icon. Restore files in Data Protection Search The results are displayed with the strongest matches listed at the top. Data Protection Search provides the ability to restore files back to their original location on the client from which they were originally backed up. Files can also be restored to an Search by using keywords 71

72 Search Using Lucene to search alternate location on that client, or to an entirely different client on the same backup server. Use the following procedure to restore individual, multiple, or all of the files to their original location or an alternate location (within the restrictions of the backup server). Preview is available for search hits resulting from full-content indexed searches to verify that you have located the correct files to restore. Procedure 1. Click Restore below an individual file. 2. Click the check box beside multiple files and then click Restore. 3. Click the check box above the search results list to select all of the files on the current page, and click Restore. When restoring multiple files, ensure all files come from same backup server. Choosing to restore multiple files from different backup servers might cause the restore operation might fail. Use the following procedure to perform advanced keyword searches using Lucene in Data Protection Search. Before you begin A knowledge of Lucene is required to return accurate search results in Data Protection Search. More information on Lucene searches is available at: Table 19 Example Lucene syntax Syntax examples field:value - field:"phrase " field :(value1 OR value2) _ missing_:field _ exists_: field field:qu?ck bro * field:quikc ~ brwn ~ foks ~ - "fuzzy" match field:"fox quick"~ 5 - proximity date:{" t00:00:00.000z" TO " T00:00:00.000Z"} Description The field contains the value The field contains exact phrase The field contains one or both values The field has no value or is missing The field has any non-null value Use wildcards Words that are similar No more than 5 words between them Match any date in range date:{* TO " T00:00:00.000Z"} Dates before 2012 date:" t00:00:00.000z" Specified date search age:> 10 All ages over EMC Data Protection Search 1.0 Installation and Administration Guide

73 Search Table 19 Example Lucene syntax (continued) Syntax examples quick brown +fox -news Description The word fox must be present, news must not be Lucene does not support using an asterisk (*) symbol for the first character of a search string. Procedure 1. Type the Lucene query in the Search field. 2. Click the Search icon to complete the search. Example 2 Example search strings einstein AND "marketing plan" AND platform:avamar AND size:[50000 TO ] AND type:pdf "metadata_author:david Douglas" AND location:executive name:king????er* -jpg Data Protection Search indexing Data Protection Search is capable of completing both Metadata and Full text index searches. Searches automatically search whichever fields are available for the file, whether it's metadata-only or full-content indexed. A single search can cover both types of files. Data Protection Search will always look for keyword matches in the following fields: Name Name custom Location Type If an item was full-content indexed, Data Protection Search will also look for keywords matches in additional fields: Content snippet Item specific metadata Author Subject Title Data Protection Search indexing 73

74 Search Search results Different search results, controls and status are displayed and available for full access search admins versus read only search admins. Table 20 Search results for full access versus read only search admins Search result component Full access search admin Read only search admin Application icon Displayed Displayed Path name Active link to download/open the file No active link to download/open the file File name Displayed Displayed Last modification date Displayed Displayed Client Displayed Displayed Contextual snippet Displayed if one or more keywords was found in the full-content (body) of the file No contextual snippet displayed Platform Same for full, or read only access Displayed File size Displayed Displayed Backup server name Displayed Displayed The following is a list of the various DPSearch controls for search results: Display for the number of matching results Display the time taken for Elasticsearch to process the query Display a dialog to view restore jobs Change sort criteria Display a Restore option for individual files Display a Preview option for individual files (Preview is disabled for read only admins) Certain file types, including.log,.exe,.dll and.bin files are skipped for full-content indexing, and are therefore not available for preview. Displays a More info option to view additional backup fields Check boxes to select multiple items Top level check box to select all items Top level Restore option for multiple items Display the number of matching search results Restore, download and query jobs for the logged in user and the respective results for downloads and queries are shown in View Jobs. 74 EMC Data Protection Search 1.0 Installation and Administration Guide

75 Search The following table describes the specific information available when you click to view More info for a file. Table 21 More Info table More Info item Description Index Information Index Name Full content indexed? Index Date Full name of the index True/False (Metadata index if false) Date the file was indexed by Data Protection Search Item Information Client operating system Created Date Title Author Backup client operating system Date the file was created and item specific metadata. Available for Windows files only that are backed up by the NetWorker server, not Linux or UNIX Only available for full content indexed and found in item-specific metadata Subject Backups All backups containing files are listed here Listed for each file: Backup date, backup number, backup name, and expiration date, and full item-specific metadata information (list of name/values pairs) Search criteria management Add search criteria to narrow and reduce the time taken to return results. The following lists the available Search Criteria: Index Platform Server Client File Name File Type Size Last Modification Date Backup Date Location Unindexable Content Index Lists the indexes that the currently logged in Search Admin has access to. For example, searchadmin1 might have access to index 1 and 2, and searchadmin2 might have access to indexes 2, 3 and 4. Uncheck particular indexes to remove them from the search. Search criteria management 75

76 Search Platform The following filters are available for the Platform criteria: All (default) Avamar NetWorker Server Specify the name of an Avamar or NetWorker server. There is a visual filter available for this option. Client Select a backup server and then specify the name of an Avamar or NetWorker client. File Name The following table lists the available filters for the File Name criteria. Table 22 File Name criteria File Name value Contains (default) Begins with Description Specify a keyword contained in, beginning, or ending with the filename. Can include wildcard characters (*). Ends with File Type Narrow the search by File Type by typing a file extension in the dialog or using the pie chart icon. The pie chart breaks down the current search by frequency of file type. Only the top 10 most frequent file types in the search are shown. Each file type extension is listed below the pie chart. Perform one of the following steps to narrow the search by file type. Click the Pie chart icon. Click a file type extension below the pie chart to eliminate that type of file from the current search. Click a file type extension in the pie chart to limit the search to only that type of file. 76 EMC Data Protection Search 1.0 Installation and Administration Guide

77 Search Figure 5 File Types Size Specify the file size (always in KB). Click the bar chart icon next to the size control to display a visual breakdown of the current search results. The frequency that each range of file sizes occurs is represented in a bar chart. Click one of the bars to rerun the current search filtered by that size range. Last Modification Date Specify the date on which the file was last modified. Greater than, less than, or between also has visual filter. For the Backup Date criteria, jobs are listed in the View Jobs list as Query jobs. When the job completes, click Query Result to view the details. Backup Date Click the bar chart icon next to the date control to display a visual breakdown of the current search results by the year in which they were modified. Click a particular year to further break down the results by month. Click a month to rerun the current search filtered by that date range. Using a wide range for the Backup Date criteria to search for a string can result in a long search window and negatively impact performance. Restrict the range to a single backup date for this filter to avoid performance issues. This job runs in the background to further avoid performance issues. The following table lists the available filters for the Backup Date criteria. Table 23 Backup Date criteria Backup Date value Description Greater Than Specify a backup date value for which the search will return hits between that date and now. Search criteria management 77