Contents

Dell Data Protection Search 18.0 Data Protection Administration Guide PDF

1 of 100
1 of 100

Summary of Content for Dell Data Protection Search 18.0 Data Protection Administration Guide PDF

Dell EMC Search Version 18.0

Administration Guide 302-004-655

REV 01

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

Published June 2018

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, 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 Search 18.0 Administration Guide

Preface 7

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

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

Administration windows................................................................. 13 Search window...............................................................................18

Getting Started 21 Configuring a backup source...................................................................... 22

Preconfigured Avamar source server.............................................22 Default Avamar server limit............................................................22 Update an Avamar source server................................................... 22 Applying index and search analyzers..............................................24 Set connection limitations............................................................. 24 Set the blackout window for indexing............................................25 Start a collection on the source.....................................................25 Start a reconciliation job for a source server or zone.....................26 View the status and summary of the source.................................. 27 Select zones ................................................................................. 27

Manage indexes..........................................................................................27 Indexing overview.......................................................................... 27 Configure virtual machine indexing on the Avamar server..............28 Restrict index access.....................................................................29 View indexes..................................................................................30 Updating an index...........................................................................31

Managing notifications................................................................................31 Configure system notifications.......................................................31 Configure Avamar notifications......................................................32 Configure email notifications......................................................... 33

Replicate data indexes................................................................................33 Set search timeout options.........................................................................34 Optimize search performance.................................................................... 35 Configuring Full Content Indexing (FCI)..................................................... 35

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

Managing Roles and Users 39 Configure external OpenLDAP and Active Directory servers...................... 40 About roles................................................................................................. 42

System Administrator role............................................................. 42 Application Administrator role........................................................43 Full Access Search (Global) role.................................................... 44 Index specific search roles.............................................................46

Chapter 1

Chapter 2

Chapter 3

CONTENTS

Search 18.0 Administration Guide 3

Managing roles........................................................................................... 49 Assign roles to users or groups...................................................... 49 Remove users or groups................................................................ 50 Edit role assignments..................................................................... 51

Using the Dashboard 53 View index health....................................................................................... 54 View source server health.......................................................................... 54 View collector node health......................................................................... 54 View index cluster health............................................................................54 View system notifications...........................................................................55 View application notifications..................................................................... 55

Monitoring Jobs, Services, and System Health 57 Jobs........................................................................................................... 58 Job types and statuses...............................................................................58 Monitor search jobs....................................................................................60 Monitor index jobs.......................................................................................61 Monitor system jobs....................................................................................61 Stop a pending or running job.....................................................................62 View health.................................................................................................62 View services..............................................................................................63 View agents................................................................................................63

Performing Search and Viewing Search Results 65 About searches...........................................................................................66

Perform searches.......................................................................... 66 Optimize search performance.....................................................................67 Optimize search results.............................................................................. 67

Add or remove search filters..........................................................68 View search jobs............................................................................68 Narrow a search by file type.......................................................... 68 Narrow a search by file attribute................................................... 69 Narrow a search by date and time attributes................................. 70 Include content that was not indexed in the search........................71 Narrow a search by backup date.................................................... 71 Narrow a search by backup source or client...................................72

Using keywords to search...........................................................................72 Perform a basic search.................................................................. 72 Perform an advanced search by using a Lucene query...................73 Perform a search on a full content indexed file.............................. 74

Sort search results..................................................................................... 75 View search result metadata.......................................................................75 Batch operations........................................................................................ 75 Download a file from search results............................................................ 76 Restore a file from search results (file system or NDMP files)....................77 Restore a file from search results (virtual machine files)............................ 78 Full content index searches........................................................................ 79

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

Chapter 4

Chapter 5

Chapter 6

CONTENTS

4 Search 18.0 Administration Guide

Troubleshooting 83 Troubleshoot deployment issues.................................................................84 Removing and adding an Avamar source server..........................................85

Remove a source server................................................................ 85 Add an Avamar source server to Search........................................ 85

Log files......................................................................................................86 Copy log files (WinSCP)................................................................ 87 Copy log files (PuTTy) ..................................................................88

Managing logs............................................................................................ 88 Managing logs for API-based services........................................... 89 Managing logs for Worker and Action services...............................91 Managing logs for Elasticsearch.................................................... 93 Managing logs for Nginx................................................................ 94 Manage logs for the Puppet agent................................................ 95

Troubleshooting the web server................................................................. 96 Edit the Search nginx.conf file................................................................... 96 Troubleshooting worker services for indexing issues.................................. 96 Increase the maximum memory for the search-avamar-worker service...... 97 Troubleshooting Elasticsearch....................................................................98

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

Appendix A

CONTENTS

Search 18.0 Administration Guide 5

CONTENTS

6 Search 18.0 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 at https:// support.emc.com.

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

Table 1 Search revision history

Revision Date Changes

01 June 22, 2018 GA release of the Search 18.0 Administration Guide.

Purpose This document describes how to configure and use Search.

Audience This document is intended for an administrator who manages Search.

Related documentation The Search documentation set includes the following publications:

l Search Administration Guide

l Search Security Configuration Guide

l Search Software Compatibility Guide

l Search Release Notes

Special notice conventions that are used in this document The following conventions are used for special notices:

NOTICE

Identifies content that warns of potential business or data loss.

Note

Contains information that is incidental, but not essential, to the topic.

Typographical conventions The following type style conventions are used in this document:

Preface 7

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

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://support.emc.com

l https://community.emc.com

Where to get support The Support website at https://support.emc.com provides access to licensing information, product documentation, advisories, and downloads, as well as how-to and troubleshooting information. This information may enable you to resolve a product issue before you contact Support.

To access a product specific Support page:

1. Go to https://support.emc.com/products.

2. In the Find a Product by Name box, type a product name, and then select the product from the list that appears.

3. Click .

4. (Optional) To add the product to My Saved Products, in the product specific page, click Add to My Saved Products.

Knowledgebase The Knowledgebase contains applicable solutions that you can search for by solution number, for example, 123456, or by keyword.

To search the Knowledgebase:

Preface

8 Search 18.0 Administration Guide

1. Go to https://support.emc.com.

2. Click Advanced Search. The screen refreshes and filter options appear.

3. In the Search Support or Find Service Request by Number box, type a solution number or keywords.

4. (Optional) To limit the search to specific products, type a product name in the Scope by product box, and then select the product from the list that appears.

5. In the Scope by resource list box, select Knowledgebase. The Knowledgebase Advanced Search panel appears.

6. (Optional) Specify other filters or advanced options.

7. Click .

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

1. Go to https://support.emc.com.

2. Click Chat with Support.

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

1. Go to https://support.emc.com.

2. Click Create a Service Request.

Note

To create a service request, you must have a valid support agreement. Contact a sales representative for details about obtaining a valid support agreement or with questions about an account. If you know the service request number, then directly enter the service request number in the Service Request field to get the valid details.

To review an open service request:

1. Go to https://support.emc.com.

2. Click Manage service requests.

Online communities Go to the Community Network at https://community.emc.com for peer contacts, conversations, and content on product support and solutions. Interactively engage online with customers, partners, and certified professionals for all products.

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

9

Preface

10 Search 18.0 Administration Guide

CHAPTER 1

About Search

This section includes the following topics:

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

About Search 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.

About Search

12 Search 18.0 Administration Guide

Table 3 Search components (continued)

Component Description

CIS also provides a security layer above Elasticsearch to prevent unauthorized access.

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.

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 two main Administration window views:

About Search

About the user interface 13

l System Administration view

l Avamar 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.

Note

The default Admin user can assume the following roles:

l System Administrator

l Avamar Application Administrator

l Avamar 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.

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.

You can access the Search UI from the IDPA ACM dashboard, the IDPA System Manager UI, or directly in a web browser.

To access Search through the IDPA ACM dashboard, click Search.

To access Search through the IDPA System Manager UI, click Search and Recovery in the left pane.

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

About Search

14 Search 18.0 Administration Guide

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.

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.

About Search

Administration windows 15

Figure 2 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

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)

About Search

16 Search 18.0 Administration Guide

Table 4 Avamar Administration window features (continued)

Icon Description

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.

Figure 3 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.

About Search

Administration windows 17

Table 5 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

Monitor Search nodes

Add, update, or remove the System Administrator role.

Search window The Search software performs metadata searches on indexed files, 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.

About Search

18 Search 18.0 Administration Guide

Figure 4 Search window

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.

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.

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:

About Search

Search window 19

a. Type the username and password.

Note

The default username is Admin.

b. Click Sign In.

The Search window opens.

About Search

20 Search 18.0 Administration Guide

CHAPTER 2

Getting Started

This section includes the following topics:

l Configuring a backup source.............................................................................. 22 l Manage indexes................................................................................................. 27 l Managing notifications........................................................................................31 l Replicate data indexes....................................................................................... 33 l Set search timeout options................................................................................ 34 l Optimize search performance............................................................................ 35 l Configuring Full Content Indexing (FCI).............................................................35

Getting Started 21

Configuring a backup source Follow the procedures in this section to configure a backup source. When you configure 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

Preconfigured Avamar source server During IDPA deployment, the Search virtual appliance adds an Avamar source server. Adding additional Avamar source servers is not supported.

Default Avamar server limit Search can index multiple Avamar servers simultaneously. Search registers multiple Avamar File System clients on each Search node. Each client is configured to use a different Transmission Control Protocol (TCP) port to communicate with the server, beginning at 28002.

By default, for Avamar 7.1 and later, the Avamar server only exposes ports through the firewall ranging from 28002 to 28011. Once a port above 28011 is used, the server is unable to connect to the client.

Note

If more than 10 Avamar servers are configured in Search, the server is unable to connect to the client. Removing and re-adding a server does not work.

Adding an Avamar server to Search succeeds. However, full content indexing or download operations do not complete. Browsing Search nodes in the Avamar Administration window result in a browse timeout. Client details display a page port of 28012 or higher.

To workaround this issue, increase the port range for additional servers. On the Avamar server, edit the /etc/firewall.default file, and then modify the exec_rule -A OUTPUT -p tcp -dport 28001:28011 -j ACCEPT line to include a wider range. For example:

exec_rule -A OUTPUT -p tcp -dport 28001:28200 -j ACCEPT

Note

After a port range is expanded on the Avamar server, existing Search operations may not complete. If the operation does not complete, cancel and then re-run the operation.

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

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

Getting Started

22 Search 18.0 Administration Guide

Procedure

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

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 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.

Getting Started

Update an Avamar source server 23

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.

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 6 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.

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.

Getting Started

24 Search 18.0 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.

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.

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 A collection (indexing) 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. 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.

Getting Started

Set the blackout window for indexing 25

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

l One or more clients were added to the Avamar 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 You can force reindexing of a source server, or a single zone (Avamar domain). 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 skips reconciliation 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:

a. Select the Avamar domain and 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.

Getting Started

26 Search 18.0 Administration Guide

View the status and summary of the source 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.

2. Click Administration > Sources.

The Sources window appears.

3. Select the source.

4. Click .

Select 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.

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 to index.

Note

When you remove an Avamar domain, 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 that you select for indexing.

You can index additional domains by editing a configured source, and then selecting those domains. When you select a domain, index and collection jobs start. When you remove a domain 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.

Getting Started

View the status and summary of the source 27

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.

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.

Getting Started

28 Search 18.0 Administration Guide

Note

Search does not support other types of VMware images. For more information, see the Search Software Compatibility Guide.

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.

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 Avamar.

The Avamar 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.

Getting Started

Restrict index access 29

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

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

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.

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 Avamar.

The Avamar Administration view appears.

2. Click Administration > Indexes.

For each index, the following information displays:

l Name and description of the index

l Size of the index

Getting Started

30 Search 18.0 Administration Guide

l Number of items in the index

l Date and time the index was created

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 25.

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 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.

Getting Started

Updating an index 31

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.

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.

Getting Started

32 Search 18.0 Administration Guide

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

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)

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.

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.

Procedure

1. Click Administration > Options > Index options.

Getting Started

Configure email notifications 33

The Search Options window appears.

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

3. Click Save.

Set search timeout options 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.

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 5 Visual filter graphs examples

Getting Started

34 Search 18.0 Administration Guide

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 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 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 PDFs 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.

Getting Started

Optimize search performance 35

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.

Table 7 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) 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.

Getting Started

36 Search 18.0 Administration Guide

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 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

Getting Started

Restrict the index size that is returned from Full Content Indexing (FCI) 37

Getting Started

38 Search 18.0 Administration Guide

CHAPTER 3

Managing Roles and Users

This section includes the following topics:

l Configure external OpenLDAP and Active Directory servers..............................40 l About roles.........................................................................................................42 l Managing roles...................................................................................................49

Managing Roles and Users 39

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.

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

Managing Roles and Users

40 Search 18.0 Administration Guide

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.

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 Common name

n Email address

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.

Managing Roles and Users

Configure external OpenLDAP and Active Directory servers 41

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.

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

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.

Managing Roles and Users

42 Search 18.0 Administration Guide

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 1 Search for all users

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

Only an Application Administrator can assign the Application Administrator role.

Procedure

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

The Avamar Administration view appears.

2. Select Administration > Roles.

The Manage Roles window appears.

3. To add a user or group, click .

Managing Roles and Users

Application Administrator role 43

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 Application Administrator to assign the role to the user or group that you added.

Example 2 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

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

Managing Roles and Users

44 Search 18.0 Administration Guide

Procedure

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

The Avamar 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.

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 3 Search for all users

To search for all users that contain Admin:

1. Type Admin.

2. Click Find.

Managing Roles and Users

Full Access Search (Global) role 45

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

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

Figure 6 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 Avamar.

The Avamar 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.

Managing Roles and Users

46 Search 18.0 Administration Guide

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.

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 4 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 original or alternate location

Managing Roles and Users

Index specific search roles 47

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

Figure 7 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 Avamar.

The Avamar 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

48 Search 18.0 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

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

Assign roles to users or groups 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 either Avamar or System.

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

Managing Roles and Users

Managing roles 49

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 either Avamar or System.

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.

Results

The users or groups are no longer listed.

Managing Roles and Users

50 Search 18.0 Administration Guide

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 either Avamar or System.

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 8 Manage Roles window

Managing Roles and Users

Edit role assignments 51

Managing Roles and Users

52 Search 18.0 Administration Guide

CHAPTER 4

Using the Dashboard

This section includes the following topics:

l View index health............................................................................................... 54 l View source server health.................................................................................. 54 l View collector node health................................................................................. 54 l View index cluster health................................................................................... 54 l View system notifications.................................................................................. 55 l View application notifications.............................................................................55

Using the Dashboard 53

View index health 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 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 Only an Application Administrator can view the health of the source servers.

Procedure

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

The Avamar 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.

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.

Using the Dashboard

54 Search 18.0 Administration Guide

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 Avamar.

The Avamar 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

View system notifications 55

Using the Dashboard

56 Search 18.0 Administration Guide

CHAPTER 5

Monitoring Jobs, Services, and System Health

This section includes the following topics:

l Jobs................................................................................................................... 58 l Job types and statuses...................................................................................... 58 l Monitor search jobs........................................................................................... 60 l Monitor index jobs.............................................................................................. 61 l Monitor system jobs........................................................................................... 61 l Stop a pending or running job............................................................................ 62 l View health........................................................................................................ 62 l View services..................................................................................................... 63 l View agents....................................................................................................... 63

Monitoring Jobs, Services, and System Health 57

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). 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.

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

The following table describes the job types.

Table 8 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.

Monitoring Jobs, Services, and System Health

58 Search 18.0 Administration Guide

Table 8 Job types (continued)

Job types Description

Note

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

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 9 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.

Monitoring Jobs, Services, and System Health

Job types and statuses 59

Table 9 Task status (continued)

Status Description

Stopped

Indicates a job has stopped.

Timeout

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.

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 .

Monitoring Jobs, Services, and System Health

60 Search 18.0 Administration Guide

Monitor index jobs 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 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.

To view system jobs, use the following procedure.

Procedure

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

The Avamar 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.

Monitoring Jobs, Services, and System Health

Monitor index jobs 61

6. To refresh the list of jobs, click .

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.

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 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 10 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.

Monitoring Jobs, Services, and System Health

62 Search 18.0 Administration Guide

View services 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 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.

Monitoring Jobs, Services, and System Health

View services 63

Note

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

64 Search 18.0 Administration Guide

CHAPTER 6

Performing Search and Viewing Search Results

This section includes the following topics:

l About searches.................................................................................................. 66 l Optimize search performance............................................................................ 67 l Optimize search results......................................................................................67 l Using keywords to search.................................................................................. 72 l Sort search results............................................................................................. 75 l View search result metadata.............................................................................. 75 l Batch operations................................................................................................75 l Download a file from search results....................................................................76 l Restore a file from search results (file system or NDMP files)........................... 77 l Restore a file from search results (virtual machine files)....................................78 l Full content index searches................................................................................79

Performing Search and Viewing Search Results 65

About searches Search performs metadata searches on indexed files, 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 9 Search window

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.

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

l Full Access Search (Index)

l Read Only Search (Index)

Performing Search and Viewing Search Results

66 Search 18.0 Administration Guide

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.

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)

Performing Search and Viewing Search Results

Optimize search performance 67

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)

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.

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 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.

Performing Search and Viewing Search Results

68 Search 18.0 Administration Guide

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 10 File type frequency

Narrow a search by file attribute 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.

Performing Search and Viewing Search Results

Narrow a search by file attribute 69

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" 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.

Performing Search and Viewing Search Results

70 Search 18.0 Administration Guide

Date

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 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. Select Backup Date.

3. In the Backup Date field, type a start or end date.

Performing Search and Viewing Search Results

Include content that was not indexed in the search 71

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. Select Source.

3. In the Source drop-down list, select the name of an Avamar server.

4. 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. Select Client.

3. In the Client drop-down list, select an Avamar client.

Using keywords to search To perform a keyword search, use one of the following procedures.

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.

Performing Search and Viewing Search Results

72 Search 18.0 Administration Guide

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 11 Example Lucene syntax

Syntax examples Description

field:value The field contains the value

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

Performing Search and Viewing Search Results

Perform an advanced search by using a Lucene query 73

Table 11 Example Lucene syntax (continued)

Syntax examples Description

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.

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.

Performing Search and Viewing Search Results

74 Search 18.0 Administration Guide

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.

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 To view the metadata of a search result, on the search results page, click Detail for the file.

The following search result information displays:

l Name of the application that stores the data, for example, Avamar

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.

Performing Search and Viewing Search Results

Sort search results 75

Figure 11 Performing batch operations

Download a file from search results 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.

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.

Performing Search and Viewing Search Results

76 Search 18.0 Administration Guide

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

Restore a file from search results (file system or NDMP files) 77

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 28.

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.

Performing Search and Viewing Search Results

78 Search 18.0 Administration Guide

8. For the target virtual machine, specify the admin credentials.

For Original Path restores, the drive letter is also required.

9. Click Restore.

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 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.

Performing Search and Viewing Search Results

Full content index searches 79

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.

Search for files that have not undergone a full content index 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 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 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

80 Search 18.0 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

Search for application-specific metadata 81

Performing Search and Viewing Search Results

82 Search 18.0 Administration Guide

APPENDIX A

Troubleshooting

This section includes the following topics:

l Troubleshoot deployment issues........................................................................ 84 l Removing and adding an Avamar source server................................................. 85 l Log files............................................................................................................. 86 l Managing logs....................................................................................................88 l Troubleshooting the web server.........................................................................96 l Edit the Search nginx.conf file........................................................................... 96 l Troubleshooting worker services for indexing issues..........................................96 l Increase the maximum memory for the search-avamar-worker service..............97 l Troubleshooting Elasticsearch........................................................................... 98

Troubleshooting 83

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

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.

Troubleshooting

84 Search 18.0 Administration Guide

Removing and adding an Avamar source server In rare situations, you might be required to remove the Avamar source server and add it back again.

Remove a source server Procedure

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

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.

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.

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.

Troubleshooting

Removing and adding an Avamar source server 85

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.

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.

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.

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.

Table 12 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

Troubleshooting

86 Search 18.0 Administration Guide

Table 12 Log files (continued)

Logs Description

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-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 13 Services and logs

Logs Description

Elasticsearch Index engine logs

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:

Troubleshooting

Copy log files (WinSCP) 87

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 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

Troubleshooting

88 Search 18.0 Administration Guide

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 14 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

{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.

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",

Troubleshooting

Managing logs for API-based services 89

"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.

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 15 Configuration files

Service Configuration file

Admin API /etc/logrotate.d/search- adminapi.lr

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 }

Troubleshooting

90 Search 18.0 Administration Guide

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 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.

Table 16 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

Avamar-Action- Service

/usr/local/search/etc/log4j2- search-avamar-action.xml

{log_path}/search- avamar-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.

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, locate the following section:

l To modify the log level for the Search Avamar Worker service or Search Worker service, locate the following section:

Troubleshooting

Managing logs for Worker and Action services 91

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

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.

The following table lists the log4j configuration files.

Table 17 Configuration files

Service Configuration file

Avamar action service log4j2-search-avamar-action.xml

Avamar worker service log4j2-search-avamar-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.

Troubleshooting

92 Search 18.0 Administration Guide

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.

Manage the log level The log4j file provides the ability to modify the log level for Elasticsearch.

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:

Troubleshooting

Managing logs for Elasticsearch 93

Table 18 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

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.

Log file location The following table provides a summary of the log files available for Nginx. All the Nginx log files are located in /etc/nginx.

Table 19 Nginx log files

Module Configuration file

Avamar action service nginx.avamar-action.conf

CIS nginx.cis.conf

Nginx nginx.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

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

Troubleshooting

94 Search 18.0 Administration Guide

notifempty compress delaycompress missingok lastaction pid=/var/run/nginx.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 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.

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

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.

Troubleshooting

Manage logs for the Puppet agent 95

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 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:

l nginx.search.conf l nginx.cis.conf l nginx.avamar-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:

Troubleshooting

96 Search 18.0 Administration Guide

l service search-avamar-worker status l service search-avamar-worker stop l service search-avamar-worker start l service search-avamar-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 Avamar Worker log rolls over at 100 MB.

You can modify the settings for the Search Avamar Worker service in the /usr/ local/search/etc/log4j2-search-avamar-worker.xml file. To save the changes, restart the Search Avamar Worker service.

Table 20 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

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.

Troubleshooting

Increase the maximum memory for the search-avamar-worker service 97

Troubleshooting Elasticsearch To troubleshoot the Elasticsearch service, use the following log files, commands, and configuration files.

Control the Elasticsearch service 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.

View or change the Elasticsearch configuration 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

Troubleshooting

98 Search 18.0 Administration Guide

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.

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.

For detailed steps on how to disab

Manualsnet FAQs

If you want to find out how the Data Protection Search Dell works, you can view and download the Dell Data Protection Search 18.0 Data Protection Administration Guide on the Manualsnet website.

Yes, we have the Administration Guide for Dell Data Protection Search 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 Administration Guide should include all the details that are needed to use a Dell Data Protection Search. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Dell Data Protection Search 18.0 Data Protection 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.0 Data Protection 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.0 Data Protection 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.0 Data Protection Administration Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell Data Protection Search 18.0 Data Protection Administration Guide as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.