Contents

Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide PDF

1 of 126
1 of 126

Summary of Content for Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide PDF

Dell EMC Search Version 18.2

Deployment and Administration Guide 302-005-375

Rev 05

May 2020

Copyright 2018-2020 Dell Inc. or its subsidiaries. All rights reserved.

Dell 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. DELL 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 DELL SOFTWARE DESCRIBED

IN THIS PUBLICATION REQUIRES AN APPLICABLE SOFTWARE LICENSE.

Dell Technologies, Dell, EMC, Dell EMC and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property

of their respective owners. Published in the USA.

Dell EMC Hopkinton, Massachusetts 01748-9103 1-508-435-1000 In North America 1-866-464-7381 www.DellEMC.com

2 Dell EMC Search Deployment and Administration Guide

Preface 7

About Search 11 About Search.....................................................................................................12

Product architecture............................................................................ 12 About the user interface....................................................................................14

Administration windows........................................................................ 14 Search window..................................................................................... 19

Deploying the Search virtual appliance 23 System requirements and compatibility............................................................ 24 VMware disk space size requirements.............................................................. 25

Sizing the index data disk.....................................................................25 Sizing the temporary disk.....................................................................26

Determining the size and number of Search nodes to deploy............................ 27 Sizing and performance guidance for Search nodes.............................27 Node sizing and performance considerations....................................... 28

Configure a DHCP server..................................................................................29 Configure a static IP address............................................................................ 30 Deploying the Search software......................................................................... 30

Deploy the OVA file in a single-node environment................................30 Deploy the OVA file in a multi-node environment................................. 32

Update the Search software............................................................................. 36 Modify the Search upgrade configuration............................................ 37

Log in to the Search virtual appliance for the first time.................................... 39

Configuring Search 41 Configuring a backup source.............................................................................42

Add an Avamar source server to Search...............................................42 Maximum supported servers................................................................ 43 Configuring a source in NetWorker...................................................... 43 Update an Avamar source server......................................................... 45 Update a NetWorker source server...................................................... 47 Remove a source server.......................................................................48 Applying index and search analyzers.................................................... 48 Set connection limitations....................................................................48 Set the blackout window for indexing.................................................. 49 Start a collection on the source........................................................... 49 Start a reconciliation job for a source server or zone........................... 50 View the status and summary of the source......................................... 51 Select zones or restricted data zones...................................................51

Manage indexes.................................................................................................51 Indexing overview.................................................................................51 Configure virtual machine indexing on the Avamar server....................52 Restrict index access........................................................................... 53 View indexes........................................................................................ 54 Updating an index................................................................................ 55

Managing notifications......................................................................................55

Chapter 1

Chapter 2

Chapter 3

CONTENTS

Dell EMC Search Deployment and Administration Guide 3

Configure system notifications............................................................ 55 Configure Avamar notifications............................................................56 Configure NetWorker notifications...................................................... 57 Configure email notifications................................................................57

Replicate data indexes...................................................................................... 58 Set search timeout options............................................................................... 58 Optimize search performance...........................................................................59 Configuring Full Content Indexing (FCI)........................................................... 60

About full content indexing.................................................................. 60 Space requirements for Full Content Indexing (FCI)............................ 60 Application-specific metadata for full content indexing........................ 61 Restrict the index size that is returned from Full Content Indexing (FCI) ............................................................................................................. 61

Managing Roles and Users 63 Configure external OpenLDAP and Active Directory servers.............................64 About roles....................................................................................................... 65

System Administrator role................................................................... 66 Application Administrator role.............................................................. 67 Full Access Search (Global) role.......................................................... 68 Index specific search roles................................................................... 69

Managing roles..................................................................................................73 Assign roles to users or groups.............................................................73 Remove users or groups.......................................................................74 Edit role assignments........................................................................... 75

Using the Dashboard 77 View index health.............................................................................................. 78 View source server health................................................................................. 78 View collector node health................................................................................ 78 View index cluster health.................................................................................. 79 View system notifications................................................................................. 79 View application notifications............................................................................79

Monitoring Jobs, Services, and System Health 81 Jobs.................................................................................................................. 82 Job types and statuses..................................................................................... 82 Monitor search jobs.......................................................................................... 84 Monitor index jobs............................................................................................ 84 Monitor system jobs......................................................................................... 85 Stop a pending or running job........................................................................... 86 View health....................................................................................................... 86 View services.................................................................................................... 86 View agents...................................................................................................... 87

Performing Search and Viewing Search Results 89 About searches................................................................................................. 90

Perform searches................................................................................. 91 Search filters........................................................................................ 91

Optimize search performance...........................................................................93 Optimize search results.................................................................................... 93

Add or remove search filters................................................................ 94 View search jobs.................................................................................. 94

Chapter 4

Chapter 5

Chapter 6

Chapter 7

Contents

4 Dell EMC Search Deployment and Administration Guide

Narrow a search by folder or file.......................................................... 94 Narrow a search by file type................................................................ 95 Narrow a search by file attribute..........................................................96 Narrow a search by date and time attributes........................................97 Include content that was not indexed in the search..............................97 Narrow a search by backup date.......................................................... 97 Narrow a search by backup source or client.........................................98

Using keywords to search................................................................................. 98 Perform a basic search........................................................................ 99 Perform an advanced search by using a Lucene query.........................99 Perform a search on a full content indexed file....................................101

Sort search results........................................................................................... 101 View search result metadata............................................................................ 101 Batch operations............................................................................................. 102 Download a file from search results................................................................. 102 Restore a file from search results (file system or NDMP files)........................ 103 Restore a file from search results (virtual machine files)................................. 104 Full content index searches............................................................................. 105

Perform a search on a full content indexed file................................... 105 Search for files that have not undergone a full content index............. 106 Restrict a search to only Full Content Index (FCI) files.......................106 Search for application-specific metadata........................................... 106

Troubleshooting 109 Troubleshoot deployment issues...................................................................... 110 Log files........................................................................................................... 110

Copy log files (WinSCP)......................................................................112 Copy log files (PuTTy) ....................................................................... 112

Managing logs.................................................................................................. 113 Managing logs for API-based services................................................. 113 Managing logs for Worker and Action services....................................115 Managing logs for Elasticsearch.......................................................... 117 Managing logs for Nginx......................................................................119 Manage logs for the Puppet agent......................................................120

Troubleshooting the web server....................................................................... 121 Edit the Search nginx.conf file......................................................................... 121 Troubleshooting worker services for indexing issues........................................ 121 Increase the maximum memory for the search-avamar-worker service........... 122 Increase the maximum memory for the search-networker-worker service...... 123 Troubleshooting Elasticsearch......................................................................... 123

Control the Elasticsearch service........................................................123 View Elasticsearch logs.......................................................................123 View or change the Elasticsearch configuration..................................124 Monitor the health of the Elasticsearch cluster.................................. 124 Insufficient memory causes the Elasticsearch service to shutdown.... 124

Appendix

Contents

Dell EMC Search Deployment and Administration Guide 5

Contents

6 Dell EMC Search Deployment and Administration Guide

Preface

As part of an effort to improve product lines, periodic revisions of software and hardware are released. Therefore, all versions of the software or hardware currently in use might not support some functions that are described in this document. The product release notes provide the most up-to-date information on product features.

If a product does not function correctly or does not function as described in this document, contact a technical support professional.

Note: This document was accurate at publication time. To ensure that you are using the latest version of this document, go to the Support website https://www.dell.com/support.

Revision history

This revision history provides a description for each revision of this Administration guide.

Table 1 Search revision history

Revision Date Changes

05 May 7, 2020 This revision includes the following updates:

l Corrected step 2 b in the section "Log in to the Search virtual appliance for the first time".

l Corrected step 9 in the section "Configure external OpenLDAP and Active Directory servers".

l Updated the note in the section "Start a reconciliation job for a source server or zone".

04 December 5, 2019 Corrected the syntax for a specified date search in the section "Perform an advanced search by using a Lucene query".

03 July 25, 2019 Added the section "Search filters" to the "Performing Searches and Viewing Search Results" chapter.

02 January 18, 2019 The following changes are included in this revision:

l Updated the prerequisites in the section "Update the Search software".

Dell EMC Search Deployment and Administration Guide 7

Table 1 Search revision history (continued)

Revision Date Changes

l Revised the "Default Avamar server limit section" to indicate the maximum number of servers that the Search software supports. This section has been renamed to "Maximum supported servers".

01 December 14, 2018 GA release of the Search 18.2 Deployment and Administration Guide.

Purpose

This document describes how to deploy, configure, and use Search.

Audience

This document is intended for an administrator who manages Search.

Related documentation

The following publications provide additional information:

l Search Deployment and Administration Guide

l Search Security Configuration Guide

l E-Lab Navigator at https://elabnavigator.emc.com/eln/elnhome

l Search Release Notes

Special notice conventions that are used in this document

The following conventions are used for special notices:

CAUTION A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem.

Note: A Note indicates important information that helps you make better use of your product.

Typographical conventions

The following type style conventions are used in this document:

Table 2 Style conventions

Bold Used for interface elements that a user specifically selects or clicks, for example, names of buttons, fields, tab names, and menu paths. Also used for the name of a dialog box, page, pane, screen area with title, table label, and window.

Italic Used for full titles of publications that are referenced in text.

Monospace Used for:

l System code

Preface

8 Dell EMC Search Deployment and Administration Guide

Table 2 Style conventions (continued)

l System output, such as an error message or script

l Pathnames, file names, file name extensions, prompts, and syntax

l Commands and options

Monospace italic Used for variables.

Monospace bold Used for user input.

[ ] Square brackets enclose optional values.

| Vertical line indicates alternate selections. The vertical line means or for the alternate selections.

{ } Braces enclose content that the user must specify, such as x, y, or z.

... Ellipses indicate non-essential information that is omitted from the example.

You can use the following resources to find more information about this product, obtain support, and provide feedback.

Where to find product documentation

l https://www.dell.com/support

l https://community.emc.com

Where to get support

The Support website https://www.dell.com/support provides access to product licensing, documentation, advisories, downloads, and how-to and troubleshooting information. The information can enable you to resolve a product issue before you contact Support.

To access a product-specific page:

1. Go to https://www.dell.com/support.

2. In the search box, type a product name, and then from the list that appears, select the product.

Knowledgebase

The Knowledgebase contains applicable solutions that you can search for either by solution number (for example, KB000xxxxxx) or by keyword.

To search the Knowledgebase:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Knowledge Base.

3. In the search box, type either the solution number or keywords. Optionally, you can limit the search to specific products by typing a product name in the search box, and then selecting the product from the list that appears.

Live chat

To participate in a live interactive chat with a support agent:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Contact Support.

3. On the Contact Information page, click the relevant support, and then proceed.

Preface

Dell EMC Search Deployment and Administration Guide 9

Service requests

To obtain in-depth help from Licensing, submit a service request. To submit a service request:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Service Requests.

Note: To create a service request, you must have a valid support agreement. For details about either an account or obtaining a valid support agreement, contact a sales representative. To find the details of a service request, in the Service Request Number field, type the service request number, and then click the right arrow.

To review an open service request:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Service Requests.

3. On the Service Requests page, under Manage Your Service Requests, click View All Dell Service Requests.

Online communities

For peer contacts, conversations, and content on product support and solutions, go to the Community Network https://community.emc.com. Interactively engage with customers, partners, and certified professionals online.

How to provide feedback

Feedback helps to improve the accuracy, organization, and overall quality of publications. You can send feedback to DPAD.Doc.Feedback@emc.com.

Preface

10 Dell EMC Search Deployment and Administration Guide

CHAPTER 1

About Search

This section includes the following topics:

l About Search......................................................................................................................... 12 l About the user interface........................................................................................................ 14

Dell EMC Search Deployment and Administration Guide 11

About Search Search is a virtual appliance that supports indexing and searching across one or more backup servers. In Search, a backup server is known as a source.

With Search you can perform the following actions:

l Index and search for files by name, location, size, owner, file type, and date.

l Perform a targeted Full Content Index (FCI) on search results to view a preview of the content and search for keywords and content inside.

l Restore files directly from search results.

l Perform advanced search queries including symbols, wildcards, filters, and operators.

l Preview and download search results.

Product architecture Search is a pre-installed, Linux-based virtual appliance.

The following figure illustrates the components that are included in the Search virtual appliance.

Figure 1 Search components

The following table describes Search components.

Table 3 Search components

Component Description

Apache Tika An open source toolkit that can extract full-text content and application-specific metadata from a wide variety of file types.

Common Index Service (CIS) 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 above Elasticsearch to prevent unauthorized access.

About Search

12 Dell EMC Search Deployment and Administration Guide

Table 3 Search components (continued)

Component Description

Elasticsearch A highly scalable, high-performance full-text index and search technology with built-in replication, and capable of searching billions of objects within seconds. Elasticsearch leverages Apache Lucene for its indexes.

Search user interface The primary interface for administrators to configure Search and users to search, preview, and download indexed content.

LDAP Authentication Server Search includes a built-in OpenLDAP authentication server with predefined users for administration and search operations. Additional Active Directory and OpenLDAP authentications servers can be added after configuration.

NGINX web server An open source, reverse-proxy web server that hosts the web-facing components of Search.

Worker Services A service that handles interactions with sources. The Worker Service includes both metadata indexing like scanning and monitoring and search actions like downloading and Full Content Indexing.

Single-node or multi-node deployment Each Search virtual appliance contains all the components that are required to provide index and search operations. Additional nodes can be added to form a Search cluster.

Add additional nodes to:

l Improve the speed of indexing, monitoring, and search queries

l Store more indexed metadata and files that have had their full content indexed

l Provide replication

The following figure illustrates an example of a multi-node environment.

About Search

Dell EMC Search Deployment and Administration Guide 13

Figure 2 Search multi-node environment

Replication A Search cluster can include one or more nodes. Additional nodes improve search performance and provide the option for replication.

To enable data index replication, connect to the UI as a user with the Application Administrator role, and then click Administration > Options > Index Options. Toggle the Index replica switch to ON. By default, the Index replica option is disabled.

If more than one Search node exists, system indexes are replicated automatically. Data indexes are only replicated when enabled.

Note: Enabling data index replication doubles the total amount of disk space that is required. If multiple nodes exist, it is recommended that the Index replica option is not set to 0. If the Index replica option is not set, failover cannot occur.

About the user interface The Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can perform administration or search tasks.

Administration windows Administer, configure, and customize Search by using the Administration windows.

There are three main Administration window views:

l System Administration view l Avamar Administration view l NetWorker Administration view

Open the Administration window, by clicking .

To access the Avamar Administration view, in the Manage drop-down list, select Avamar.

To access the System Administration view, in the Manage drop-down list, select System.

To access the NetWorker Administration view, in the Manage drop-down menu, select NetWorker.

About Search

14 Dell EMC Search Deployment and Administration Guide

Note: The default Admin user can assume the following roles:

l System Administrator

l Avamar Application Administrator

l NetWorker Application Administrator

l Avamar Full Access Search (Global)

l NetWorker Full Access Search (Global)

You can unassign roles from the default Admin user. However, ensure that each administration role is assigned to a user or group. You can assign one, all, or a subset of roles to additional users.

Access the Administration window The Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can perform administration or search tasks.

Before you begin

If you are logging in to the Administration window for the first time, use the default OpenLDAP user Admin and the password that was configured during installation.

Ensure that cookies are enabled in the browser.

You are required to log in to the Search UI each time it is opened or after a 20-minute period of inactivity.

About this task

To perform administration tasks, you must be assigned one or both of the following roles:

l System Administrator role

l Application Administrator role

To perform administration tasks, complete the following steps.

Procedure

1. Open the Search UI.

To access Search through a web browser:

a. Open a web browser and type the following URL:

https://nodename/admin

For example: https://10.25.110.211/admin https://MySearchNode/admin

Note: You might be required to acknowledge a browser warning about self-signed certificates before continuing.

b. Continue to the following step.

2. Log in to Search:

a. Type the username and password.

Note: The default username is Admin.

b. Click Sign In.

About Search

Dell EMC Search Deployment and Administration Guide 15

The Welcome window appears and lists the administration tasks.

3. To open the Administration window, click , and then click .

The Administration window appears and displays the available menu items.

4. To open the Search window, click , and then click .

The Search window appears and displays the search options. Note: Search cannot begin until at least one source has been indexed.

Avamar Administration view The Avamar Administrator can configure a source and manage Search activities and operations. Only an Avamar Administrator can access the Avamar Administration view.

The following figure displays the Search Avamar Administration view.

Figure 3 Avamar Administration view

To access the Avamar Administration view, in the Manage drop-down list, select Avamar. This action opens the Avamar Administration window and displays the available menu items.

To browse to a section in the Avamar Administration window, click a menu item.

The following table describes the features of the Avamar Administration window.

Table 4 Avamar Administration window features

Icon Description

View a summary of the health and status for the various Search components.

Modify or enable the following items:

l Index options

l Full content indexing options

About Search

16 Dell EMC Search Deployment and Administration Guide

Table 4 Avamar Administration window features (continued)

Icon Description

l LDAP options

l Notifications

Add, update, or remove sources.

Manage access to individual indexes.

Assign the following roles:

l Full Access Search (Index)

l Read Only Search (Index)

Lists running and completed activities and jobs.

Details include type, status, and duration.

Add, update, or remove the following roles:

l Application Administrator

l Full Access Search (Global)

NetWorker Administration view The NetWorker Administrator can configure a source and manage Search activities and operations. Only a NetWorker Administrator can access the NetWorker Administration view.

The following figure displays the Search NetWorker Administration view.

Figure 4 NetWorker Administration view

About Search

Dell EMC Search Deployment and Administration Guide 17

To access the NetWorker Administration view, in the Manage drop-down list, select NetWorker. This action opens the NetWorker Administration window and displays the available menu items.

To browse to a section in the NetWorker Administration window, click a menu item.

The following table describes the features of the NetWorker Administration window.

Table 5 NetWorker Administration window features

Icon Description

View a summary of the health and status for the various Search components.

Modify or enable the following items:

l Full content indexing

l Index options

l LDAP options

l Notification options

Add, update, or remove sources.

Manage access to individual indexes.

Assign the following roles:

l Full Access Search (Index)

l Read Only Search (Index)

Lists running and completed activities and jobs.

Details include type, status, and duration.

Add, update, or remove the following roles:

l Application Administrator

l Full Access Search (Global)

System Administration view The System Administrator can configure LDAP servers and manage certain Search activities and operations. Only a System Administrator can access the System Administration view.

The following figure displays the Search System Administration view.

About Search

18 Dell EMC Search Deployment and Administration Guide

Figure 5 System Administration view

To access the System Administration view, in the Manage drop-down list, select System. This action opens the System Administration window and displays the available menu items.

To browse to a section in the System Administration window, click a menu item.

The following table describes the features of the System Administration window.

Table 6 System Administration window features

Icon Description

View a summary of the health and status for the Search system.

Modify or enable the following:

l LDAP options

l Notification options

l Search options

Monitor Search nodes

Add, update, or remove the System Administrator role.

Search window The Search software performs metadata searches on indexed files and folders, and full content searches on files that have had their full content indexed. Search supports keyword and advanced Lucene search queries. Search results include a summary of certain fields, such as file name, location, size, and date.

About Search

Dell EMC Search Deployment and Administration Guide 19

Search provides the following highlighting techniques:

l If a file is indexed for metadata, keywords or phrases that are found in the name of the file name or path are highlighted.

l If a file is indexed for full content indexing, keywords or phrases that are found in the body of the file are returned with a preview of the full contents. The preview displays and highlights the words around the matched text.

By default, the search is sorted by relevance, which defines how well the search results match the search criteria.

The following figure displays the Search window within the Search UI.

Figure 6 Search window

Note: The filtering options that are displayed in the Search UI change depending on the permissions of the user and the options that are selected. Search filters on page 91 provides more information.

Access the Search window The Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can complete administration or search tasks.

About this task

To perform searches, you must be assigned one of the following roles:

l Full Access Search (Index)

l Read Only Search (Index)

l Full Access Search (Global)

Note: You are required to log in to the Search UI each time it is opened or after a 20-minute period of inactivity.

To perform searches, complete the following steps.

About Search

20 Dell EMC Search Deployment and Administration Guide

Procedure

1. In a web browser, type the following URL:

https://nodename/search Note: Before continuing, you might be required to acknowledge a browser warning regarding self-signed certificates.

2. Log in to Search:

a. Type the username and password.

Note: The default username is Admin.

b. Click Sign In.

The Search window opens.

About Search

Dell EMC Search Deployment and Administration Guide 21

About Search

22 Dell EMC Search Deployment and Administration Guide

CHAPTER 2

Deploying the Search virtual appliance

This section includes the following topics:

l System requirements and compatibility.................................................................................24 l VMware disk space size requirements...................................................................................25 l Determining the size and number of Search nodes to deploy.................................................27 l Configure a DHCP server...................................................................................................... 29 l Configure a static IP address.................................................................................................30 l Deploying the Search software............................................................................................. 30 l Update the Search software................................................................................................. 36 l Log in to the Search virtual appliance for the first time.........................................................39

Dell EMC Search Deployment and Administration Guide 23

System requirements and compatibility Before you install the Search virtual appliance, ensure that the system meets the following requirements.

Table 7 System requirements

Component Requirements

Network settings l A minimum of two Search nodes to leverage Elasticsearch replication.

l Single-node configuration is also supported.

l You can use DHCP or static network settings.

If static network settings are used, you must provide the following information:

l Static IP address (IPV4 required, IPV6 optional)

l Netmask

l Gateway (IPV4 required, IPV6 optional)

l Server name

l Domain search

l (Optional) One or more time servers

VMware vCenter server

l You must deploy the virtual machine using vCenter server 5.x or 6.x. The Search OVA does not deploy directly to the ESXi host.

l 8 vCPUs. Fewer than 8 vCPUs might decrease index and search performance.

l 32 GB of RAM

l 180 GB of disk space (thick provisioned). You can increase the index data disk space from 100 GB to 2 TB.

The following table includes information about the versions of products that are supported with the Search virtual appliance.

Table 8 Search compatibility

Product Supported versions

Avamar 7.3 or later.

NetWorker 9.0 or later.

Mozilla Firefox Latest version

Google Chrome Latest version

Internet Explorer Latest version

Updated, detailed compatibility information is available in the E-Lab Navigator at https:// elabnavigator.emc.com/eln/elnhome.

Deploying the Search virtual appliance

24 Dell EMC Search Deployment and Administration Guide

VMware disk space size requirements This section describes VMware disk and index space requirements.

The virtual machine is preconfigured with three disks with a total of 180 GB of space.

l Disk 1: 40 GB of system disk space

l Disk 2: 100 GB of index data space

l Disk 3: 40 GB of temporary space

To support a larger number of metadata files, you might need to expand the disk space for the index data disk (disk 2) and the temporary disk (disk 3). To increase the size of either the index data disk or the temporary disk, implement the increase before the virtual machine starts for the first time.

The following sections provide more information about sizing.

Sizing the index data disk The default size for the index data disk (disk 2) supports the metadata for approximately 175 million files. For larger environments, increase the disk size.

Index data disk space requirements are based on the following projected number of metadata records:

Table 9 Index data disk space requirements

Number of files Required disk space

200 million 120 GB

500 million 300 GB

1 billion 600 GB

2 billion 1.2 TB

4 billion 2.4 TB

Additional information

Review the following considerations:

l More disk space is required when you implement full content indexing.

l When you expand the system limits and increase temporary drive data, the partition limit is 2 TB.

l While a single Search node is limited to 2 TB of index space, you can add additional Search nodes to increase the total amount of index space.

l The total disk space that is required can be divided by the number of Search nodes.

l If replication on data indexes is enabled, twice as much disk space is required.

l The file counts are for unique files. A file that is unchanged in several backups remains a single file in the index.

Example 1 Indexing a Search environment

You can use the Search software to index the following environment:

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 25

Example 1 Indexing a Search environment (continued)

l Five Avamar servers

l Each server has 1000 clients (5000 total)

l Each client has ~500,000 files

l Avamar keeps the last 30 daily backups, with a 2% daily change range.

In this example, the Search software generates an estimated 4 billion unique files in the index. Without replication, those files might consume an estimated 2 TB of disk space, which requires at least 1 Search node. With replication, those files might consume an estimated 4 TB and require at least 2 Search nodes.

Sizing the temporary disk Disk 3, known as the temporary (search) disk, performs the following functions:

l Holds logs for the Search product and other third-party components, such as Nginx and Elasticsearch.

l Provides a temporary location for upgrading.

l Holds temporary files for full content indexing.

l Holds temporary file lists while indexing the metadata of certain backup types. Some backups, such as NDMP backups, contain a large number of files that consume a significant amount of space. At deployment, you might be required to increase the size of the temporary disk from the default 40 GB.

This step is only required when you index one or more of the following backup types:

n Avamar Windows VMware Image

n NetWorker File System

n NetWorker NDMP

For backups with 5 million files or less, the default size of 40 GB is sufficient. To support backups with a larger number of files, increase the size of the temporary disk (disk 3). For example, NDMP backups have larger file counts. For NDMP backups, you might be required to increase the size of the temporary disk (disk 3).

Use the following formula to calculate the required size:

1. Size in GB = 22 GB + ((largest file count / 5 million) * 18 GB)

2. If both Avamar and NetWorker backups are indexed, double the result.

The following table provides guidance for temporary disk space requirements.

Table 10 Temporary disk space requirements

Largest backup Required size for disk 3 Indexing both Avamar and NetWorker

5 million files 40 GB 80 GB

10 million files 58 GB 116 GB

20 million files 94 GB 188 GB

50 million files 202 GB 404 GB

Deploying the Search virtual appliance

26 Dell EMC Search Deployment and Administration Guide

Table 10 Temporary disk space requirements (continued)

Largest backup Required size for disk 3 Indexing both Avamar and NetWorker

100 million files 382 GB 764 GB

200 million files 742 GB 1.5 TB

500 million files 1.8 TB 3.6 TB

Determining the size and number of Search nodes to deploy The following sections provide recommendations for node sizing, scaling, and performance.

Sizing and performance guidance for Search nodes Use the information in this section as a general guide for determining the number of nodes that are required for indexing.

Consider the following information when determining node sizing:

l The total number of clients to index across all backup servers

l Whether index replication is required

The following table provides recommendations for estimating the number of Search nodes that are required for indexing.

Note: Node sizing requirements vary for specific environments. It is recommended that you review Node sizing and performance considerations on page 28 for sizing the nodes in the cluster to meet your performance requirements.

Table 11 Node sizing and performance estimates

Total Clients

Estimate d files

Estimate d unique files over 30 days of backups

No replication With replication

Estimated total space (GB)

Recommende d nodes

Data disk per node (GB)

Estimated total space (GB)

Recommende d nodes

Data disk per node (GB)

250 125 million

200 million

112 1 112 224 2 112

500 250 million

400 million

224 2 112 447 4 112

1,000 500 million

800 million

447 4 112 894 8 112

2,500 1 billion 250 million

2 billion 1,118 8 140 2,235 16 140

10,000 5 billion 8 billion 4,470 24 186 8,941 48 186

Assumptions

l Each client has 500,000 files:

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 27

n If each client has an average of 4 million files, multiply the number of clients by 8.

n NDMP clients are much larger than normal clients, and less scalable when indexing. Therefore, an NDMP client with 50 million files may count as 100 normal" clients (50 million divided by 500,000). However, a single backup cannot be split over multiple nodes for indexing. In this situation, an NDMP client with 50 million files might count as more than 100 "normal" clients.

l The Search software supports a mix of clients and backups:

n NetWorker file system and NDMP

n Avamar file system, virtual machine, and NDMP

l Some backup types are faster to index than others

Note: If the initial deployment does not meet your performance needs, you can add extra nodes later on, with no downtime for the existing nodes.

Node sizing and performance considerations When determining how many Search nodes are required for a particular environment, consider the following points:

l Time to complete indexing for daily backups

l Amount of index data space that is required

l Search speed

l Whether replication is required

The following topics provide more information.

Time to complete indexing for daily backups

Indexing occurs in two stages. The first stage processes a backlog of existing backups. When you add a backup server for indexing, each client might index 30, 60, or 265 backups. This process can take a long time to complete. For example, 1,000 clients with a year of daily backups might index 365,000 backups. To increase indexing performance, specify a smaller date range for processing backups, or choose to process only new backups.

The second stage is most important for sizing purposes. In this stage, the Search software processes daily backups. That is, after the backlog has been processed, Search typically only has to index the daily backup for each client. For example, 1000 clients can process 1000 daily backups.

It is important that Search can index daily backups within a 24-hour window, adjusting for a blackout window that may be configured. Ensure that you size the Search cluster appropriately.

If each client has an average of 500,000 files, a single Search node can process six backups every 10 minutes depending on the number of changed files. If a client has only a few changed files, or most clients contain file system backups, then less time may be required to process the backups. If a client has many changed files, or most clients are virtual machine backups, then backups might take longer to process. NDMP backups have larger file counts and require significantly more time to process. Also, a single large backup can only be processed on a single node and cannot be scaled across many nodes, which might result in a bottleneck.

The Search software can index Avamar File System and NDMP backup data faster than other backup types. The indexing process for NetWorker File System and Avamar Virtual Machine backups takes twice as long. Additionally, NetWorker NDMP backups take four times as long to index. Therefore, it might take longer to process a large mix of slower backups, while a large mix of faster backups can process more quickly.

Deploying the Search virtual appliance

28 Dell EMC Search Deployment and Administration Guide

For larger indexes, indexing performance may be reduced. If the time to complete indexing of daily backups exceeds 24 hours after some months or years, add additional nodes to improve indexing performance.

Required index space

The metadata for each unique file in the Search indexes consumes approximately 600 bytes. However, the space that is required for indexes depends on various factors, such as the length of file names and path names. A unique file is unchanged in one or more backups for the same client. If the same file is unchanged in 20 consecutive backups, it still appears only once in the index. Enabling replication for data indexes doubles the amount of disk space that is required for each unique file.

The maximum data disk size for each node is 2 TB, although 1 TB is recommended as a better balance of performance and storage.

For example:

1000 clients with an average of 400,000 unique files consume approximately 223 GB (1000 * 400,000 * 600) / 1024 / 1024 / 1024) of space. When adjusted for unique files over 30 days of backups, a total of 358 GB of space is required, which comfortably fits on a single node. If replication is enabled, the amount of space used increases to 715 GB, which is still sufficient for a single node. However, at least two nodes are required for replication.

Generally, index data space is not as important as indexing speed for determining the number of Search nodes to deploy.

Search speed

The Search and Elasticsearch framework is immediate, 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. Search performance is also impacted when a search query is complex, indexing is running during the search, or many searches are being carried out simultaneously.

You can reduce search times by applying filters to narrow the search scope and limit the number of results. Additionally, you can add more Search nodes to further increase the speed at which search results are returned. Additional Search nodes enable collection activities to process faster, as the work items are distributed across all nodes. Therefore, the more nodes that are deployed, the faster the search.

Replication

Enabling index data replication provides failover support for the Search cluster. Index replication keeps a redundant copy of index data that is spread over available nodes, providing high availability. If one node fails, the indexes are still available. Replication can improve search performance. If replication on data indexes is enabled, twice as much disk space is required. Replication requires the deployment of at least two indexing nodes.

Configure a DHCP server If you are using a DHCP server, perform the following steps.

Procedure

1. Set up the DHCP server to dynamically update the DNS for clients that do not request updates.

2. Select the following option:

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 29

Dynamically update DNS A and PTR records for DHCP clients that do not request updates. For example, clients running Windows NT 4.0

Configure a static IP address If you are planning a multi-node deployment environment, configure the DNS server with the node names and IP addresses of all the nodes that you plan to deploy.

Configuring static IP addresses is not required for a single-node deployment, but it is recommended.

Deploying the Search software Learn how to deploy the Search software in a single-node and multi-node environment.

Deploy the OVA file in a single-node environment Each Search virtual appliance contains all of the components that are required to provide index and search operations. You can add nodes to form a Search cluster.

About this task

Deploy the Search OVA on a VMware vSphere client. Refer to the VMware documentation for specific information about how to deploy an OVA template.

Procedure

1. From the Support website download the OVA package:

https://support.emc.com

2. Log in to the vCenter server by using the vSphere client.

3. In the Navigator pane, select a server.

4. Right-click the server, and then select Deploy OVF Template.

The Deploy OVF Template wizard appears.

5. In the Select template window:

a. Browse to the OVA package:

l Type the URL path to the OVA package.

l Click Browse and browse to the OVA package location.

b. Click Next.

6. In the Select name and location window:

a. Specify a name for the virtual appliance and the location.

b. Click Next.

7. In the Select a resource window, select a resource, and then click Next.

8. Review the details for the VM and click Next.

9. Accept the End User License Agreement (EULA) and click Next.

10. In the Select storage window:

a. In the Select virtual disk format drop-down list, select the virtual disk format.

Deploying the Search virtual appliance

30 Dell EMC Search Deployment and Administration Guide

When you select the virtual disk format, the Thick Provision Lazy Zeroed option is recommended.

Note: The Thick Provision Eager Zeroed option yields the best performance but also take the most time to initialize. Thick provisioning does not fill the drive unless eager zeroed is selected. If thick provisioning is selected, the storage capacity for the entire virtual disk is allocated on the data store when the virtual disk is created. With thin provisioning, the capacity on the data store is allocated to the virtual disk as required, up to the file size of the virtual disk.

b. In the VM storage policy drop-down list, select the destination data store on which to store the virtual appliance files.

c. Click Next.

11. In the Select networks window, select the source and destination networks to use with the appliance, and then click Next.

12. In the Customize template window, specify the following network settings:

Note: If you have DHCP configured, disregard this step.

a. In the DHCP mode field, select False.

b. In the DNS field, specify one or more DNS servers.

Note: Configure the DNS server with the node name and IP of the node that you plan to install.

c. In the Default Gateway field, specify the IP address of the network gateway.

d. In the Domain Search Path field, specify the domain search path for the VM.

e. In the Network Address field, type an IPv4 address and a netmask.

f. (Optional) To support a mixed mode, you can specify IPv6 address in the Network IPv6 address field, and the gateway in the Default IPv6 gateway field.

Note: The Search software does not support IPv6 mode only.

13. For the first node in the cluster, specify the following search settings:

a. In the Search Master drop-down list, select True.

b. Leave the Search Master Hostname field blank.

14. In the Customize template window, specify the following system settings:

a. In the Administrator Password field, type the administrator password.

The administrator password cannot contain any of the following characters:

$ \ ( ) < > | ; ` & and space.

b. In the Fully Qualified Domain Name field, type the hostname for the node.

c. In the Root Password field, specify the root password to be used for initial login.

d. (Optional) In the Time server field, specify one or more time servers for the VM, separated by a space.

e. In the Time Zone field, specify the time zone for the Search node.

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 31

f. Click Next.

15. In the Ready to complete window:

a. Review the settings.

b. Click Finish.

16. (Optional) To edit the settings for the node, right-click the node, and then select Edit Settings.

If required, you can increase the size of the index data disk (Disk 2) and the temporary disk (Disk 3). For more information, see VMware disk space size requirements.

17. To configure the node, right-click the node, and then select Power > Power On.

This process typically takes 1520 minutes to complete.

Deploy the OVA file in a multi-node environment Each Search virtual appliance contains all the components that are required to provide index and search operations. You can add nodes to form a Search cluster.

Add extra nodes to:

l Improve the speed of indexing, monitoring, and search queries

l Store more indexed metadata and files that have had their full content indexed.

l Provide replication

If you are planning a multi-node deployment environment, configure the DNS server with the node names and IP addresses of all of the nodes that you plan to deploy.

Deploy the master node Deploy the Search OVA on a vCenter server by using the vSphere client. Install the Search OVA to a vCenter server, not to a bare-metal ESXi hypervisor or a non-VMware solution. Refer to the VMware documentation for specific information about how to deploy an OVA template.

Procedure

1. From the Support website download the OVA package:

https://support.emc.com

2. Log in to the vCenter server by using the vSphere client.

3. In the Navigator pane, select a server.

4. Right-click the server, and then select Deploy OVF Template.

The Deploy OVF Template wizard appears.

5. In the Select template window:

a. Browse to the OVA package:

l Type the URL path to the OVA package.

l Click Browse and browse to the OVA package location.

b. Click Next.

6. In the Select name and location window:

a. Specify a name for the virtual appliance and the location.

b. Click Next.

Deploying the Search virtual appliance

32 Dell EMC Search Deployment and Administration Guide

7. In the Select a resource window, select a resource, and then click Next.

8. Review the details for the VM and click Next.

9. Accept the End User License Agreement (EULA) and click Next.

10. In the Select storage window:

a. In the Select virtual disk format drop-down list, select the virtual disk format.

When you select the virtual disk format, the Thick Provision Lazy Zeroed option is recommended.

Note: The Thick Provision Eager Zeroed option yields the best performance but also take the most time to initialize. Thick provisioning does not fill the drive unless eager zeroed is selected. If thick provisioning is selected, the storage capacity for the entire virtual disk is allocated on the data store when the virtual disk is created. With thin provisioning, the capacity on the data store is allocated to the virtual disk as required, up to the file size of the virtual disk.

b. In the VM storage policy drop-down list, select the destination data store on which to store the virtual appliance files.

c. Click Next.

11. In the Select networks window, select the source and destination networks to use with the appliance, and then click Next.

12. In the Customize template window, specify the following network settings:

Note: If you have DHCP configured, disregard this step.

a. In the DHCP mode field, select False.

b. In the DNS field, specify one or more DNS servers.

Note: Configure the DNS server with the node name and IP of the node that you plan to install.

c. In the Default Gateway field, specify the IP address of the network gateway.

d. In the Domain Search Path field, specify the domain search path for the VM.

e. In the Network Address field, type an IPv4 address and a netmask.

f. (Optional) To support a mixed mode, you can specify IPv6 address in the Network IPv6 address field, and the gateway in the Default IPv6 gateway field.

Note: The Search software does not support IPv6 mode only.

13. For the first node in the cluster, specify the following search settings:

a. In the Search Master drop-down list, select True.

b. Leave the Search Master Hostname field blank.

14. Specify the following system settings:

a. In the Administrator Password field, type the administrator password.

The administrator password cannot contain any of the following characters:

$ \ ( ) < > | ; ` & and space.

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 33

b. In the Fully Qualified Domain Name field, type the hostname for the node.

c. In the Root Password field, specify the root password to be used for initial login.

d. (Optional) In the Time server field, specify one or more time servers for the VM, separated by a space.

e. In the Time Zone field, specify the time zone for the Search node.

f. Click Next.

15. In the Ready to complete window:

a. Review the settings.

b. Click Finish.

16. (Optional) To edit the settings for the node, right-click the node, and then select Edit Settings.

If required, you can increase the size of the index data disk (Disk 2) and the temporary disk (Disk 3). For more information, see VMware disk space size requirements.

17. To configure the node, right-click the node, and then select Power > Power On.

This process typically takes 1520 minutes to complete.

Add Search nodes Use the following procedure to deploy additional nodes.

Before you begin

Ensure that the following requirements are met:

l Master node deployment is complete.

l DNS/DHCP servers are configured.

Procedure

1. Log in to the vCenter server by using the vSphere client.

2. In the Navigator pane, select a server.

3. Right-click the server, and then select Deploy OVF Template.

The Deploy OVF Template wizard appears.

4. In the Select template window:

a. Browse to the OVA package:

l Type the URL path to the OVA package.

l Click Browse and browse to the OVA package location.

b. Click Next.

5. In the Select name and location window:

a. Specify a name for the virtual appliance and the location.

b. Click Next.

6. In the Select a resource window, select a resource, and then click Next.

7. Review the details for the VM and click Next.

8. Accept the End User License Agreement (EULA) and click Next.

9. In the Select storage window:

Deploying the Search virtual appliance

34 Dell EMC Search Deployment and Administration Guide

a. In the Select virtual disk format drop-down list, select the virtual disk format.

When you select the virtual disk format, the Thick Provision Lazy Zeroed option is recommended.

Note: The Thick Provision Eager Zeroed option yields the best performance but also take the most time to initialize. Thick provisioning does not fill the drive unless eager zeroed is selected. If thick provisioning is selected, the storage capacity for the entire virtual disk is allocated on the data store when the virtual disk is created. With thin provisioning, the capacity on the data store is allocated to the virtual disk as required, up to the file size of the virtual disk.

b. In the VM storage policy drop-down list, select the destination data store on which to store the virtual appliance files.

c. Click Next.

10. In the Select networks window, select the source and destination networks to use with the appliance, and then click Next.

11. In the Customize template window, specify the following network settings:

Note: If you have DHCP configured, disregard this step.

a. In the DHCP mode field, select False.

b. In the DNS field, specify one or more DNS servers.

Note: Configure the DNS server with the node name and IP of the node that you plan to install.

c. In the Default Gateway field, specify the IP address of the network gateway.

d. In the Domain Search Path field, specify the domain search path for the VM.

e. In the Network Address field, type an IPv4 address and a netmask.

f. (Optional) To support a mixed mode, you can specify IPv6 address in the Network IPv6 address field, and the gateway in the Default IPv6 gateway field.

Note: The Search software does not support IPv6 mode only.

12. Specify the following search settings:

a. In the Search Master drop-down list, select False.

b. In the Search Master Hostname field, type the name of the master node that was first deployed.

13. Specify the following system settings:

a. In the Administrator Password field, type the administrator password.

The administrator password cannot contain any of the following characters:

$ \ ( ) < > | ; ` & and space.

b. In the Fully Qualified Domain Name field, type the hostname for the node.

c. In the Root Password field, specify the root password to be used for initial login.

d. (Optional) In the Time server field, specify one or more time servers for the VM, separated by a space.

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 35

e. In the Time Zone field, specify the time zone for the Search node.

f. Click Next.

14. In the Ready to complete window:

a. Review the settings.

b. Click Finish.

15. (Optional) To edit the settings for the node, right-click the node, and then select Edit Settings.

If required, you can increase the size of the index data disk (Disk 2) and the temporary disk (Disk 3). For more information, see VMware disk space size requirements.

16. To configure the node, right-click the node, and then select Power > Power On.

This process typically takes 1520 minutes to complete.

Update the Search software Use the following procedure to update to the latest version of the Search software. You cannot update from Data Protection Search to the Search 18.2 software.

Before you begin

Before you update the Search software, verify that the Puppet service is functioning correctly:

1. Log in to Search.

2. In the System Administration UI, click Administration > System.

3. Ensure that all service indicators are green. Note: If the status is yellow or red, reset the Puppet certificates. The KB article https:// support.emc.com/kb/526171 provides detailed instructions.

Procedure

1. From the Support website (https://support.emc.com), download the latest Search upgrade .zip package.

For example:

search-upgrade-build_number.zip

2. Copy the upgrade .zip package to the /etc/puppet/repository folder on the Search Master node.

Note: Copy the upgrade files to the Search Master node by using a secure FTP client, such as WinSCP.

By default, the upgrade starts automatically within 5 minutes. To change the upgrade settings, see Modify the Search upgrade configuration on page 37.

3. Monitor the progress of the upgrade in the /etc/puppet/status directory.

The following files display the upgrade status of the Search software:

Deploying the Search virtual appliance

36 Dell EMC Search Deployment and Administration Guide

Table 12 Files for monitoring upgrade status

File Description

search-upgrade-build_number.zip- running

The master node is upgrading.

search-upgrade-build_number.zip- completed

The master node completed the upgrade successfully.

search-upgrade-build_number.zip- allcompleted

All Search nodes completed the upgrade successfully.

search-upgrade-build_number.zip- partialcompleted

At least 1 node has not completed the upgrade successfully.

If a node did not upgrade successfully, you can view the upgrade status of individual nodes in the /etc/puppet/status/build_number/ directory.

The following files display the upgrade status of individual nodes:

Table 13 Files for monitoring the status of individual nodes

File Description

servername-notstart The Search node with the name servername has not started the upgrade process.

servername-running The Search node with the name servername is upgrading.

servername-error The Search node with the name servername encountered an issue during the upgrade. The upgrade is retried later.

servername-failed The Search node with the name servername failed to upgrade.

servername-completed The Search node with the name servername completed the upgrade successfully.

Modify the Search upgrade configuration Learn how to modify the default Search upgrade settings.

Procedure

1. Log in to the Search Master node as the root user.

2. Browse to the /etc/puppet directory, and then open the upgrade.conf file.

3. Change the upgrade settings by locating and editing the following attributes:

Table 14 Upgrade settings

Attribute Description Default value

upgradableweekdays Defines the days of the week that the upgrade runs.

Only run the upgrade on weekends if it is necessary.

ALL

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 37

Table 14 Upgrade settings (continued)

Attribute Description Default value

Type the values separated by commas, or specify "ALL." For example:

Saturday,Sunday

upgradablehours Defines the hours of the day that the upgrade runs.

Only run the upgrade at midnight if it is necessary.

Type the values separated by commas, or specify "ALL." For example:

00,01,02,03,04,05

ALL

loglevel Defines the logging level for the upgrade.

To troubleshoot an upgrade issue, specify one of the following log levels:

l DEBUG l INFO l ERROR

WARN

upgradetimeoutseconds Defines the amount of time (in seconds) the upgrade waits for a node to successfully upgrade before marking it as failed.

If an error occurs, the Search software automatically retries the upgrade every 5 minutes. If the timeout value is reached, the software stops retrying the upgrade.

3600

4. To change how often the upgrade runs, complete the following steps:

a. Change to the /etc/puppet/puppet.conf directory.

b. In the puppet.conf configuration file, locate the following section:

runinterval=5m

c. Edit the runinterval attribute.

By default, the Search software automatically retries the upgrade every 5 minutes.

d. Restart the Puppet service by typing the following command:

service puppet restart

Deploying the Search virtual appliance

38 Dell EMC Search Deployment and Administration Guide

Log in to the Search virtual appliance for the first time After deployment has finished, wait a minimum of 10 minutes before you try to log in. If sufficient time has not elapsed, the web page might not appear or login tries are rejected.

Before you begin

If you installed an OVA file, ensure that the virtual machine where the OVA file was deployed is started.

About this task

To ensure that Search was deployed successfully, perform the following steps.

Procedure

1. In a web browser, type the following:

https:// /admin

The Login page appears.

Note: You might be required to acknowledge a browser warning regarding self-signed certificates before proceeding.

2. To log in to the UI, type the username and password.

a. In the Username field, type the following:

Admin

b. In the Password field, type the admin password that was specified when you deployed the OVA file.

Results

After installation, you can add one or more additional directory servers to manage user accounts and roles.

The following directory server types are supported:

l Open LDAP

l Microsoft Active Directory server (AD)

Deploying the Search virtual appliance

Dell EMC Search Deployment and Administration Guide 39

Deploying the Search virtual appliance

40 Dell EMC Search Deployment and Administration Guide

CHAPTER 3

Configuring Search

This section includes the following topics:

l Configuring a backup source................................................................................................. 42 l Manage indexes..................................................................................................................... 51 l Managing notifications.......................................................................................................... 55 l Replicate data indexes...........................................................................................................58 l Set search timeout options................................................................................................... 58 l Optimize search performance............................................................................................... 59 l Configuring Full Content Indexing (FCI)................................................................................60

Dell EMC Search Deployment and Administration Guide 41

Configuring a backup source Follow the procedures in this section to configure an Avamar and NetWorker source. When you add a source, you can also set the following options:

l Apply index and search analyzers

l Set connection limitations

l Set the blackout window

l Start a collection on the source

l Start a reconciliation job for a source server or zone

l View source summary

Add an Avamar source server to Search In the Search UI, identify one or more Avamar servers to be indexed. Indexing begins automatically after a source has been added.

About this task

You can add an Avamar server only if you have the Application Administrator role.

Procedure

1. In the Manage drop-down list, select Avamar.

2. Click Administration > Sources.

3. To add a source, click .

The Add Source window appears.

4. In the Name field, type a display name that identifies the Avamar server. The name must meet the following requirements:

l One to 50 characters in length

l No spaces

l Combination of lower and uppercase letters, numbers, dashes, and underscores

5. In the Hostname field, type the fully qualified hostname of the Avamar server by using one of the following formats:

l IP address

l FQDN

6. In the Port field, leave the default entry unless the Avamar server has been configured with a different port.

7. In the User ID field, type the account name of the user with the administrator role on the Avamar server that is being added.

For example, MCUser.

8. In the Password field, type the password for the user who is identified in the User ID field.

9. Select an analyzer.

The default standard analyzers are recommended for the majority of use cases.

10. To enable a connection limitation, in the Connection Limitation field, select Enable.

Configuring Search

42 Dell EMC Search Deployment and Administration Guide

Note: By default, the Connection Limitation option is disabled.

a. In the Indexing field, specify the number of concurrent indexing tasks across the Search cluster.

b. In the Action field, specify the number of search actions across the Search cluster, which include download, Full Content Indexing, and restore.

11. To enable a blackout window, In the Blackout Window field, select Enable.

Enabling this option prevents Search from interacting with the source during specific hours each day. By default, the blackout window applies to all activities including indexing, monitoring, and search actions.

a. Specify the time zone.

b. Specify the time range.

12. Click Connect.

If the source server connection is successful, a summary of the configuration appears. If necessary, you can edit the configuration:

l To edit the Avamar domain, click the Domains link. Note: By default, Search selects all existing Avamar domains for indexing, apart from any replica domains (/REPLICATE). To index replica domains, select the checkbox next to the replica domain. You cannot index both a replica domain and the original domain that is being replicated, in the same Search instance. If there is a requirement to index both, you must use different Search instances.

l To edit the range of backups to index, click the Backups all will be indexed link.

l To edit the schedule for indexing, click the Indexing will occur... link.

13. On the source summary page, click Done.

The Next Steps page appears and lists the administration tasks.

Maximum supported servers The Search software can index a maximum of 10 servers (Avamar and NetWorker). If more than 10 servers are configured, the additional servers cannot connect to the client on the Search nodes due to port range limitations.

Configuring a source in NetWorker Follow the procedures in this section to add a NetWorker source server to Search.

Configure support for Search in NetWorker Perform the following steps from the NetWorker Management Console (NMC).

About this task

Note: You must complete the following steps for all Search nodes.

Procedure

1. Connect to the NMC server with the NetWorker Authentication Service administrator account.

2. Click Enterprise.

Configuring Search

Dell EMC Search Deployment and Administration Guide 43

3. Right-click the NetWorker Server and select Launch Application.

4. In the NetWorker Administration window, select Protection.

5. In the left pane, right-click Clients, and then select either New Client Wizard or New.

6. For each Search node, configure one or more client resources for each client computer by using either use the Client Backup Configuration Wizard or the Client Properties dialog box:

a. In the Specify the Backup Configuration Type window, select Filesystem.

b. On the Select the File System Objects window, select the file system objects to backup.

Create the Search Admin User Group Procedure

1. Connect to the NMC server with the NetWorker Authentication Service administrator account.

2. Click Enterprise.

3. Right-click the NetWorker server and select Launch Application.

4. In the NetWorker Administration window, select Server.

5. In the left navigation pane, select User Groups.

6. In the right pane, right-click the Operators group, and then select Copy.

The Create User Group window appears.

7. In the Name field, type Search Admin User Group.

8. In the Users field, remove any existing users, and then add the following user privileges:

user=root, host=dpsearchnode1.domain.com

Where dpsearchnode1.domain.com is the Search hostname.

If there is more than one Search host, add one entry for each host.

Note: The Permissions section must have at least the same privileges as the Operators or Application Administrators group.

9. Click OK.

Add a NetWorker source server to Search In the Search Admin UI, identify one or more NetWorker servers to be indexed. Indexing begins automatically after a source has been added.

About this task

You can add a NetWorker server only if you have the Application Administrator role.

Procedure

1. In the Manage drop-down menu, select NetWorker.

2. Click Administration > Sources.

3. To add a source, click .

The Add Source window appears.

4. In the Name field, type a display name that identifies the NetWorker server. The name must meet the following requirements:

Configuring Search

44 Dell EMC Search Deployment and Administration Guide

l One to 50 characters in length

l No spaces

l Combination of lower and uppercase letters, numbers, dashes, and underscores

5. In the Hostname field, type the fully qualified hostname of the NetWorker server by using one of the following formats:

l IP address

l FQDN

6. Select an analyzer.

The default standard analyzers are recommended for the majority of use cases.

7. To enable a connection limitation, in the Connection Limitation field, select Enable.

Note: By default, the Connection Limitation option is disabled.

a. In the Indexing field, specify the number of concurrent indexing tasks across the Search cluster.

b. In the Action field, specify the number of search actions across the Search cluster, which include download, Full Content Indexing, and restore.

8. To enable a blackout window, In the Blackout Window field, select Enable.

Enabling this option prevents Search from interacting with the source during specific hours each day. By default, the blackout window applies to all activities including indexing, monitoring, and search actions.

a. Specify the time zone.

b. Specify the time range.

Note: You must type different values for the start time and end time.

9. Click Connect.

If the source server connection is successful, a summary of the configuration appears. If necessary, you can edit the configuration:

l To edit the NetWorker zone, click the RDZ link.

l To edit the range of backups to index, click the Backups all will be indexed link.

l To edit the schedule for indexing, click the Indexing will occur... link.

10. On the source summary page, click Done.

The Next Steps page appears and lists the administration tasks.

Update an Avamar source server In the Search UI, identify an Avamar server to update.

About this task

You can update an Avamar server only if you have the Application Administrator role.

Procedure

1. In the Manage drop-down list, select Avamar.

2. Click Administration > Sources.

Configuring Search

Dell EMC Search Deployment and Administration Guide 45

3. To update a source, select a source from the list, and then click .

The Update Source window appears.

4. In the Hostname field, type the fully qualified hostname of the Avamar server by using one of the following formats:

l IP address

l FQDN

5. In the Port field, leave the default entry unless the Avamar server has been configured with a different port.

6. In the User ID field, type the account name of the user with the administrator role on the Avamar server that is being added.

For example, MCUser.

7. In the Password field, type the password for the user who is identified in the User ID field.

8. To enable a connection limitation, in the Connection Limitation field, select Enable.

Note: By default, the Connection Limitation option is disabled.

a. In the Indexing field, specify the number of concurrent search operation connections, which include download or Full Content Indexing, that are allowed to the source.

b. In the Action field, specify the number of search actions that are allowed to the source.

9. To enable a blackout window, In the Blackout Window field, select Enable.

Enabling this option prevents Search from interacting with the source during specific hours each day. By default, the blackout window applies to all activities including indexing, monitoring, and search actions. However, the blackout window can be applied only to Full Content Indexing actions. Full Content Indexing can involve reading the entire file content.

a. Specify the time zone.

b. Specify the time range.

10. To set the indexing schedule for the source:

a. In the Schedule field, click the Indexing will occur... link.

The Custom Schedule window appears.

b. In the Recurrence Pattern field, select the schedule for indexing.

c. In the Start time field, select the time at which you want to begin indexing.

d. In the Start date field, select the date for the indexing to occur.

e. In the Duration field, select a duration for the indexing to occur.

f. Click OK.

11. In the Zone List field, select all Avamar domains that you want to index.

If a domain is created on the Avamar server after it has been added to Search, you must manually select the domain before indexing can begin.

Note: When you remove a zone that has been indexed, the index and collection jobs that are associated with it are deleted.

12. Click Update.

Configuring Search

46 Dell EMC Search Deployment and Administration Guide

Update a NetWorker source server In the Search UI, identify a NetWorker server to update.

About this task

You can update a NetWorker server only if you have the Application Administrator role.

Procedure

1. In the Manage drop-down menu, select NetWorker.

2. Click Administration > Sources.

3. To update a source, select a source from the list, and then click .

The Update Source window appears.

4. In the Hostname field, type the fully qualified hostname of the NetWorker server by using one of the following formats:

l IP address

l FQDN

5. To enable a connection limitation, in the Connection Limitation field, select Enable.

Note: By default, the Connection Limitation option is disabled.

a. In the Indexing field, specify the number of concurrent search operation connections, which include download or Full Content Indexing, that are allowed to the source.

b. In the Action field, specify the number of search actions that are allowed to the source.

6. To enable a blackout window, In the Blackout Window field, select Enable.

Enabling this option prevents Search from interacting with the source during specific hours each day. By default, the blackout window applies to all activities including indexing, monitoring, and search actions. However, the blackout window can be applied only to Full Content Indexing actions. Full Content Indexing can involve reading the entire file content.

a. Specify the time zone.

b. Specify the time range.

7. To set the indexing schedule for the source:

a. In the Schedule field, click the Indexing will occur... link.

The Custom Schedule window appears.

b. In the Recurrence Pattern field, select the schedule for indexing.

c. In the Start time field, select the time at which you want to begin indexing.

d. In the Start date field, select the date for the indexing to occur.

e. In the Duration field, select a duration for the indexing to occur.

f. Click OK.

8. In the Zone List field, select all NetWorker Restricted Data Zones that you want to index.

If an RDZ is created on the NetWorker server after it has been added to Search, you must manually select the RDZ before indexing can begin.

Note: When you remove a zone that has been indexed, the index and collection jobs that are associated with it are deleted.

Configuring Search

Dell EMC Search Deployment and Administration Guide 47

9. Click Update.

Remove a source server Procedure

1. In the Manage drop-down list, select Avamar or NetWorker.

2. Click Administration > Sources.

3. Select a source from the list, and then click .

A confirmation dialog box appears.

4. Type DELETE, and then click Confirm.

Applying index and search analyzers The analyzer is the criteria or language that the content is indexed with. You can apply index and search analyzers when you add a source server.

The default standard analyzers are recommended for the majority of use cases. However, advanced users can select different analyzers for specific indexes.

The Search software supports the following index and search analyzers:

Table 15 Index and search analyzers

Option Description

Standard l Default analyzer

Simple l Includes lowercase words

l Disregards numeric values

l Splits text into tokens for non-letter characters

Whitespace l Does not support lowercasing

l Splits text into tokens for white space characters

Languages l Supports language-specific stop words

l Supports stemming

Set connection limitations The Search software connects to the source server to scan, download, and restore files. A connection limitation controls the number of connections that are made to the source server.

About this task

By default, each Search node supports up to 6 concurrent metadata indexing connections and 10 concurrent action connections to the source, such as download, restore, and FCI operations.

Use the following procedure to restrict the number of connections that are made across all Search nodes.

Procedure

1. To select the Administration view for the source application, in the Manage drop-down list, select Avamar or NetWorker.

Configuring Search

48 Dell EMC Search Deployment and Administration Guide

2. Click Administration > Sources.

The list of sources appears.

3. Select the source, and then click .

The Add Source window appears.

4. In the Connection Limitation field, select Enable.

Note: By default, the Connection Limitation option is disabled.

5. In the Indexing field, specify the number of concurrent indexing tasks across the Search cluster.

6. In the Action field, specify the number of search actions across the Search cluster, which include download, full content indexing, and restore.

7. Click Update.

8. Continue the configuration steps for adding a source.

Set the blackout window for indexing Use the following procedure to restrict indexing during a certain period by setting a blackout window.

About this task

Enabling this option prevents Search from interacting with the source during specific hours each day. By default, the blackout window applies to all activities including indexing, monitoring, and search actions.

Procedure

1. To select the Administration view for the source application, in the Manage drop-down list, select Avamar or NetWorker.

2. Click Administration > Sources.

The list of sources appears.

3. Select the source and click .

The Add Source window appears.

4. In the Blackout Window field, select Enable.

5. Specify the time zone.

6. Specify the time range.

7. Click Update.

The source is now available in the list of servers in the Sources window. When you add a server, the system registers the source node and indexing begins.

8. Continue the configuration steps for adding a source.

Start a collection on the source About this task

A collection (indexing) runs automatically on each zone based on the schedule that is specified when it is added. By default, a collection runs at 2:00 a.m. each day. You might need to start a collection on the source so you can update the indexes in the following scenarios:

l You have restored from a disaster recovery event and must update the index from the point that the index was last snapshot.

Configuring Search

Dell EMC Search Deployment and Administration Guide 49

l One or more backups have completed that you want to index immediately.

l One or more clients were added to the Avamar or NetWorker server that you want to index immediately.

You can start a collection only in the Application Administrator role.

Note: When a source is added to Search for the first time, you are not required to manually trigger a collection. The first collection starts immediately. It might take a few minutes for the collection to appear in the UI.

Procedure

1. Click Administration > Sources.

The Sources window appears.

2. Select the source.

3. Click .

4. In the Collection field, click Trigger Now.

A confirmation dialog box appears.

5. Click Confirm.

Start a reconciliation job for a source server or zone About this task

You can force reindexing of a source server, or a single Avamar domain or NetWorker RDZ. When you start a reconciliation job, the Search software deletes all items in the index for all client backups in that zone or source server, and then reindexes the items. Any items that had their full content indexed are lost.

Note: If an indexing job for a particular source server or zone is in progress, the Search software does not trigger the reconciliation job for the source server or zone that is being indexed.

Procedure

1. Click Administration > Sources.

The Sources window appears.

2. Select the source.

3. Click .

4. To start a reconciliation job for an Avamar domain or NetWorker RDZ:

a. Select the Avamar domain or NetWorker RDZ, and then click Force reconciliation.

A confirmation dialog box appears.

b. Click Confirm.

5. To start a reconciliation job for the source server, in the Reconciliation field, click Trigger Now.

A confirmation dialog box appears.

6. Click Confirm.

Configuring Search

50 Dell EMC Search Deployment and Administration Guide

View the status and summary of the source About this task

View the configuration details of the source.

You can view a summary of the source only in the Application Administrator role.

Procedure

1. To select the Administration view for the source application, in the Manage drop-down list, select Avamar or NetWorker.

2. Click Administration > Sources.

The Sources window appears.

3. Select the source.

4. Click .

Select zones or restricted data zones When you select a zone, index and collection jobs start. When you remove a zone, the index and collection jobs associated with it are deleted.

Procedure

1. To select the Administration view for the source application, in the Manage drop-down list, select Avamar or NetWorker.

2. Click Administration > Sources.

3. To update a source, select a source from the list, and then click .

The Update Source window appears.

4. In the Zone List field, select one or more Avamar domains or NetWorker Restricted Data Zones (RDZ) to index.

Note: When you remove a zone, the index and collection jobs associated with it are deleted.

5. Click Update.

Manage indexes When a new source server is added to Search, indexes are created automatically. Search creates a single index for every Avamar domain or NetWorker RDZ that you select for indexing.

You can index additional domains or RDZs by editing a configured source, and then selecting those domains or RDZs. When you select a domain, index and collection jobs start. When you remove a domain or RDZ that is indexed, Search removes the index job and collection activity that is associated with it.

Indexing overview Indexing extracts metadata and content from files and stores them in indexes. You can specify the user and groups that can access the indexes.

Search populates indexes with the file system and backup metadata of files as backups are indexed. Optionally, you can add the full content of files by using the Full Content Indexing (FCI) action in the Search UI.

Configuring Search

Dell EMC Search Deployment and Administration Guide 51

The metadata that is indexed includes the following:

l Platform

l Backup server

l Backup client

l Backup type (plugin name)

l File name

l File type

l Path

l Size

l Date last modified

l Index date

l The range of backups the file is in

Full content indexing allows searches of any text inside a file, and application-specific metadata.

Configure virtual machine indexing on the Avamar server You can configure virtual machine backups for indexing by editing the dataset for the backup policy. Alternatively, you can enable indexing for a single manual backup.

Before you begin

Ensure that the following requirements are met:

l All the virtual machine disks (vmdk) are SCSI or SATA controller.

l All the volumes on the disk are a simple layout, basic type, and NTFS format.

l Install the virtual machine tool before backup.

l The proxy version is the same as the Avamar server version. Note: The Search software supports Avamar version 7.5.1 or later.

About this task

File system and NMDP backups can be indexed without specific configuration changes on the Avamar server. However, to enable indexing for a virtual machine client, an optional setting is required. By default, this setting is disabled. You can enable indexing for a virtual machine client by editing the dataset for the backup policy. Alternatively, you can enable indexing for a single manual backup.

To configure virtual machine backups for indexing on the Avamar server, perform the following steps.

Procedure

1. Launch Avamar Administrator.

The Avamar Administration Guide provides more information.

2. In Avamar Administrator, select Tools > Datasets.

The Manage All Datasets window appears.

3. Select the VMware Image Dataset, and then click Edit.

The Edit Dataset Dialog box appears.

4. Click the Options tab.

5. In the Select Plug-In Type list, select Windows VMware Image.

Configuring Search

52 Dell EMC Search Deployment and Administration Guide

Note: Search does not support other types of VMware images. Updated, detailed compatibility information is available in the E-Lab Navigator at https:// elabnavigator.emc.com/eln/elnhome.

6. Select Index VMware Image Backups.

Note: If you are enabling indexing for a single manual virtual machine backup, select this option.

7. Ensure that the Avamar domain is being indexed:

a. Click Administration > Sources.

b. In the list of sources, select the Avamar source, and then click .

c. In the Zone List field, select the Avamar domain.

8. Verify whether files are indexed in the virtual machine domain:

a. Click Administration > Indexes.

b. Review the information for the index.

The Item Count field indicates the number of indexed files.

Note: If indexing activities have not started, or if backups with indexing enabled on the Avamar server are not complete, then no files are indexed.

Restrict index access Restricting index access limits the users or groups that can search the content.

About this task

As an Application Administrator, you can restrict the indexes that a user or user group can access from the Search window.

Perform the following steps from the Administration window.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. Ensure that the user or group has been added as an Active Directory or OpenLDAP source.

3. Click Administration > Indexes.

The list of indexes appears.

4. Select the index that you want to give the user or group access to.

5. To manage search roles, click .

The Manage Search Roles window appears.

6. Click .

The Select User window appears.

7. In the Select User window, perform the following steps:

Configuring Search

Dell EMC Search Deployment and Administration Guide 53

a. In the Name drop-down list, restrict the search to one of the following categories:

l Users or Groups

l Users

l Groups

b. Type the name of the user or group.

c. In the Directory drop-down list, select one of the configured LDAP servers.

d. Click Find.

The list of user or user groups appears.

Note: If you click Find before specifying a substring, the entire directory is returned, which might be slow. For example, to search for all users that contain Admin, type Admin, and then click Find.

8. Select a user or group, or click Select all, and then click OK.

9. To assign roles to a user or group, select one of the following options:

Full Access Search (Index) No restrictions.

Read Only Search (Index) l Cannot see inline preview for hits

l Cannot view full preview for hits

l Cannot download files locally

l Cannot restore files to an alternate location

View indexes Indexes hold the indexed metadata and content extracted from the source. One index is created for each source. You can specify the users and groups that have access to the index.

About this task

You can view indexes only with the Application Administrator role.

Perform the following steps from the Administration window.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. Click Administration > Indexes.

For each index, the following information displays:

l Name of the index

Configuring Search

54 Dell EMC Search Deployment and Administration Guide

l Size of the index

l Number of items in the index

l Source and zone that is associated with the index

l Analyzer that is used

l Date of the last completed index

l Date of the next scheduled index run

Updating an index Indexes are updated to reflect new backups based on the schedule that is specified when a source is added to Search. By default, an update occurs at 2:00 a.m. each day.

To index backups immediately, rather than waiting for the next scheduled run, see Start a collection on the source on page 49.

Managing notifications Notifications alert you to activities, issues, and events within the Search system and source.

Follow the procedures in this section to configure the system, source, and email notifications.

Configure system notifications About this task

System notifications provide information on issues with the system at the source, node, index, and service levels.

You can configure and view system notifications only with the System Administrator role.

Perform the following steps from the Administration window.

Procedure

1. In the Manage drop-down list, select System.

The System Administration view appears.

2. Click Administration > Options > Notification Options.

The Notification Options window appears.

3. Click to toggle the Notification switch to ON.

Notifications are enabled (ON) by default.

4. Select one or more of the following categories that you would like to receive notifications for:

l Cluster

l Node

l Index

l Service

5. Select the preferred language.

6. To configure email notifications, click to toggle the Email switch to ON.

Email notifications are disabled (OFF) by default.

Configuring Search

Dell EMC Search Deployment and Administration Guide 55

7. Configure the following fields:

l Host (IP of the SMTP host)

l Port (Set a port, typically 25 or 587)

l User (An account authorized to connect to the SMTP service)

l Password

8. Click Save.

Results

Email Notifications take effect 15 minutes after this setting is enabled.

Configure Avamar notifications Avamar notifications alert you to index events, issues with the Avamar source server, and the status of search action events.

About this task

You can configure and view Avamar notifications only with the Avamar Administrator role.

Procedure

1. In the Manage drop-down list, select Avamar.

The Avamar Administration view appears.

2. Click Administration > Options > Notification Options.

The Notification Options window appears.

3. Click to toggle the Notification switch to ON.

Notifications are enabled (ON) by default.

4. Select the categories that you want to receive notifications for.

5. Select the job types that you want to receive notifications for.

6. Select the preferred language.

7. To configure email notifications, click to toggle the Email switch to ON.

Email notifications are disabled (OFF) by default.

8. Configure the following fields:

l Host (IP of the SMTP host)

l Port (Set a port, typically 25 or 587)

l User (An account authorized to connect to the SMTP service)

l Password

9. Click Save.

Results

Email Notifications take effect 15 minutes after this setting is enabled.

Configuring Search

56 Dell EMC Search Deployment and Administration Guide

Configure NetWorker notifications NetWorker notifications alert you to index events, issues with the NetWorker source server, and the status of search action events.

About this task

You can configure and view NetWorker notifications only in the NetWorker Administrator role.

Perform the following steps from the Administration window.

Procedure

1. In the Manage drop-down menu, select NetWorker.

The NetWorker Administration view appears.

2. Click Administration > Options > Notification Options.

The Notification Options window appears.

3. Click to toggle the Notification switch to ON.

Notifications are enabled (ON) by default.

4. Select the categories that you want to receive notifications for.

5. Select the job types that you want to receive notifications for.

6. Select the preferred language.

7. To configure email notifications, click to toggle the Email switch to ON.

Email notifications are disabled (OFF) by default.

8. Configure the following fields:

l Host (IP of the SMTP host)

l Port (Set a port, typically 25 or 587)

l User (An account authorized to connect to the SMTP service)

l Password

9. Click Save.

Configure email notifications You can configure Search to send email notifications to specified SMTP users and hosts.

About this task

Note: The default admin user is not configured with an email address and cannot receive email notifications.

Procedure

1. Click Administration > Options > Notification Options.

The Notification Options window appears.

2. Click to toggle the Email switch to ON.

Email notifications are disabled (OFF) by default.

3. Configure the following fields:

l Host (IP of the SMTP host)

Configuring Search

Dell EMC Search Deployment and Administration Guide 57

l Port (Set a port, typically 25 or 587)

l User (An account authorized to connect to the SMTP service)

l Password

4. Click Save.

Results

Email notifications take effect 15 minutes after this setting is enabled.

Replicate data indexes If you have more than one Search node in the cluster, it is recommended that you enable replicas. Index replication keeps a redundant copy of index data that is spread over available nodes, providing high availability. If one node fails, the indexes are still available. However, if the master node is unavailable, the system does not work correctly. Replication requires the deployment of at least two indexing nodes.

About this task

Each system index is divided into shards. The shards are distributed over the available index nodes. If the index replica feature is enabled, each primary shard has a replica shard. Replica shards must be stored on a different node from the corresponding primary shard.

When an Elasticsearch node becomes unavailable, replica shards are automatically promoted to replace any unavailable primary shards without administrator interaction.

System data is automatically replicated when there is more than one Search node configured. However, replication for data indexes is disabled by default.

Note: Enabling replication for data indexes doubles the amount of data and therefore the amount of space used.

Enabling replication also slows down indexing. It is recommended that you enable replication after the backlog of existing backups has finished indexing.

Procedure

1. Click Administration > Options > Index Options.

The Index Options window appears.

2. Click to toggle the Index replica switch to ON.

3. Click Save.

Set search timeout options About this task

The search timeout option sets a limit on the duration of a search operation. Only the System Administrator role can set search timeout options.

Perform the following steps from the Administration window.

Procedure

1. In the Manage drop-down list, select System.

The System Administration view appears.

2. Click Administration > Options > Search Options.

The Search Options window appears.

Configuring Search

58 Dell EMC Search Deployment and Administration Guide

3. To set a limit on the duration of a search operation, in the Search timeout field, specify a time in seconds.

If a search operation is not completed in the specified time, a message indicating that results are incomplete appears.

4. To set a limit on the time it takes to build a visual filter graph from the search results, in the Aggregation search timeout field, specify a time in seconds.

Consider the following:

l Visual filter graphs require that matching items from the current search are aggregated.

l If a visual filter graph is not completed in the specified time, the graph appears with a message indicating that the results are incomplete.

Figure 7 Visual filter graphs examples

Optimize search performance At the core of Search is Elasticsearch, a high-performance indexing and search system that can search billions of objects within seconds.

To leverage Elasticsearch replication, at least two nodes are required.

To further increase the speed at which search results are returned, observe the following best practices:

l Use search filters to narrow the search scope and limit the number of results.

l Add specific queries only if you know the details of the content that you are looking for. For example, specify the file type, date, and owner by using the search filters instead of typing them directly into the Search bar.

l Limit the number of simultaneous queries by different users.

Configuring Search

Dell EMC Search Deployment and Administration Guide 59

Configuring Full Content Indexing (FCI) The sections that follow describes how to configure full content indexing options.

About full content indexing The Search software performs metadata searches on indexed files and folders, and full content searches on files that have had their full content indexed. Search supports keyword and advanced Lucene search queries. By default, a search operation is sorted by Relevance (score), which defines how well the search results match the search criteria.

Consider the following points:

l If a file is indexed for metadata, keywords or phrases that are found in the name of the file or path are highlighted. Search results include a summary of certain fields for the file, such as file name, path, size, date, and ownership.

l If a file is indexed for full content, keywords or phrases that are found in the body of the file are returned with a preview of the full contents. The preview displays and highlights the words around the matched text.

Full content indexing use cases

If you do not recall the name of a particular file, you can use full content indexing to search for a certain keyword that exists inside the file. Processing the full content of a large number of files can be time consuming and takes significantly more space in the index, depending on the type and size of the files that are processed. If you want to perform a full content index of files, you must first download those files to Search nodes. Many file types do not have useful information that can be extracted.

It is recommended that you perform targeted full content indexing. For example, if 50 million files have been indexed with Search, only a few thousand text-based documents, such as PDF's and Microsoft Office documents, might be useful to full content index.

Updated content

A single file in the index can exist in many backups, if the file does not change between them. However, each time a modified version of the file is found in a new backup, a new instance of that file is added to the index.

When you select a file for full content indexing, Search only processes the selected version. Other instances of the file, with different content and modified dates, are not processed unless they are selected.

Space requirements for Full Content Indexing (FCI) The metadata for each indexed object typically takes up a few hundred bytes, with any variation depending mostly on the path length. By contrast, the amount of space that full content indexing takes can vary widely depending on the amount of text in the file.

The amount of index space that is used by the FCI feature differs depending on the file type, as shown in the following table.

Configuring Search

60 Dell EMC Search Deployment and Administration Guide

Table 16 File type index space for full content indexing

File type Index size requirements

Video file A 20 GB video file might take only a couple of kilobytes, which reflects the video metadata in the file.

Text file If the FCI preview option is enabled, a 15 KB text file might take up 30 KB or more of index space.

Microsoft Office documents

The amount of index space that is used is usually smaller than the file size because pictures and other formatting are removed.

PDF The amount of index space that is used is usually smaller than the file size because pictures and other formatting are removed.

To manage low disk space, add additional nodes that have the same amount of disk space as the existing node. For example, a Search cluster has three nodes and each node contains a 500 GB disk. You can add one or more additional Search nodes with 500 GB disks to the cluster.

Application-specific metadata for full content indexing In addition to the basic file system metadata that is stored in the index, full content indexing reads additional application-specific metadata for processed files where available.

The following list provides examples of application-specific metadata:

l Author

l Title

l Title and artist for audio files

l Word count for Microsoft Office files

l Camera name

l Resolution for image files

Restrict the index size that is returned from Full Content Indexing (FCI) About this task

Set limits to increase the speed of full content indexing and restrict the size of the index.

Procedure

1. Click Administration > Options > Full Content Indexing.

The Full Content Indexing Options window appears.

2. To set a limit on the maximum file size within the index, in the Maximum item size to full content index field, specify the maximum file size.

Note: During full content indexing, Search skips files that are over the maximum item size.

3. To display preview text in the search results, in the Include preview text during FCI field, select Yes.

Note: Disabling the Include preview text during FCI option reduces the size of the index and also makes the full content indexing process slightly faster. By default, up to 20 KB of preview text for any full content indexed file is stored in the index. You can

Configuring Search

Dell EMC Search Deployment and Administration Guide 61

display the preview text without reaching back out to the source server. For image files, a small thumbnail of the image is stored.

4. In the Max preview size field, specify the maximum size of the preview text.

Note: Any additional text over the maximum preview size is truncated.

5. To process all files, in the File type limitations for FCI field, select Processes all files.

6. To exclude certain file types, in the File type limitations for FCI field:

a. Select Processes all files.

b. Select Exclude the types below.

The following file types are excluded:

l .jar l .log l .json l .exe l .dll l .obj

7. To include only certain file types, in the File type limitations for FCI field, select Include only the types below.

The following file types are included:

l .docx, .doc l .xlsx, .xls l .txt l .pdf l .html

Configuring Search

62 Dell EMC Search Deployment and Administration Guide

CHAPTER 4

Managing Roles and Users

This section includes the following topics:

l Configure external OpenLDAP and Active Directory servers................................................. 64 l About roles............................................................................................................................65 l Managing roles...................................................................................................................... 73

Dell EMC Search Deployment and Administration Guide 63

Configure external OpenLDAP and Active Directory servers With the System Administrator role, you can add external OpenLDAP or Active Directory (AD) servers to define new users who can administer Search and perform search operations.

About this task

Search is configured with a built-in OpenLDAP service that includes preconfigured user accounts and groups. The Admin user account is preconfigured to include the system, application, and search Admin roles, which provides access to all Search functionality. While this account is useful for initial configuration, it is best practice to add one or more external OpenLDAP or AD servers, and assign users or groups from those servers to Search roles. After you add the external OpenLDAP or AD servers, you can disable or remove the built-in OpenLDAP server.

The built-in OpenLDAP service is configured with a password policy to protect from brute-force attacks, and also enables automatic account unlock to prevent an account lockout attack.

The default Admin user account is not configured with an email address, and therefore cannot receive email notifications by default.

To configure LDAP and AD users, perform the following actions:

Procedure

1. In the Manage drop-down list, select System.

The System Administration view appears.

2. Click Administration > Options > LDAP Options.

The LDAP Options window appears.

3. To add an LDAP server, click .

The Add LDAP Configuration window appears.

4. In the Name field, type the LDAP configuration name.

5. In the Server Type field, select either of the following authentication types:

l Active Directory

l OpenLDAP

6. In the LDAP Server field, type either of the following:

l Hostname of the LDAP or AD server

l IP address of the LDAP or AD server

7. In the LDAP port field, type the port number that the external authentication authority uses.

For LDAP, the default port number is 389.

For SSL, the default number for LDAPS changes to 636 when True is selected.

8. In the Base DN field, type the scope of the users and groups that are considered within the LDAP server.

For example:

DC=example, DC=com The Base DN determines the structure of the LDAP server where the search filter is applied. This setting is usually similar to the domain name over which the LDAP server has authority.

Managing Roles and Users

64 Dell EMC Search Deployment and Administration Guide

9. In the Username field:

a. Type a user account that has full read access to the LDAP or AD directory, in the following format:

user@domain. For example, administrator@ldap.example.com

l For Active Directory, ensure that the username is one of the following:

n Display name

n User principle name (UPN) in the following format: user@domain

n SAM account name in the following format: domain/user

n Distinguished name (DN)

l For OpenLDAP, ensure that the username is one of the following:

n Common name

n Email address

n Entry distinguished name

b. Ensure that the user has read access to the directory.

c. To include email notification, define the email address for the account.

Note: Only Admin accounts with defined email addresses can receive email notifications.

10. In the Password field, type the password of the user account that you specified in the Username field.

11. In the SSL field, select either of the following options:

l To connect to an external authentication server using LDAPS, select True.

The default port number automatically changes to 636.

l To ignore secure connection settings, select False.

12. In the Default field, leave the option set to False.

The Default field refers to the Search built-in OpenLDAP server.

13. To test the connection, click Test Connection.

14. Click Save.

About roles A role defines the privileges and permissions for users to perform a group of tasks.

When you configure the Search virtual appliance, there are already predefined users from OpenLDAP.

Note: When you launch the Search virtual appliance within IDPA System Manager, the user has all admin access and full search access to all indexes. The IDPA single sign-on privileges override the roles that are allocated in Search.

Managing Roles and Users

Dell EMC Search Deployment and Administration Guide 65

System Administrator role The System Administrator can perform the following tasks:

l Assign the System Administrator role to other users and groups

l View the system health

l Configure and view system notifications

l Manage LDAP sources

Assign the System Administrator role

About this task

To assign a System Administrator role, perform the following procedure. Only a System Administrator can add another System Administrator role.

Procedure

1. In the Manage drop-down list, select System.

The System Administration view appears.

2. Click Administration > Roles.

The Manage Roles window appears.

3. Click .

The Select User window appears.

4. In the Select User window, perform the following steps:

a. In the Name field, restrict the search to one of the following categories:

l Users or Groups

l Users

l Groups

b. Type the name of the user or group.

c. In the Directory field, specify an authentication provider.

For example, the name of the Active Directory.

d. Click Find.

The list of user or user groups appears. Note: If you click Find before specifying a substring, the entire directory is returned. This action might slow performance.

e. Select a user, group, or click Select all.

f. Click OK.

The Manage Roles window appears.

5. In the Manage Roles window, select System Administrator to assign the role to the user or group that you added.

Example 2 Search for all users

Managing Roles and Users

66 Dell EMC Search Deployment and Administration Guide

Example 2 Search for all users (continued)

To search for all users that contain Admin:

1. Type Admin.

2. Click Find.

Application Administrator role The Application Administrator can manage specific configurations within the Search virtual appliance.

The Application Administrator can perform the following tasks:

l Assign the following roles to users and groups:

n Application Administrator

n Full Access Search (Global)

l View the status of jobs on the source server

l Manage search roles for an index including the following:

n Full Access Search (Index)

n Read Only Search (Index)

l Add or edit a source

l Configure and view source notifications

l View the health of the source server

Assign the Application Administrator role

About this task

Only an Application Administrator can assign the Application Administrator role.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. Select Administration > Roles.

The Manage Roles window appears.

3. To add a user or group, click .

The Select User window appears.

4. In the Select User window, perform the following steps:

a. In the Name field, restrict the search to one of the following categories:

l Users or Groups

l Users

Managing Roles and Users

Dell EMC Search Deployment and Administration Guide 67

l Groups

b. Type the name of the user or group.

c. In the Directory field, specify an authentication provider.

For example, the name of the Active Directory.

d. Click Find.

The list of user or user groups appears. Note: If you click Find before specifying a substring, the entire directory is returned. This action might slow performance.

e. Select a user, group, or click Select all.

f. Click OK.

The Manage Roles window appears.

5. In the Manage Roles window, select Application Administrator to assign the role to the user or group that you added.

Example 3 Search for all users

To search for all users that contain Admin:

1. Type Admin.

2. Click Find.

Full Access Search (Global) role The Full Access Search (Global) role is a global search administrator that overrides any setting on indexes.

Only an Application Administrator can assign the Full Access Search (Global) role.

The Full Access Search (Global) role can perform the following actions:

l Full content index a search result

l Preview search results

l Download files locally

l Restore files to original or alternate location

Assigning the Full Access Search (Global) role

About this task

Only an Application Administrator can assign the Full Access Search (Global) role.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

Managing Roles and Users

68 Dell EMC Search Deployment and Administration Guide

2. Click Administration > Roles.

The Manage Roles window appears.

3. To add a user or group, click .

The Select User window appears.

4. In the Select User window, perform the following steps:

a. In the Name field, restrict the search to one of the following categories:

l Users or Groups

l Users

l Groups

b. Type the name of the user or group.

c. In the Directory field, specify an authentication provider.

For example, the name of the Active Directory.

d. Click Find.

The list of user or user groups appears. Note: If you click Find before specifying a substring, the entire directory is returned. This action might slow performance.

e. Select a user, group, or click Select all.

f. Click OK.

The Manage Roles window appears.

5. In the Manage Roles window, select Full Access Search (Global) to assign the role to the user or group that has been added.

Example 4 Search for all users

To search for all users that contain Admin:

1. Type Admin.

2. Click Find.

Index specific search roles The following roles can be applied to specific indexes.

Full Access Search (Index) Only an Application Administrator can assign the Full Access Search (Index) role.

The Full Access Search (Index) role can perform the following actions inside a specified index:

l Full content index a search result

l Preview search results

l Download files locally

l Restore files to original or alternate location

Managing Roles and Users

Dell EMC Search Deployment and Administration Guide 69

The following figure illustrates how to assign the Full Access Search (Index) role.

Figure 8 Full Access Search (Index) role

Assign the Full Access Search (Index) role

Only an Application Administrator can assign the Full Access Search (Index) role for a specific index.

Before you begin

Ensure that the user or group has been added as an Active Directory or OpenLDAP source.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. Click Administration > Indexes.

The list of indexes appears.

3. Select the Index that you want to give the user or group access to.

4. To manage search roles, click .

The Manage Search Roles window appears.

5. To add a user or group, click .

The Select User window appears.

6. In the Select User window, perform the following steps:

a. In the Name field, restrict the search to one of the following categories:

l Users or Groups

l Users

l Groups

Managing Roles and Users

70 Dell EMC Search Deployment and Administration Guide

b. Type the name of the user or group.

c. In the Directory field, specify an authentication provider.

For example, the name of the Active Directory.

d. Click Find.

The list of user or user groups appears. Note: If you click Find before specifying a substring, the entire directory is returned. This action might slow performance.

e. Select a user, group, or click Select all.

f. Click OK.

The Manage Roles window appears.

7. In the Manage Roles window, select Full Access Search (Index) to assign the role to the user or group that has been added.

Example 5 Search for all users

To search for all users that contain Admin:

1. Type Admin.

2. Click Find.

Read Only Search (Index) role Only an Application Administrator can assign the Read Only Search (Index) role.

The Read Only Search (Index) role can perform the following actions inside a specific index:

l Perform keyword searches

l Perform filter searches

l View metadata for the search results

l Restore files to the original location

The following figure illustrates how to assign the Read Only Search (Index) role.

Managing Roles and Users

Dell EMC Search Deployment and Administration Guide 71

Figure 9 Read Only Search (Index) role

Assign the Read Only Search (Index) role

Only an Application Administrator can assign the Read Only Search (Index) role for a specific index.

Before you begin

Ensure that the user or group has been added as an Active Directory or OpenLDAP source.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. Click Administration > Indexes.

The list of indexes appears.

3. Select the Index that you want to give the user or group access to.

4. To manage search roles, click .

The Manage Search Roles window appears.

5. To add a user or group, click .

The Select User window appears.

6. In the Select User window, perform the following steps:

a. In the Name field, restrict the search to one of the following categories:

l Users or Groups

l Users

l Groups

b. Type the name of the user or group.

Managing Roles and Users

72 Dell EMC Search Deployment and Administration Guide

c. In the Directory field, specify an authentication provider.

For example, the name of the Active Directory.

d. Click Find.

The list of user or user groups appears. Note: If you click Find before specifying a substring, the entire directory is returned. This action might slow performance.

To search for all users that contain Admin:

a. Type Admin.

b. Click Find.

e. Select a user, group, or click Select all.

f. Click OK.

The Manage Roles window appears.

7. To assign the role to a user or group, select Read Only Search (Index).

The Read Only Search (Index) role cannot perform the following actions:

l See inline preview for hits

l View full preview for hits

l Download files locally

l Restore files to an alternate location

Managing roles This section describes how to add and edit user roles and assign access privileges to administrators.

Assign roles to users or groups About this task

With the System Administrator or Application Administrator role, you can assign roles to users or groups.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

l System The System Administration view appears.

2. Click Administration > Roles.

The Manage Roles window appears.

3. To add a user or group, click .

The Select User window appears.

Managing Roles and Users

Dell EMC Search Deployment and Administration Guide 73

4. In the Select User window, perform the following steps:

a. In the Name field, restrict the search to one of the following categories:

l Users or Groups

l Users

l Groups

b. Type the name of the user or group.

c. In the Directory field, specify an authentication provider.

For example, the name of the Active Directory.

d. Click Find.

The list of user or user groups appears. Note: If you click Find before specifying a substring, the entire directory is returned. This action might slow performance.

To search for all users that contain Admin:

a. Type Admin.

b. Click Find.

e. Select a user, group, or click Select all.

f. Click OK.

The Manage Roles window appears.

5. To assign a role to a user or group, click one or more of the following options:

l Application Administrator

l Search Administrator

Remove users or groups With the System Administrator or Application Administrator role, you can remove users or groups.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

l System The System Administration view appears.

2. Click Administration > Roles.

The Manage Roles window appears.

3. Click the name of the user or group you want to delete.

4. Click .

5. To remove the user or group, in the Confirm window, click Confirm.

Managing Roles and Users

74 Dell EMC Search Deployment and Administration Guide

Results

The users or groups are no longer listed.

Edit role assignments With the System Administrator or Application Administrator role, you can assign or edit roles.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

l System The System Administration view appears.

2. Click Administration > Roles.

The Manage Roles window appears.

3. Choose the user or group whose role you want to edit.

4. Click one or more of the following options:

l Application Administrator

l Full Access Search (Global)

The following figure displays the Manage Roles window.

Figure 10 Manage Roles window

Managing Roles and Users

Dell EMC Search Deployment and Administration Guide 75

Managing Roles and Users

76 Dell EMC Search Deployment and Administration Guide

CHAPTER 5

Using the Dashboard

This section includes the following topics:

l View index health...................................................................................................................78 l View source server health......................................................................................................78 l View collector node health.....................................................................................................78 l View index cluster health.......................................................................................................79 l View system notifications......................................................................................................79 l View application notifications................................................................................................ 79

Dell EMC Search Deployment and Administration Guide 77

View index health About this task

You can view index health as a System Administrator or as an Application Administrator:

l The Application Administrator can view only the data indexes that were created for the Avamar domains or NetWorker RDZs being indexed.

l The System Administrator can view both data indexes and system indexes.

To view the health of the indexes, click Administration > Dashboard.

The status for each index appears in the Health pane.

To view health details for an index, click , and then click More....

View source server health About this task

Only an Application Administrator can view the health of the source servers.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. To view the health of each source server, click Administration > Dashboard.

The status for each source server appears in the Health pane.

3. To view health details for a source server, click , and then click More....

The Sources window appears.

View collector node health Only a System Administrator can view the health of the collector nodes.

Procedure

1. To view the health of the collector nodes, click Administration > Dashboard.

The status for each collector node appears in the Health pane.

2. To view storage and memory thresholds, current values, components, status, and agents for the collector nodes, click , and then click More....

The System window appears.

Using the Dashboard

78 Dell EMC Search Deployment and Administration Guide

View index cluster health Only a System Administrator can view the health of the index cluster.

Procedure

1. To view the health of the index cluster, click Administration > Dashboard.

The status for the index cluster appears in the Health pane.

2. To view index cluster details, click More....

The Index Cluster dialog box appears.

View system notifications The notification pane allows you to view up to five recent notifications for the system.

Procedure

1. To select the System Administration view, in the Manage drop-down list, click System.

2. To view system notifications, click Administration > Dashboard.

Notifications display chronologically in the Notifications pane. The first five notifications are displayed.

3. To view all notifications, click More....

4. To change the view to display unread, read, or all notifications, click .

5. To mark a notification as read or unread, select .

View application notifications The notification pane allows you to view up to five recent notifications for tasks and jobs.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. To view application notifications, click Administration > Dashboard.

Notifications display chronologically in the Notifications pane. The first five notifications are displayed.

3. To view all notifications, click More....

4. To mark a notification as read, select .

Using the Dashboard

Dell EMC Search Deployment and Administration Guide 79

Using the Dashboard

80 Dell EMC Search Deployment and Administration Guide

CHAPTER 6

Monitoring Jobs, Services, and System Health

This section includes the following topics:

l Jobs...................................................................................................................................... 82 l Job types and statuses..........................................................................................................82 l Monitor search jobs...............................................................................................................84 l Monitor index jobs.................................................................................................................84 l Monitor system jobs..............................................................................................................85 l Stop a pending or running job................................................................................................86 l View health............................................................................................................................86 l View services........................................................................................................................ 86 l View agents...........................................................................................................................87

Dell EMC Search Deployment and Administration Guide 81

Jobs In the Jobs window, you can view detailed information and status for collections (indexing), search and system jobs, and tasks.

During an indexing operation, the Search software determines new backups to index. When new backups are identified, the metadata for the items that are inside the backup are pulled down to the Search nodes and indexed. This process is called a collection.

A collection runs automatically on each zone (Avamar domain) based on the schedule that is specified when it is added. By default, a collection runs at 2:00 a.m. each day. However, you can change the recurrence schedule for indexing by editing the source properties.

When a collection process starts, the Search software creates the following jobs:

l Source Syncchecks for updated zones (Avamar domains or NetWorker RDZs). When a zone is removed, the index and collection jobs associated with it are deleted.

l Collection Processcarries out an indexing operation for new backups.

Search jobs include Full Content Indexing (FCI), downloading, and restore. System jobs are background jobs that monitor the system, such as determining the status of source servers.

Jobs can be further broken down into tasks. For example, for a collection job, there is one task for every client that is processed.

Job types and statuses To determine a job type or status, hover over a job button.

About this task

To view the list of jobs, click Administration > Jobs.

The following table describes the job types.

Table 17 Job types

Job types Description

FCI

Performing a targeted Full Content Index of search results.

Delete Source

Deleting a source.

Download

Downloading a search result.

System

Performing system jobs and services, including the updating of the status and cache for configured sources.

Note: System jobs are hidden by default. They can be seen by updating the filters.

Monitoring Jobs, Services, and System Health

82 Dell EMC Search Deployment and Administration Guide

Table 17 Job types (continued)

Job types Description

Collection Process

Indexes the clients for the associated zone.

Source Sync

Connects to the source server to synchronize the list of zones and clients.

Add Source

Adding a new source.

Restore

Triggers a restore job on a source server.

The following table describes the task status.

Table 18 Task status

Status Description

Spawning

Indicates a job has been triggered.

Pending

Indicates a job is waiting to begin.

Running

Indicates a job is currently being performed.

Stopping

Indicates a job is being stopped.

Success

Indicates a job has been performed successfully.

Failed

Indicates a job has failed.

Stopped

Indicates a job has stopped.

Timeout

Monitoring Jobs, Services, and System Health

Dell EMC Search Deployment and Administration Guide 83

Table 18 Task status (continued)

Status Description

Indicates a job has timed out.

If a source job is still running after 10 minutes, the job is marked as a timeout.

Blackout

Indicates a job has been restricted from running.

Monitor search jobs Search jobs include Full Content Indexing (FCI), downloading, and restore.

About this task

To monitor search jobs as a user with the Full Access Search (Global) role, click Search > View Jobs.

To monitor jobs as an Application Administrator, click Administration > Jobs.

Use the following procedure to limit the jobs view to search jobs only.

Procedure

1. Click Administration > Jobs.

The Jobs window opens.

2. To open the list of available job filters, click .

The filters menu appears.

3. To narrow the jobs list to display only search jobs, ensure that only the following job types are selected:

l FCI

l Download

l Restore

4. Click Apply.

Only search jobs display in the job list.

5. To view a detailed list of tasks for a job, click View tasks.

The list of tasks appear.

The tasks view displays the status of each task, the total number of backups for the client, and the number of backups that have been processed.

6. To refresh the list of jobs, click .

Monitor index jobs Procedure

1. Click Administration > Jobs.

Monitoring Jobs, Services, and System Health

84 Dell EMC Search Deployment and Administration Guide

The Jobs window opens.

2. To open the list of available job filters, click .

The filters menu appears.

3. To narrow the jobs list to display only index jobs, select the Collection Process job type.

4. Click Apply.

Only index jobs display in the job list.

5. To view a detailed list of tasks for a job, click View tasks.

The list of tasks appear.

The tasks view displays the status of each task, the total number of backups for the client, and the number of backups that have been processed.

6. To refresh the list of jobs, click .

Monitor system jobs System jobs run at typical intervals. By default, system jobs do not appear in the Jobs view.

About this task

To view system jobs, use the following procedure.

Procedure

1. In the Manage drop-down list, select one of the following options:

l Avamar The Avamar Administration view appears.

l NetWorker The NetWorker Administration view appears.

2. Click Administration > Jobs.

The Jobs window opens.

3. To view the system jobs together with all job types, click .

System jobs appear with all other jobs.

4. To narrow the jobs list to display only system jobs:

a. Click .

The filters menu appears.

b. Ensure that only the System filter is selected.

c. Click Apply.

Only system jobs appear in the list of jobs.

5. To view a detailed list of tasks for a job, click View tasks.

The list of tasks appear.

The tasks view displays the status of each task, the total number of backups for the client, and the number of backups that have been processed.

6. To refresh the list of jobs, click .

Monitoring Jobs, Services, and System Health

Dell EMC Search Deployment and Administration Guide 85

Stop a pending or running job You can stop long running or large jobs, such as a Full Content Indexing (FCI) job that sends many requests. When you stop a job, further requests are not sent to the source.

About this task

To stop a job, perform the following steps:

Procedure

1. Click Administration > Jobs.

2. Select one or more pending or running jobs from the list, and then click .

Note: You can stop job requests that are in the queue. However, it is not possible to stop requests that are already being processed on the backup server.

View health About this task

In the System Administration view, you can view storage and memory thresholds and current values of each backup server.

Procedure

1. To select the System Administration view, in the Manage drop-down list, select System.

2. To view the health of the system, click Administration > System.

The value in the Current column is color coded according to the following threshold values:

Table 19 Threshold values

Color Threshold value

Green Acceptable

Yellow Near threshold

Red Exceeds threshold

When thresholds exceed acceptable values, the system generates notifications.

Note: If the amount of available data disk space falls below the lower threshold of the required space, all active jobs are paused. Manually resume the paused jobs after more disk space becomes available.

3. To view system notifications, click Administration > Dashboard > Notifications > More.

View services About this task

In the System Administration view, you can view the components, status, and version of each backup server. The status updates every 10 minutes.

Note: If a service stops running, the system restarts the service automatically. If the problem that stopped the service is unresolved, the system might not restart, for example, when the

Monitoring Jobs, Services, and System Health

86 Dell EMC Search Deployment and Administration Guide

system is out of disk space or the network is down. A notification is sent when disk space is low. When disk space falls below the low threshold, consider the following points:

l If disk space falls below the low threshold on the System or Application disk, all jobs and tasks that are running on that node are stopped.

l If disk space falls below the low threshold on the Elasticsearch data disk, all jobs and tasks that are running on all nodes are stopped.

l New jobs remain in a pending state until current disk space indicates an acceptable (green) or near threshold (yellow) value.

l Indexing jobs continue to run according to their set schedule, or you can trigger indexing jobs manually.

After a service restarts, the UI might not reflect the change in status until the next 10 minute refresh cycle.

Procedure

1. To select the System Administration view, in the Manage drop-down list, select System.

2. To view system services, click Administration > System.

When the status changes, the system generates notifications.

3. To view system notifications, click Administration > Dashboard > Notifications > More.

View agents In the System Administration view, you can view the installed agents and status for each backup server. When the status changes, the system generates notifications. The status updates every 10 minutes.

Procedure

1. To select the System Administration view, in the Manage drop-down list, select System.

2. To view agents, click Administration > System.

You can view the following details for an agent:

l Node

l Last time the status was updated

l Agent

l Source name

l Status

l Version

When the agent's status changes, the UI might take several minutes to update.

Monitoring Jobs, Services, and System Health

Dell EMC Search Deployment and Administration Guide 87

Monitoring Jobs, Services, and System Health

88 Dell EMC Search Deployment and Administration Guide

CHAPTER 7

Performing Search and Viewing Search Results

This section includes the following topics:

l About searches..................................................................................................................... 90 l Optimize search performance............................................................................................... 93 l Optimize search results.........................................................................................................93 l Using keywords to search..................................................................................................... 98 l Sort search results............................................................................................................... 101 l View search result metadata.................................................................................................101 l Batch operations..................................................................................................................102 l Download a file from search results..................................................................................... 102 l Restore a file from search results (file system or NDMP files).............................................103 l Restore a file from search results (virtual machine files)..................................................... 104 l Full content index searches..................................................................................................105

Dell EMC Search Deployment and Administration Guide 89

About searches Search performs metadata searches on indexed files and folders, and full content searches on files that have had their full content indexed. Search supports keyword and advanced Lucene search queries. Search results include a summary of certain fields, such as file name, location, size, and date.

Search provides the following highlighting techniques:

l If a file is indexed for metadata, keywords or phrases that are found in the name of the file name or path are highlighted.

l If a file is indexed for full content indexing, keywords or phrases that are found in the body of the file are returned with a preview of the full contents. The preview displays and highlights the words around the matched text.

By default, the search is sorted by relevance, which defines how well the search results match the search criteria.

The following figure displays the Search window within the Search UI.

Figure 11 Search window

Note: Some search filters that appear in the Search UI change depending on the permissions of the user and the options that are selected. Search filters on page 91 provides more information.

Performing Search and Viewing Search Results

90 Dell EMC Search Deployment and Administration Guide

Perform searches The Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can complete administration or search tasks.

About this task

To perform searches, you must be assigned one of the following roles:

l Full Access Search (Index)

l Read Only Search (Index)

Note: You are required to log in to the Search UI each time it is opened or after a 20-minute period of inactivity.

To perform searches, complete the following steps.

Procedure

1. In a web browser, type the following URL:

https://nodename/search Note: Before continuing, you might be required to acknowledge a browser warning regarding self-signed certificates.

2. Log in to Search:

a. Type the username and password.

Note: The default username is Admin.

b. Click Sign In.

The Search window opens.

Search filters You can use search filters to narrow and optimize search results. Search filters include common search filters and application-specific search filters. Also, some filtering options are dynamic depending on the permissions of the user.

Common search filters and application-specific search filters

Common search filters are always available in the Search UI regardless of the permissions of the user. Common search filters include the following:

l Type (file name extension)

l Name (file name)

l Size (file size)

l Date (last modified date)

l Location (file path)

l Unindexable Content (filter results to include files that were not successfully full content indexed)

Application-specific search filters are only available when one application is selected. Application- specific search filters include Source, Client, and Backup Date. The Search software cannot perform these queries across applications.

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 91

Dynamic search filters

The filtering options that are available depend on the permissions of the user and include the Application, Index, and Search Type filters.

If a user can only access one index from one backup source (Avamar or NetWorker), the Search UI displays the filters that are shown in the following figure. If only one backup source is configured for indexing, the Application filter is not shown.

Figure 12 Search filters (Application, Index, and Search Type filters are not available)

If a user has permission to access multiple indexes from one backup source (Avamar or NetWorker), the Search UI displays the filters that are shown in the following figure.

Figure 13 Search filters (Index filter is available)

If a user has permission to access multiple indexes from multiple backup sources (Avamar and NetWorker), the Search UI displays the filters that are shown in the following figure.

Performing Search and Viewing Search Results

92 Dell EMC Search Deployment and Administration Guide

Figure 14 Search filters (Application, Index, and Search Type filters are available)

Optimize search performance At the core of Search is Elasticsearch, a high-performance indexing and search system that can search billions of objects within seconds.

To leverage Elasticsearch replication, at least two nodes are required.

To further increase the speed at which search results are returned, observe the following best practices:

l Use search filters to narrow the search scope and limit the number of results.

l Add specific queries only if you know the details of the content that you are looking for. For example, specify the file type, date, and owner by using the search filters instead of typing them directly into the Search bar.

l Limit the number of simultaneous queries by different users.

Optimize search results You can use one or a combination of the following filter options to narrow and optimize search results:

l Index

l Type (file name extension)

l Name (file name)

l Size (file size)

l Date (last modified date)

l Location (file path)

l Unindexable Content (filter results to include files that were not successfully full content indexed)

l Source (backup server)

l Client (backup client)

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 93

l Backup Date (filter results to include only files in particular backups)

Add or remove search filters You can add or remove search filters to optimize search results.

Procedure

1. To open the Search window, click .

The Search window appears and displays the search options.

2. To add filter options, select Add | Remove Filters.

3. To remove all filter options, select Add | Remove Filters.

4. Click Save and Close.

View search jobs The View Jobs window displays a list of pending and completed search jobs, including downloads, restores, and Full Content Indexing (FCI) jobs.

About this task

You can view the following details for a search job:

l Create time

l Start time

l End time

l Processed

l Succeeded

l Failed

l Duplicated

l Skipped

Procedure

1. To view search jobs, in the Search window, click View Jobs.

To expand the window, click Maximize.

2. Click OK.

Narrow a search by folder or file To narrow the search by folder or file, complete the following steps from the Search window.

Procedure

1. Click Search Type.

2. Select one or both of the following options:

l Search folder

l Search file

3. Click Save and Close.

Performing Search and Viewing Search Results

94 Dell EMC Search Deployment and Administration Guide

Narrow a search by file type To narrow the search by file type, complete the following steps from the Search window.

Search by file type

To narrow the search by file type:

1. In the Search window, select Type.

2. In the Type field, type a file name extension or multiple file extensions that are separated by commas.

3. In the Type field, click . The pie chart breaks down the current search by frequency of file type:

l Only the top 10 most frequent file types in the search display.

l Each file type extension is listed below the pie chart.

4. Click Save and Close.

Focus on specific file types

To narrow the view of the pie chart:

1. Open the Search window.

2. In the Type field, click .

3. Click a section of the pie chart or a file name extension from the legend. The search results for a specific file type appear.

The following figure displays the frequency of a specific file type.

Figure 15 File type frequency

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 95

Narrow a search by file attribute About this task

You can narrow the search results by applying one or more of the following search filters.

File name Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. Select Name.

3. In the Name field, select one of the following options:

l Contains with (default)

l Begins with

l Ends with

4. In the Name field, type the file name.

The file name can include wildcard characters (*). Note: Only use the wildcard character to search for file names that include the wildcard character within the name.

5. Click Save and Close.

File size Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. Select Size.

3. In the Size field, specify a minimum or maximum file size.

4. To view the range of sizes:

a. In the Size field, click .

b. Click a section of the bar chart.

The search results appear.

5. Click Save and Close.

File location Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. Select Location.

3. In the Location field, type a file path, and then enclose the file path in quotations.

For example: "/ifs/data/projects"

Performing Search and Viewing Search Results

96 Dell EMC Search Deployment and Administration Guide

4. To search for a keyword inside of the file path, type the keyword with no extra characters.

5. Click Save and Close.

Narrow a search by date and time attributes You can narrow the search results by applying one or more of the following search filters.

Date

About this task

The date represents the date that the file or folder was last modified.

Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. Select Date.

3. In the Date field, type a start or end date.

4. To view the range of dates:

a. In the Date field, click .

b. Click a section of the bar chart.

The search results appear.

5. Click Save and Close.

Include content that was not indexed in the search About this task

To search for items that were not successfully full content indexed, consider the following factors:

l File type or size.

l Text was not extracted from the file.

Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. Select Unindexable Content.

3. In the list box, select Yes.

4. Click Save and Close.

Narrow a search by backup date To filter results to include only files in particular backups, complete the following steps from the Search window.

Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. If both NetWorker and Avamar are configured for indexing, in the Application drop-down list, select either Avamar or NetWorker.

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 97

The Backup Date filter appears. Note: If only one backup source is configured for indexing, disregard this step.

3. Select Backup Date.

4. In the Backup Date field, type a start or end date.

Narrow a search by backup source or client You can narrow the search results by applying one or more of the following search filters.

Specify a backup source Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. If both NetWorker and Avamar are configured for indexing, in the Application drop-down list, select either Avamar or NetWorker.

The Source filter appears. Note: If only one backup source is configured for indexing, disregard this step.

3. Select Source.

4. In the Source drop-down list, select the name of an Avamar or NetWorker server.

5. To display a visual breakdown of the current search results and filter for specific clusters, click .

Specify a client

Before you begin

To narrow a search by client, ensure that you have selected a source server.

Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. If both NetWorker and Avamar are configured for indexing, in the Application drop-down list, select either Avamar or NetWorker.

The Client filter appears. Note: If only one backup source is configured for indexing, disregard this step.

3. Select Client.

4. In the Client drop-down list, select an Avamar or NetWorker client.

Using keywords to search About this task

To perform a keyword search, use one of the following procedures.

Performing Search and Viewing Search Results

98 Dell EMC Search Deployment and Administration Guide

Perform a basic search Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. In the Search dialog box, type a keyword.

3. Click Search.

The search results page appears.

4. (Optional) To view additional file details for a particular search hit, on the search results page, click Detail.

5. (Optional) To download a file, full access permissions are required:

Note: You can download files locally only if you have search administrator rights with all access privileges.

a. On the search results page, select the file that you want to download, and then click Download.

Note: You can only download a single file at one time.

The Completed dialog box appears.

b. Click OK.

The Search software starts the Download operation.

c. To check the download progress, click View Jobs.

The View Jobs window appears and displays the jobs and their status.

d. To download the file to the local disk, click the name of the job.

You can download a file only when the job status indicates Success.

e. Click OK.

Perform an advanced search by using a Lucene query Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. In the Search dialog box, type a Lucene query.

3. Click Search.

The search results page appears.

The following table includes Lucene syntax examples.

Table 20 Example Lucene syntax

Syntax examples Description

field:value The field contains the value

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 99

Table 20 Example Lucene syntax (continued)

Syntax examples Description

field:"phrase" The field contains the exact phrase

field:(value1 OR value2) The field contains one or both values

_ missing_:field The field is missing a value

_ exists_: field The field has a non-null value

field:qu?ck bro * Use wildcards

xvname:/joh?n(ath[oa]n)/ Use regular expression

field:quikc~brwn~foks~ Words that are similar

field:"fox quick"~ 5 No more than 5 words between them

xvdate:[2003-01-01 TO 2004-01-01] Match any day in range

xvdate:{* TO 2012-12-31} Specified date search

xvsize:>10000 All files with sizes over 10,000 bytes

quick brown +fox -news Include the word fox, exclude the word news

4. (Optional) To view additional file details for a particular search hit, on the search results page, click Detail.

5. (Optional) To download a file, full access permissions are required:

Note: You can download files locally only if you have search administrator rights with all access privileges.

a. On the search results page, select the file that you want to download, and then click Download.

Note: You can only download a single file at one time.

The Completed dialog box appears.

b. Click OK.

The Search software starts the Download operation.

c. To check the download progress, click View Jobs.

The View Jobs window appears and displays the jobs and their status.

d. To download the file to the local disk, click the name of the job.

You can download a file only when the job status indicates Success.

e. Click OK.

Performing Search and Viewing Search Results

100 Dell EMC Search Deployment and Administration Guide

Perform a search on a full content indexed file Use the Full Content Index (FCI) feature to perform a targeted FCI of search results so you can preview the content and search for keywords. This operation can also be performed on a batch of search results.

Before you begin

You can perform a full content index or preview the contents of a file only if you have Search Administrator rights with all access privileges.

Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. In the Search dialog box, type a keyword or a Lucene query.

3. Click Search.

The search results page appears.

4. Select a file that you want to full content index, and then click FCI.

Alternatively, you can full content index multiple files by using the batch operation controls at the top of the search results page.

5. To monitor progress of a full content indexing job, click View Jobs.

6. To refresh the search results, click Search. This step re-runs the search operation.

The FCI button appears next to the file that has been full content indexed and the Preview option appears.

7. (Optional) To view a summary of the text inside a file, or a thumbnail of an image file, click Preview.

You can now search for content within the file from the search bar.

Sort search results You can sort search results by changing the order of results from ascending to descending, or you can filter results based on specific properties.

About this task

To change the criteria on which the results are sorted, perform the following steps.

Procedure

1. To change the filter order from ascending to descending, click the Z to A button.

2. To change the sorting method, in the Sort By (DESC) drop-down list, select an option.

The default sorting method is Relevance (sort score). The Relevance score determines how well the search results match the search criteria.

3. Review the search results.

View search result metadata About this task

To view the metadata of a search result, on the search results page, click Detail for the file.

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 101

The following search result information displays:

l Name of the application that stores the data, for example, Avamar or NetWorker

l Index

l File name, location, type, and size

l Date the file was indexed

l For a file that was full content indexed, application-level metadata

l A list of all backups the file was found in

Batch operations Each search result has an associated set of buttons to perform different operations for that file. You can also select multiple files and perform batch operations by using the checkboxes for each row, choosing an operation from the drop-down list, and then clicking the Selected button.

Use the Select All checkbox to select all results on this page for a batch operation.

Figure 16 Performing batch operations

Download a file from search results About this task

You can download a file locally only if you have search administrator rights with all access privileges.

Procedure

1. In the list of search results, select a file.

2. To download the file, click Download.

The Completed dialog box appears.

3. Click OK.

The Search software starts the Download operation.

4. To check the download progress, click View Jobs.

The View Jobs window appears and displays the jobs and their status.

Performing Search and Viewing Search Results

102 Dell EMC Search Deployment and Administration Guide

5. To download the file to the local disk, click the name of the job.

You can download a file only when the job status indicates Success. Note: If you cannot download the file, check the pop-up blocker settings for the browser.

6. Click OK.

Restore a file from search results (file system or NDMP files) You can restore file system or NDMP files directly from the search results without the need for intermediate steps. This operation can also be performed on a batch of search results.

Before you begin

Ensure that backups from one or more file system or NDMP clients have been indexed:

1. Click Administration > Indexes.

2. Review the information for the index.

Procedure

1. Open the Search window, by clicking .

The Search window appears.

2. To search for indexed files, type a query in the search bar.

The list of search results appears.

3. To exclude files from the search results that are not file system or NDMP files:

a. Click Add | Remove Filters.

b. In the Index drop-down list, clear the checkbox beside the name of the VM client.

c. Click Save and Close.

4. In the list of search results, select a file from a file system or NDMP client, and then click Restore.

Alternatively, you can restore multiple files by using the batch operation controls at the top of the search results page.

The Restore dialog box appears.

5. In the actions drop-down list, select an option.

Note: For NDMP files, you must select Overwrite.

6. In the Restore to field, select one of the following options:

l Original PathRestores the file to its original location. If a file with the same name exists at the location, the Search software skips, overwrites, or renames the file that was restored, based on the setting that you specified in the actions drop-down list.

l Destination PathRestores the file to an alternate location. You can restore to either the same client with a different path, or to an alternate client on the Avamar server.

7. Click Restore.

To monitor the status of the restore operation, click Administration > Jobs. Alternatively, you can view this information in Avamar Administrator.

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 103

8. After the restore operation is complete, verify that the file has been restored to the correct location.

Restore a file from search results (virtual machine files) You can restore virtual machine files directly from the search results without the need for intermediate steps. This operation can also be performed on a batch of search results.

Before you begin

Ensure that backups from one or more Windows virtual machine clients have been indexed:

1. Click Administration > Indexes.

2. Review the information for the index.

For detailed steps on how to configure virtual machine indexing on the Avamar server, see Configure virtual machine indexing on the Avamar server on page 52.

Procedure

1. Open the Search window, by clicking .

The Search window appears.

2. To search for indexed files, type a query in the search bar.

The list of search results appears.

3. To exclude files from the search results that are not virtual machine files:

a. Click Add | Remove Filters.

b. In the Index drop-down list, clear the checkbox beside the name of the zone.

c. Click Save and Close.

4. In the list of search results, select a file from a virtual machine client, and then click Restore.

Alternatively, you can restore multiple files by using the batch operation controls at the top of the search results page.

The Restore dialog box appears.

5. In the actions drop-down list, select an option.

Note: For virtual machine files, you must select Overwrite.

6. To restore access permissions for the file, select Restore Access Control List (ACL).

7. In the Restore to field, select one of the following options.

l Original PathRestores the file to its original location. If a file with the same name exists at the location, the Search software overwrites the file that was restored.

l Destination PathRestores the file to an alternate location. You can restore to either the same client with a different path, or to an alternate client on the Avamar server.

8. For the target virtual machine, specify the admin credentials.

For Original Path restores, the drive letter is also required.

9. Click Restore.

Performing Search and Viewing Search Results

104 Dell EMC Search Deployment and Administration Guide

To monitor the status of the restore operation, click Administration > Jobs. Alternatively, you can view this information in Avamar Administrator.

10. After the restore operation is complete, verify that the file has been restored to the correct location.

Full content index searches The Search software performs metadata searches on indexed files and folders, and full content searches on files that have had their full content indexed. Search supports keyword and advanced Lucene search queries. By default, a search operation is sorted by Relevance (score), which defines how well the search results match the search criteria.

Consider the following points:

l If a file is indexed for metadata, keywords or phrases that are found in the name of the file or path are highlighted. Search results include a summary of certain fields for the file, such as file name, path, size, date, and ownership.

l If a file is indexed for full content, keywords or phrases that are found in the body of the file are returned with a preview of the full contents. The preview displays and highlights the words around the matched text.

Perform a search on a full content indexed file Use the Full Content Index (FCI) feature to perform a targeted FCI of search results so you can preview the content and search for keywords. This operation can also be performed on a batch of search results.

Before you begin

You can perform a full content index or preview the contents of a file only if you have Search Administrator rights with all access privileges.

Procedure

1. Open the Search window, by clicking .

The Search window appears and displays the search options.

2. In the Search dialog box, type a keyword or a Lucene query.

3. Click Search.

The search results page appears.

4. Select a file that you want to full content index, and then click FCI.

Alternatively, you can full content index multiple files by using the batch operation controls at the top of the search results page.

5. To monitor progress of a full content indexing job, click View Jobs.

6. To refresh the search results, click Search. This step re-runs the search operation.

The FCI button appears next to the file that has been full content indexed and the Preview option appears.

7. (Optional) To view a summary of the text inside a file, or a thumbnail of an image file, click Preview.

You can now search for content within the file from the search bar.

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 105

Search for files that have not undergone a full content index About this task

You can perform a FCI or preview the contents of a file only if you have Search Administrator rights with all access privileges.

Procedure

1. Open the Search window, by clicking .

The Search window appears.

2. (Optional) To further limit the search, select a search filter.

3. In the Search bar, type the following keyword:

_missing_:xvcontent

4. Click Search.

Restrict a search to only Full Content Index (FCI) files About this task

You can only perform a FCI or preview the contents of a file if you have Search Administrator rights with all access privileges.

Procedure

1. Open the Search window, by clicking .

The Search window appears.

2. (Optional) To further to limit the search, select a search filter.

3. In the Search bar, type the following keyword:

xvhascontent:true

4. Click Search.

Search for application-specific metadata About this task

In addition to the basic file system metadata that is stored in the index, Full Content Indexing (FCI) reads additional application-specific metadata for processed files where available.

You can only perform a FCI operation or preview the contents of a file if you have Search Administrator rights with all access privileges.

Examples of application-specific metadata include the following:

l Author

l Title

l Title and artist for audio files

l Word count for Microsoft Office files

l Camera name

l Resolution for image files

Performing Search and Viewing Search Results

106 Dell EMC Search Deployment and Administration Guide

Procedure

1. Open the Search window, by clicking .

The Search window appears.

2. (Optional) To further limit the search, select a search filter.

3. In the Search bar, type the syntax that targets a specific metadata field.

For example, type the following syntax to search for a specific keyword:

xvmetadata:"metadata_subject:keyword"

4. Click Search.

Matches are highlighted in a short snippet.

5. To view the application-specific metadata, click Detail.

Performing Search and Viewing Search Results

Dell EMC Search Deployment and Administration Guide 107

Performing Search and Viewing Search Results

108 Dell EMC Search Deployment and Administration Guide

APPENDIX

Troubleshooting

This section includes the following topics:

l Troubleshoot deployment issues...........................................................................................110 l Log files................................................................................................................................110 l Managing logs.......................................................................................................................113 l Troubleshooting the web server........................................................................................... 121 l Edit the Search nginx.conf file..............................................................................................121 l Troubleshooting worker services for indexing issues............................................................ 121 l Increase the maximum memory for the search-avamar-worker service............................... 122 l Increase the maximum memory for the search-networker-worker service...........................123 l Troubleshooting Elasticsearch............................................................................................. 123

Dell EMC Search Deployment and Administration Guide 109

Troubleshoot deployment issues If you cannot access the virtual appliance online after 10 minutes, there might be an issue with deployment. Use the following steps to resolve common issues.

Procedure

1. Log in to the virtual machine as the root user.

2. To check the network settings, at the command prompt, type the following command:

yast

If static IPs were specified during deployment, ensure that Dynamic Addresses (DHCP) are not specified.

3. Ensure that you can ping the following hosts:

l Default gateway

l DNS servers

l Avamar server

l NetWorker server

4. Validate the installation by typing the following commands:

cd /home/search

validate_search_install.sh [version] [username] [password]

where:

l versionSpecifies the version of the Search software.

l usernameSpecifies the username of the user.

l passwordSpecifies the password of the user.

For example:

bash validate_search_install.sh 18.0.0.890 admin emc If content appears in red text, contact Support and provide all of the logs in the following locations:

l /home/search/log l /usr/local/search-deploy/log

5. Verify that the deployment completed successfully by reviewing the deployment log in / home/search/log.

The message deployment finished appears.

Log files All logs files are stored on disk 3, the separated disk. The /usr/local/search/log is mapped to the /mnt/search/log. The logs are filed to a dedicated disk so they cannot fill the system disk.

The default log directory, /usr/local/search/log, contains the following logs.

Troubleshooting

110 Dell EMC Search Deployment and Administration Guide

Table 21 Log files

Logs Description

search-adminapi- nodename

Main log file for the Admin REST API

search-adminapi-stderr- nodename

List of API calls made into the Admin REST API

search-adminapi-stdout- nodename

Details about the debugging output for the Admin REST API

search-api-nodename Main log file for the Search REST API

search-api-stderr- nodename

List of API calls made into the Search REST API

search-api-stdout- nodename

Details about the debugging output for Search REST API

search-avamar-action- nodename

Main log file for the Avamar action service REST API

search-avamar-action- stderr-nodename

A succinct list of API calls made into the Avamar action service REST API

search-avamar-action- stdout-nodename

Details about the debugging output for the Avamar action service REST API

search-avamar-worker- nodename

Main log file for the Avamar Java worker service

search-avamar-worker- stdout-nodename

Details about the Avamar Java worker service settings

search-networker-action- nodename

Main log file for the NetWorker action service REST API

search-networker-action- stderr-nodename

A succinct list of API calls made into the NetWorker action service REST API

search-networker-action- stdout-nodename

Details about the debugging output for the NetWorker action service REST API

search-networker-worker- nodename

Main log file for the NetWorker Java worker service

search-networker-worker- stdout-nodename

Details about the NetWorker Java worker service settings

search-worker-nodename Main log file for the Search platform Java worker service

search-worker-stdout- nodename

Details about the Search platform Java worker service settings

Subdirectories contain the logs for the following services.

Table 22 Services and logs

Logs Description

Elasticsearch Index engine logs

Troubleshooting

Dell EMC Search Deployment and Administration Guide 111

Table 22 Services and logs (continued)

Logs Description

CIS Common Index Service logs

Nginx Web server logs

Puppet Puppet master and agent logs

Use a secure FTP client, such as WinSCP or PuTTy (psftp), to copy log files from the Search nodes to a Windows computer.

Note: The WinSCP tool provides a GUI, and retains the settings, including both local and remote directory locations.

Copy log files (WinSCP) Before you begin

Install WinSCP by downloading WinSCP from winscp.net.

Procedure

1. From the WinSCP wizard, select Stored sessions, and click New.

2. Add a session by completing the following fields:

l Hostname

l Port number (default is 22)

l Root username

l Password

3. Click Directories and complete the following fields:

l In the Remote directory field, type cd/usr/local/search/log l In the Local directory field, type local directory

4. To save the session:

a. Click Save.

b. Click Login.

5. Drag the logs from the Remote Directory section of the window to the Local Directory section of the window.

Copy log files (PuTTy) Use a secure FTP client, such as PuTTy (psftp) to copy log files from the Search nodes to a Microsoft Windows computer.

Before you begin

Download and install PuTTy from winscp.net.

Procedure

1. Log in with the Search Root user credentials that are created during deployment.

2. Change to the log directory:

cd/usr/local/search/log

Troubleshooting

112 Dell EMC Search Deployment and Administration Guide

3. To download the log files, run the mget* command.

4. If required, unzip the log files.

Older versions of the logs are compressed based on size or date.

Managing logs All log files are stored on disk 3, the separated disk. The logs are located in /usr/local/ search/log. The logs are filed to a dedicated disk so they cannot fill the system disk.

The default log directory, /usr/local/search/log, is mapped to the /mnt/search/log. Follow the procedures in this section to learn how to manage the following log properties:

l Log file location

l Log level

l Log size

l Log count

Managing logs for API-based services To troubleshoot and diagnose problems, you can manage the log files of the following services and components:

l Admin API

l Search Admin API

l Common Indexing Service (CIS) Core

l CIS Scheduler

Log file location

The following table provides a summary of the log files available for the Admin/Search REST API.

Table 23 Admin/Search REST API log files

Module Configuration file Log file location Default log level

Admin API

/usr/local/ search/etc/ system.conf

{log_path}/search- adminapi-{host_name}.log

ERROR

{log_path}/search- adminapi-stdout- {host_name}.log

{log_path}/search- adminapi-stderr- {host_name}.log

Search API

/usr/local/ search/etc/ system.conf

{log_path}/search-api- {host_name}.log

ERROR

{log_path}/search-api- stdout-{host_name}.log

Troubleshooting

Dell EMC Search Deployment and Administration Guide 113

Table 23 Admin/Search REST API log files (continued)

Module Configuration file Log file location Default log level

{log_path}/search-api- stderr-{host_name}.log

Manage the log level The system.conf file provides the ability to modify the log level for the Admin/Search REST API.

About this task

To modify the log level, complete the following steps:

Procedure

1. Open the system.conf file with a text editor.

2. In the system.conf file, locate the following section:

"log": { "comments": "log.level VERBOSE = 0, INFO = 1, WARNING = 2, ERROR = 3", "admin_api": "/usr/local/search/log/search-adminapi- stevenzincdev.log", "search_api": "/usr/local/search/log/search-api-stevenzincdev.log", "level": 3 }

3. Change the log level by editing the level attribute:

Specify one of the following log levels:

l 0 l 1 l 2 l 3

4. Restart the corresponding services.

Manage log size and log count The logrotate utility manages the size of log files, and determines the number of archived log files to maintain.

About this task

Note: Cronjob runs on schedule on a daily basis to rotate API log files.

The following table outlines the logrotate configuration files for the Admin/Search REST API, CIS core service, and CIS scheduler service.

Table 24 Configuration files

Service Configuration file

Admin API /etc/logrotate.d/search- adminapi.lr

Troubleshooting

114 Dell EMC Search Deployment and Administration Guide

Table 24 Configuration files (continued)

Service Configuration file

Search API /etc/logrotate.d/search-api.lr

CIS core service /etc/logrotate.d/search-cis- core.lr

CIS scheduler service /etc/logrotate.d/search-cis- schedule.lr

Procedure

1. Open the corresponding logrotate configuration file.

2. In the logrotate configuration file, locate the following section:

/usr/local/search/log/search-adminapi*.log { su root root rotate 5 size 100M missingok nodateext notifempty compress delaycompress lastaction pid=/var/run/search/search-adminapi.pid test -s $pid && kill -USR1 "$(cat $pid)" endscript }

3. Change the log size and the number of log files to maintain, by editing the rotate and size parameters.

where:

l rotate defines the number of archived log files that the Search software maintains. The default value is 5.

l size defines the maximum size of the log file. The default value is 100M.

Managing logs for Worker and Action services To troubleshoot and diagnose problems, you can manage the log files for the following services and components:

l Avamar Action service

l Avamar Worker service

l NetWorker Action service

l NetWorker Worker service

l Search Worker service

Log file location

The following table provides a summary of the log files available for the action services, worker services, and system worker service.

Troubleshooting

Dell EMC Search Deployment and Administration Guide 115

Table 25 Worker Services log files

Module Configuration file Log file location

Search-Worker /usr/local/search/etc/ log4j2-search-worker.xml

{log_path}/search- worker.log

Avamar-Worker /usr/local/search/etc/ log4j2-search-avamar- worker.xml

{log_path}/search- avamar-worker- {host_name}.log

Networker-Worker /usr/local/search/etc/ log4j2-search-networker- worker.xml

{log_path}/search- networker-worker- {host_name}.log

Avamar-Action-Service /usr/local/search/etc/ log4j2-search-avamar- action.xml

{log_path}/search- avamar-action- {host_name}.log

Networker-Action- Service

/usr/local/search/etc/ log4j2-search-networker- action.xml

{log_path}/search- networker-action- {host_name}.log

Manage the log level The log4j file provides the ability to modify the log level for the action services, worker services, and system worker service.

About this task

To modify the log level, complete the following steps:

Procedure

1. Open the corresponding log4j configuration file.

2. In the log4j configuration file, perform the following tasks:

l To modify the log level for the Search Avamar Action service or the Search NetWorker Action service, locate the following section:

l To modify the log level for the Search Avamar Worker service, Search NetWorker Worker service, or Search Worker service, locate the following section:

3. Change the log level by editing the level attribute.

Specify one of the following log levels:

l trace l debug l info l warn l error

Troubleshooting

116 Dell EMC Search Deployment and Administration Guide

4. Restart the corresponding services.

Manage log size and log count The log4j file manages the size of log files, and determines the number of archived log files to maintain for the action services, worker services, and system worker service.

About this task

The following table lists the log4j configuration files.

Table 26 Configuration files

Service Configuration file

Avamar action service log4j2-search-avamar-action.xml

Avamar worker service log4j2-search-avamar-worker.xml

NetWorker action service log4j2-search-networker-action.xml

NetWorker worker service log4j2-search-networker-worker.xml

System worker service log4j2-search-worker.xml

Procedure

1. Open the corresponding log4j configuration file.

2. In the log4j configuration file, locate the following section:

3. Change the log size and the number of log files to maintain, by editing the SizeBasedTriggeringPolicy size and DefaultRolloverStrategy max attributes.

where:

l SizeBasedTriggeringPolicy size defines the maximum size of the log file. The default value is 100 MB.

l DefaultRolloverStrategy max defines the number of archived log files that the Search software maintains. The default value is 5.

Managing logs for Elasticsearch To troubleshoot and diagnose problems, you can manage the log files for the Elasticsearch service.

About the Elasticsearch logs The Elasticsearch log files are located in /usr/local/search/log/elasticsearch. The default logging level is ERROR.

Elasticsearch uses log4j to manage the log file level, size, and count. The configuration file for log4j is located at /etc/elasticsearch/log4j2.properties.

Troubleshooting

Dell EMC Search Deployment and Administration Guide 117

Manage the log level The log4j file provides the ability to modify the log level for Elasticsearch.

About this task

To modify the log level, complete the following steps:

Procedure

1. Open the corresponding log4j configuration file.

2. In the log4j configuration file, locate the following section:

rootLogger.level = error

3. Change the log level by editing the rootLogger.level attribute.

Specify one of the following log levels:

l trace l debug l info l warn l error

4. Restart the corresponding services.

Manage log size and log count The log4j utility manages the size of log files, and determines the number of archived log files to maintain for the Elasticsearch service.

Procedure

1. Open the log4j configuration file.

2. In the log4j configuration file, locate the sections that correspond to the following logs:

l rolling l deprecation_rolling l index_search_slowlog_rolling l index_indexing_slowlog_rolling

To adjust the size and number of retained logs, locate and modify the following parameters for the log you want to manage:

Table 27 Elasticsearch log parameters

Parameter name Description Default value

appender.rolling.policies.size.size The maximum allowed log size before rotation. Specify the value in KB, MB, or GB.

100 MB

appender.deprecation_rolling.policie s.size.size

appender.rolling.strategy.max The maximum number of rotated log files to retain.

5

appender.deprecation_rolling.strate gy.max

Troubleshooting

118 Dell EMC Search Deployment and Administration Guide

Table 27 Elasticsearch log parameters (continued)

Parameter name Description Default value

appender.index_search_slowlog_roll ing.policies.time.interval

The duration of the logging period, in days.

1

appender.index_indexing_slowlog_r olling.policies.time.interval

Managing logs for Nginx To troubleshoot and diagnose problems, you can manage the log files for Nginx.

Configuration file location The following table provides a summary of the configuration files available for Nginx. All the Nginx configuration files are located in /etc/nginx.

Table 28 Nginx log files

Module Configuration file

Avamar action service nginx.avamar-action.conf

CIS nginx.cis.conf

Nginx nginx.conf

NetWorker action service nginx.networker-action.conf

Search service nginx.search.conf

Modifying the log level

The Nginx logging options are highly configurable. The Nginx documentation provides more information.

Manage log size and log count

About this task

The logrotate utility manages the size of log files, and determines the number of archived log files to maintain. The Nginx logrotate configuration file is located at /etc/logrotate.d/ nginx.lr.

Procedure

1. Open the Nginx logrotate configuration file.

2. In the logrotate configuration file, locate the following section:

/usr/local/search/log/nginx/nginx*.log { su root root rotate 5 size 100M missingok nodateext notifempty compress delaycompress missingok lastaction pid=/var/run/nginx.pid

Troubleshooting

Dell EMC Search Deployment and Administration Guide 119

test -s $pid && kill -USR1 "$(cat $pid)" endscript

3. Change the log size and the number of log files to maintain, by editing the rotate and size parameters.

where:

l rotate defines the number of archived log files that Nginx maintains. The default value is 5.

l size defines the maximum size of the log file. The default value is 100M.

Manage logs for the Puppet agent To troubleshoot and diagnose problems, you can manage the log files for the Puppet agent.

Manage the log level The upgrade.conf file provides the ability to modify the log level for the Puppet agent.

About this task

The Puppet agent log files are located in /etc/puppet/log/puppet_agent.log. The default logging level is WARN.

The configuration file for the Puppet agent log is located at /etc/puppet/upgrade.conf.

Procedure

1. Open the corresponding configuration file.

2. In the upgrade.conf configuration file, locate the following section:

loglevel="WARN"

3. Change the log level by editing the loglevel attribute.

Specify one of the following log levels:

l DEBUG l INFO l WARN l ERROR

4. Restart the corresponding services.

Manage log size and log count

About this task

The logrotate utility manages the size of log files, and determines the number of archived log files to maintain. The Puppet agent logrotate configuration file is located at /etc/ logrotate.d/puppet.lr.

Procedure

1. Open the Puppet agent logrotate configuration file.

2. In the logrotate configuration file, locate the following section:

/usr/local/search/log/puppet/puppet_*.log { su root root

Troubleshooting

120 Dell EMC Search Deployment and Administration Guide

rotate 5 size 100M missingok nodateext notifempty compress delaycompress missingok }

3. Change the log size and the number of log files to maintain, by editing the rotate and size parameters.

where:

l rotate defines the number of archived log files that Nginx maintains. The default value is 5.

l size defines the maximum size of the log file. The default value is 100M.

Troubleshooting the web server This section lists the commands for troubleshooting the Search web server.

Web server control commands

The following service commands are available for managing the web server (NGINX):

l service nginx reload

l service nginx stop

l service nginx start

l service nginx reopen

Edit the Search nginx.conf file Use the following nginx.conf files to define ports, and manage SSL certificates and keys:

About this task

l nginx.search.conf l nginx.cis.conf l nginx.avamar-action.conf l nginx.networker-action.conf

Troubleshooting worker services for indexing issues This section outlines the log files, commands, and configuration files available for troubleshooting the Search Worker service.

Collector service control commands

You can use the following commands to troubleshoot the Search Avamar Worker service:

l service search-avamar-worker status l service search-avamar-worker stop

Troubleshooting

Dell EMC Search Deployment and Administration Guide 121

l service search-avamar-worker start l service search-avamar-worker restart You can use the following commands to troubleshoot the Search NetWorker Worker service:

l service search-networker-worker status l service search-networker-worker stop l service search-networker-worker start l service search-networker-worker restart Worker service log file

View the log file by using the Search log viewer on a Windows computer.

The Search Avamar Worker log is located at /usr/local/search/log.

The Search NetWorker Worker log is located at /usr/local/search/log.

The Search Avamar and NetWorker Worker logs roll over at 100 MB.

You can modify the settings for the Search Avamar or NetWorker Worker service in the following files:

l Avamar/usr/local/search/etc/log4j2-search-avamar-worker.xml.

l NetWorker/usr/local/search/etc/log4j2-search-networker-worker.xml.

To save the changes, restart the Search Avamar or NetWorker Worker service.

Table 29 Example log messages

Log message Description

INDEX FAIL: Connect failed to retrieve item

Cannot find the item on the local disk that was restored by connector

INDEX FAIL: Cannot read retrieved local item

Cannot read the item on local disk. Usually, the error is a permission issue

UNINDEXABLE: Failed to scrap text Tika cannot process the item

UNINDEXABLE: System error when scrapping text

JVM error when Tika is processing this item. Out-of-memory is the prime cause

INDEX FAIL: BulkResponse with fail message

Elasticsearch reports that it cannot process the index/update sub-request for this item

INDEX FAIL: Bulk request failure Elasticsearch might be unavailable, a network issue, and so on

Increase the maximum memory for the search-avamar-worker service

If the search-avamar-worker service lacks memory but there is enough system memory, the service memory can be increased. Memory issues can occur when performing full content indexing on large files.

Procedure

1. Open the following file:

/etc/init.d/search-avamar-worker

Troubleshooting

122 Dell EMC Search Deployment and Administration Guide

2. To increase the maximum memory, change the following line:

-Xmx memory value in the ARGUMENTS="-Xms1024M -Xmx3072M -XX:- UseGCOverheadLimit...

3. Save the file.

4. Restart the search-avamar-worker service.

Increase the maximum memory for the search-networker- worker service

If the search-networker-worker service lacks memory but there is enough system memory, the service memory can be increased. Memory issues can occur when performing full content indexing on large files.

Procedure

1. Open the following file:

/etc/init.d/search-networker-worker

2. To increase the maximum memory, change the following line:

-Xmx memory value in the ARGUMENTS="-Xms1024M -Xmx3072M -XX:- UseGCOverheadLimit...

3. Save the file.

4. Restart the search-networker-worker service.

Troubleshooting Elasticsearch To troubleshoot the Elasticsearch service, use the following log files, commands, and configuration files.

Control the Elasticsearch service About this task

To stop the Elasticsearch service, type the following command:

service elasticsearch stop To stop the search-avamar-worker service before stopping the Elasticsearch service, type the following command:

service elasticsearch start

View Elasticsearch logs Procedure

1. Type one of the following commands to view the Elasticsearch logs:

l /usr/local/search/log/elasticsearch/search_cluster.log l tail /usr/local/search/log/elasticsearch/search_cluster.log l vim /usr/local/search/log/elasticsearch/search_cluster.log

2. Download the logs to another computer by typing the psftp command.

Troubleshooting

Dell EMC Search Deployment and Administration Guide 123

View or change the Elasticsearch configuration About this task

To view or modify the Elasticsearch configuration, type the following commands:

l more /etc/elasticsearch/elasticsearch.yml l vim /etc/elasticsearch/elasticsearch.yml

Monitor the health of the Elasticsearch cluster Procedure

1. To check the health of the Elasticsearch cluster:

a. Log in to Search as a System Administrator.

b. Click Administration > System > Services.

c. Review the status of the Elasticsearch component.

2. Verify that the Elasticsearch node has been correctly connected to the cluster:

a. Review the following firewall configuration file:

/etc/sysconfig/SuSEfirewall2

b. Verify that the port 93009400 in the node network is open. For example:

FW_TRUSTED_NETS=" 10.98.27.0/24,tcp,440:449 127.0.0.0/24,tcp,9200 10.98.27.0/24,tcp,9300:9400

Insufficient memory causes the Elasticsearch service to shutdown If the ESXi host of the Search appliance does not contain enough memory, the Elasticsearch service shuts down and prevents the user from logging in to the Search software.

About this task

To determine the memory that was reclaimed by the host, type the following command: searchvm: # vmware-toolbox-cmd stat balloon Output similar to the following appears:

searchvm: # vmware-toolbox-cmd stat balloon 14702 MB

In this example, the vCenter does not have enough memory for all of the nodes, and tries to reclaim the memory (14 GB) from the Search node. Because Elasticsearch no longer has enough memory to run, it shuts down.

To avoid overtaxing the vCenter, perform either one of the following tasks:

l Reserve the full 32 GB of RAM for each Search node.

For detailed steps on how to set memory reservation on a virtual machine, refer to the following article:

Set Memory Reservation on a Virtual Machine.

Note: Before you configure the memory settings, stop the virtual machine.

l Disable the balloon driver.

Troubleshooting

124 Dell EMC Search Deployment and Administration Guide

For detailed steps on how to disable the balloon driver in a virtual machine, refer to the following article: </

Manualsnet FAQs

If you want to find out how the 18.2 Dell works, you can view and download the Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide on the Manualsnet website.

Yes, we have the Deployment And Administration Guide for Dell 18.2 as well as other Dell manuals. All you need to do is to use our search bar and find the user manual that you are looking for.

The Deployment And Administration Guide should include all the details that are needed to use a Dell 18.2. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide is by checking the Table of Contents at the top of the page where available. This allows you to navigate a manual by jumping to the section you are looking for.

This Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide consists of sections like Table of Contents, to name a few. For easier navigation, use the Table of Contents in the upper left corner.

You can download Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide free of charge simply by clicking the “download” button in the upper right corner of any manuals page. This feature allows you to download any manual in a couple of seconds and is generally in PDF format. You can also save a manual for later by adding it to your saved documents in the user profile.

To be able to print Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell Data Protection Search 18.2 Data Protection Deployment And Administration Guide as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.