Dell EMC Isilon Search

Transcription

1 Dell EMC Isilon Search Version 2.0 Installation and Administration Guide REV 02

2 Copyright 2017 Dell Inc. or its subsidiaries. All rights reserved. Published March 2017 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 In North America Dell EMC Isilon Search 2.0 Installation and Administration Guide

3 CONTENTS Preface 7 Chapter 1 About Isilon Search 11 About Isilon Search Product architecture...12 About the user interface Administration windows About Searches...19 Chapter 2 Installing Isilon Search 23 System requirements...24 Configuring DHCP server Configuring Static IPs Deploying the OVA in a single-node environment Deploying the OVA in a multi-node environment...27 Deploying the master node Adding more Isilon Search nodes Logging in to Isilon Search for the first time...30 Chapter 3 Configuring Isilon Search 33 Accessing the Administration window...34 Configuring an Isilon source...35 Creating an SMB share on /ifs Adding an Isilon user account for a dedicated Isilon Search user Adding the source Isilon cluster Selecting an analyzer...38 Managing Protocol Audit Monitoring Indexing files within containers...41 Setting connection limitations Setting the blackout window for indexing...42 Viewing the status and summary of the source Rescanning the source and updating the index...43 Configuring LDAP and AD...44 Managing Indexes...46 Indexing overview...46 Restricting index access Viewing indexes Updating an index Managing notifications Configuring System notifications...49 Configuring Isilon notifications Configuring notifications...51 Configuring container indexing (zip and tar files)...51 Enabling index replication for data indexes Enabling search operations on SmartLink files...53 Setting search timeout options...53 Optimizing search performance...54 Configuring Full Content Indexing Dell EMC Isilon Search 2.0 Installation and Administration Guide 3

4 CONTENTS About Full Content Indexing Amount of Index space used and Full Content Indexing Application-specific metadata Limiting files that are full content indexed Chapter 4 Managing Roles and Users 59 About Roles...60 System Administrator role Application Administrator role Search Administrator role...63 Search User role...64 Index specific search roles...66 Managing roles Adding users or groups Removing users or groups...74 Editing role assignments Configuring LDAP and AD...75 Chapter 5 Using the Dashboard 79 Viewing collector nodes...80 Viewing index cluster...80 Viewing indexes...80 Viewing source servers...80 Viewing system notifications...81 Viewing application notifications Chapter 6 Monitoring Jobs, Services, and System Health 83 Viewing job type and status...84 Monitoring search jobs Monitoring index jobs Monitoring system jobs...87 Viewing system health Viewing system services...88 Chapter 7 Performing Search and Viewing Search Results 91 About Searches Accessing only the Search window...92 Optimizing search performance...93 Using filters to optimize search results...93 Narrowing a search by folder or file Narrowing a search by file type Narrowing a search by file attributes...96 Narrowing a search by date and time attributes Specifying an Isilon cluster Including content that was not indexed in the search Narrowing a search by owner Using keywords to search...98 Sorting search results Viewing the metadata of search results Downloading files from search results Searching for files within containers Managing full content index searches Performing a Full Context Index on containers Dell EMC Isilon Search 2.0 Installation and Administration Guide

5 CONTENTS Performing a full content index on search results Searching for files that have not been full content indexed Restricting a search to only include files that have been full content indexed Searching for application specific metadata Appendix A Troubleshooting 109 Deployment troubleshooting Log files Copying log files by using WinSCP Copying log files by using PuTTy Troubleshooting the web server Configuration files Troubleshooting web services for collector issues Increasing the maximum memory for the search-isilon-worker service Troubleshooting Elasticsearch Controlling the Elasticsearch service Viewing Elasticsearch logs Viewing or changing Elasticsearch configuration Monitoring the health of the Elasticsearch cluster Dell EMC Isilon Search 2.0 Installation and Administration Guide 5

6 CONTENTS 6 Dell EMC Isilon Search 2.0 Installation and Administration Guide

7 Preface As part of an effort to improve its product lines, Dell EMC periodically releases revisions of its software and hardware. Therefore, all versions of the software or hardware in use may not support some functions that are described in this document. The product release notes provide the most up-to-date information about product features. If a product does not function correctly or does not function as described in this document, contact a Dell EMC technical support professional. If a product does not function correctly or does not function as described in this document, contact a Dell EMC technical support professional. This document was accurate at publication time. To ensure that you are using the latest version of this document, go to the Dell EMC Support website at: Revision history This revision history provides a description for each revision of this Administration guide. Table 1 Isilon Search Revision History Revision Date Changes 02 April 28, 2017 Editorial changes. 01 March 30, 2017 Initial release of the Isilon Search Installation and Administration Guide. Purpose This document describes how to install, configure and use Isilon Search. Audience This document is intended for an administrator who manages Isilon Search. Related documentation The Isilon Search documentation set includes the following publications: Isilon Search Installation and Administration Guide Isilon Search User Guide Isilon Search Security Configuration Guide Isilon Search Release s Special notice conventions that are used in this document Dell EMC uses the following conventions for special notices: Preface 7

8 Preface NOTICE Identifies content that warns of potential business or data loss. Contains information that is incidental, but not essential, to the topic. Typographical conventions Dell EMC uses the following type style conventions in this document: Table 2 Style conventions Bold Italic Monospace Used for names of interface elements, such as names of buttons, fields, tab names, and menu paths (what the user specifically selects or clicks) Used for full titles of publications that are referenced in text Used for: System code System output, such as an error message or script Pathnames, file names, prompts, and syntax Commands and options Monospace italic Monospace bold Used for variables Used for user input [ ] Square brackets enclose optional values Vertical bar indicates alternate selections - the bar means or { } Braces enclose content that the user must specify, such as x or y or z... Ellipses indicate non-essential information that is omitted from the example Where to get help Dell EMC support, product, and licensing information can be obtained as follows: Product information For documentation, release notes, software updates, or information about Dell EMC products, go to the Dell EMC Support website at: Technical support Go to the Dell EMC Support website, and then click Service Center. Several options for contacting Dell EMC Technical Support appear on the site. To open a service request, you must have a valid support agreement. Contact a Dell EMC sales representative for details about obtaining a valid support agreement or with questions about an account. 8 Dell EMC Isilon Search 2.0 Installation and Administration Guide

9 Preface Online communities For peer contacts, conversations, content on product support and solutions, or to interactively engage online with customers, partners, and certified professionals for all Dell EMC products, go to the Dell EMC Community Network at: Comments Suggestions help to improve the accuracy, organization, and overall quality of the user publications. Send opinions of this document to 9

10 Preface 10 Dell EMC Isilon Search 2.0 Installation and Administration Guide

11 CHAPTER 1 About Isilon Search This section includes the following topics: About Isilon Search...12 About the user interface...15 About Isilon Search 11

12 About Isilon Search About Isilon Search Product architecture Isilon Search is a virtual appliance that supports indexing and search across one or more EMC Isilon clusters. With Isilon Search you can perform the following actions: Index and search for files by name, location, size, owner, file type, and date. Index files within containers such as zip and tar files. Perform a targeted full content index (FCI) on search results to view a preview of the content and search for keywords and content inside. Perform advanced search queries including symbols, wildcards, filters, and operators. Preview and download search results. Review the size the selected files or directories. Isilon Search is a pre-installed, Linux-based virtual appliance. The following figures illustrate the architectural components of Isilon Search. Figure 1 Isilon Search architecture The following table describes Isilon Search components. Table 3 Isilon Search components Component Elasticsearch Description A highly scalable, high performance full-text index and search technology with built-in replication, capable of searching billions of objects within seconds. Elasticsearch leverages Apache Lucene for its indexes. 12 Dell EMC Isilon Search 2.0 Installation and Administration Guide

13 About Isilon Search Table 3 Isilon Search components (continued) Component Common Index Service (CIS) Worker Service Apache Tika NGINX web server Isilon Search user interface LDAP Authentication Server Description An abstraction layer above Elasticsearch that provides the ability for multiple applications to share the same Elasticsearch cluster, enabling cross-platform searches. CIS also provides a security layer above Elasticsearch to prevent unauthorized access. A service that handles interactions with Isilon clusters. The Worker Service includes both metadata indexing like scanning and monitoring and search actions like downloading and full content indexing. An open source toolkit to extract full-text content and application-specific metadata from a wide variety of file types. An open source reverse proxy web server that hosts the web-facing components of Isilon Search. The primary interface for administrators to configure Isilon Search and users to search, preview, and download indexed content. Isilon 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. Single-node or multi-node deployment Each Isilon Search virtual appliance contains all the components that are required to provide index and search operations. Additional nodes can be added to form an Isilon Search cluster. Add extra nodes to: Improve the speed of indexing, monitoring, and search queries Store more indexed metadata and full content indexed content Provide replication The following image illustrates an example of a multi-node environment. Product architecture 13

14 About Isilon Search Figure 2 Multi-node environment Replication An Isilon Search cluster can include one or more nodes. Additional nodes improve search performance and provide the option for replication. With the Isilon Application Administrator role, you can enable data index replication. Click Administration > Options > Index Options, and then toggle the Index replica switch to ON. The Index replica option is disabled by default. If there is more than one Isilon Search node, system indexes are replicated automatically. Data indexes are only replicated when enabled. If there are multiple nodes, it is recommended that the Index replica option is not set to 0. If the Index replica option is not set, failover cannot occur. 14 Dell EMC Isilon Search 2.0 Installation and Administration Guide

15 About Isilon Search Data flow The following figure illustrates the flow of data within Isilon Search. Figure 3 Data flow About the user interface The Isilon Search virtual appliance is accessed as a web based interface. Depending on your user privileges, you can perform administration or search tasks. Figure 4 Main Tabs About the user interface 15

16 About Isilon Search Administration windows The Administration windows provide the ability to administer, configure, and customize Isilon Search. There are two main Administration window views: System Administration view Isilon Administration view To select the System Administration view, select Manage > System. To select the Isilon Administration view, select Manage > Isilon. Figure 5 Toggling between the System Administration view and Isilon Administration view Application Administration window Only an Application Administrator can access the Application Administration view. The following figure shows the Isilon Search Application Administrator view. Figure 6 Administration window The following table lists and describes the sections of the Application Administration window. 16 Dell EMC Isilon Search 2.0 Installation and Administration Guide

17 About Isilon Search Table 4 Application Administration icons Icon Description View a summary of the health and status for the various Isilon Search Components. Modify or enable the following: Container Indexing Index Options LDAP Options Notifications Search Options Add, update, or remove source Isilon Clusters. Manage access to individual indexes. Assign the following roles: Search Admin All Access Search Admin Read Only Search User Lists running and completed activities and jobs. Details include type, status, and duration. Add, update, or remove the following roles: Application Administrator Search Administrator Search User Accessing the Administration window The Isilon Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can perform administration or search tasks. To log 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. To perform administration tasks, you must be assigned one or both of the following roles: System Administrator role Application Administrator role Administration windows 17

18 About Isilon Search You must log in to the Isilon Search UI each time it is opened, or after an inactivity time out of 20 minutes or more. The default inactivity timeout is 20 minutes. To perform administration tasks, complete the following steps. 1. In a web browser, type the following: For example: You might be required to acknowledge a browser warning regarding self-signed certificates before continuing. 2. To log in: a. Type the username and password. The default username is Admin. A System Administrator or Application Administrator can assign roles to users. b. Click Sign In. The Administration UI opens. 3. To open the Administration window, click the following button: The Administration window appears and displays the available menu icons. 4. To open the Search window, click the following button: The Search window appears and displays the search options. Search cannot begin until at least one Isilon cluster has been indexed. System Administration window Only a System Administrator can access the System Administration view. The following figure shows the Isilon Search System Administrator view. 18 Dell EMC Isilon Search 2.0 Installation and Administration Guide

19 About Isilon Search Figure 7 System Administration view The following table lists and describes the sections of the System Administration window. Table 5 System Administration icons Icon Description View a summary of the health and status for the Isilon Searchsystem. Modify or enable the following: Search Options LDAP Options Notification Options Monitor Search nodes. Add, update, or remove the System Administrator role. About Searches Isilon Search performs metadata searches on indexed files and folders, and performs full content searches on files that have had their full content indexed. Isilon Search supports keyword and advanced Lucene search queries. Search results include a summary of certain fields for the file, such as file name, location, size, and date. Consider the following: If a file is indexed for metadata, keywords or phrases that are found in the name of the file or path are highlighted. If a file is indexed for full content indexing (FCI), 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. About Searches 19

20 About Isilon Search By default, the search is sorted by Relevance (score), which defines how well the search results match the search criteria. Figure 8 Search window Accessing only the Search window The Isilon Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can perform administration or search tasks. To perform searches, you must be assigned one of the following roles: Search Admin All Access Search Admin Read Only Search User You must log in to the Isilon Search UI each time it is opened, or after an inactivity time out of 20 minutes or more. The default inactivity timeout is 20 minutes. To perform searches, complete the following steps. 1. In a web browser, type the following: You might be required to acknowledge a browser warning regarding self-signed certificates before continuing. 2. To log in: 20 Dell EMC Isilon Search 2.0 Installation and Administration Guide

21 About Isilon Search a. Type the username and password. The default username is Admin. A System Administrator or Application Administrator can assign roles to users. b. Click Sign In. The Search UI opens. About Searches 21

22 About Isilon Search 22 Dell EMC Isilon Search 2.0 Installation and Administration Guide

23 CHAPTER 2 Installing Isilon Search This section includes the following topics: System requirements Configuring DHCP server...25 Configuring Static IPs Deploying the OVA in a single-node environment Deploying the OVA in a multi-node environment Logging in to Isilon Search for the first time Installing Isilon Search 23

24 Installing Isilon Search System requirements Ensure that the following system requirements are met before installing Isilon Search: Browsers The following browsers are supported: Microsoft Internet Explorer 11 The latest version of Google Chrome The latest version of Mozilla Firefox Isilon System OneFS 7.2 or later with latest patches: OneFS through with patch OneFS and later (no patch required) OneFS , with patch OneFS and later (no patch required) OneFS with patch OneFS and later (no patch required) To access these patches, go to the downloads page on the EMC support site. VMware The following VMware requirements: 8 CPU Using fewer than 8 CPUs might decrease index and search performance. 32 GB of RAM VMware vcenter with VMware ESX 5.x or 6.x The virtual machine is preconfigured with three disks with a total of 150G space: Disk 1: 10 GB of system disk space Disk 2: 100 GB of index data space Disk 3: 30 GB of temporary space If required, to support a larger number of metadata files, the size of the index data disk on Disk 2 can be increased. This step must be performed before the virtual machine is first started Index disk size: 100 GB supports approximately 190 million files 250 GB supports approximately 650 million files 500 GB supports approximately 1.3 billion files 1 TB supports approximately 2.5 billion files 2 TB supports approximately 5 billion files 24 Dell EMC Isilon Search 2.0 Installation and Administration Guide

25 Installing Isilon Search Data disk space size requirements are based on the following projected number of metadata records: 100 GB for 190 million files 250 GB for 650 million files 500 GB for 1.3 billion files 1 TB for 2.5 billion files 2 TB for 5 billion files More disk space is required when implementing full content indexing. When expanding the limit of the system, data of temporary drives, the partition limit is 2 TB. Replication At least two Isilon Search nodes are required to leverage Elasticsearch replication. Single node configuration is supported. If replication is enabled, disk requirements are doubled because each record is stored twice, once on two separate nodes. Static network settings or DHCP The Isilon Search environment can use static network settings or DHCP. If static network settings are used, the following information is required: Static IP Netmask Gateway Server Name Configuring DHCP server If you are using a DHCP server, perform the following steps. Configuring Static IPs 1. Set up the DHCP server to dynamically update the DNS for clients that do not request updates. 2. Select the following option: Dynamically update DNS A and PTR records for DHCP clients that do not request updates. For example, clients running Windows NT 4.0 If you are planning a multi-node deployment environment, configure the DNS server with the node names and IPs of all the nodes you plan to deploy. Configuring Static IPs is not required for a single node deployment, but it is recommended. Configuring DHCP server 25

26 Installing Isilon Search Deploying the OVA in a single-node environment Each Isilon Search virtual appliance contains all of the components that are required to provide index and search operations. Additional nodes can be added to form an Isilon Search cluster. Deploy the Isilon Search OVA on a VMware vsphere client. Refer to the VMware documentation for specific information regarding how to deploy an OVA template. 1. Download the OVA package from the Dell EMC Online Support site: 2. Log in to the vsphere client. Ensure that the vsphere client is connected to vcenter, not an ESXi host. Deploy the Isilon Search OVA to vcenter Server, not to bare metal ESXi, or non-vmware solutions. 3. Select a server. 4. Deploy an OVA template: a. Accept the end user license agreement. b. Select the virtual disk format. When selecting the virtual disk format, the Thick Provision Lazy Zeroed option is recommended. The Thick Provision Eager Zeroed option yields the best performance but also take the most time to initialize. Thick provisioning does not fill the drive unless eager zeroed is selected. If thick provisioning is selected, the storage capacity for the entire virtual disk is allocated on the data store at virtual disk create time. With Thin provisioning, the capacity on the data store is allocated to the virtual disk as required, up to the file size of the virtual disk. 5. For the first node in the cluster specify the following network properties: a. In the Zinc Master field, ensure the option True is selected. b. In the Zinc Master Address field, leave the option blank. 6. For the Root Password field, specify the root password to be used for initial login. 7. For the Administrator Password field, specify the administrator password. 8. For the Time server field, specify the Time server. 9. For the Time Zone field, specify the time zone for the Isilon Search node. 10. If using DHCP, in the DHCP mode field, leave the default setting set to True. 11. If using static IPs, configure the following fields: 26 Dell EMC Isilon Search 2.0 Installation and Administration Guide

27 Installing Isilon Search a. For the DHCP mode field, select False. b. For the Network Address field, specify an IP address and a Netmask. c. For the Default Gateway field, specify a network gateway address. d. For the DNS field, specify one or more DNS servers. Configure the DNS server with the node name and IP of the node that you plan to deploy. 12. For the Network IP address field, specify an IPv4 address. (Optional) To support a mixed mode, you can specify an IPv6 address. a. Specify an address and gateway for IPv6 addresses in the following fields: Network IPv6 Address Default IPv6 Gateway If IPv6 is not required, leave these fields blank. b. To resolve the hostname of the appliance to the IP address, use the nslookup command. c. Specify the IPv6 address in the format that appears in the nslookup output. d. If the nslookup output returns the expanded form of the IP address, (2620:0000:0170:0714:6d63:c749:beec:c2e4), do not specify the compressed form of the IP address (2620:0:170:714:6d63:c749:beec:c2e4). 13. In the Ready to Complete window: a. Review the settings. b. Click Finish. 14. Power on the OVA. The first time the OVA is started, it might take several minutes to load. The virtual machine might automatically restart one or more times during the installation process. Deploying the OVA in a multi-node environment Each Isilon Search virtual appliance contains all of the components required to provide index and search operations. Additional nodes can be added to form an Isilon Search cluster. Add extra nodes to: Improve the speed of indexing, monitoring, and search queries Store more indexed metadata and full content indexed content Provide replication Deploying the OVA in a multi-node environment 27

28 Installing Isilon Search Deploying the master node If planning a multi-node deployment environment, configure the DNS server with the node names and IPs of all of the nodes that you plan to deploy. Deploy the Isilon Search OVA on a VMware vsphere client. Refer to the VMware documentation for specific information regarding how to deploy an OVA template. 1. Download the OVA package from the Dell EMC Online Support site: 2. Log in to the vsphere client. Ensure that the vsphere client is connected to vcenter, not an ESXi host. Deploy the Isilon Search OVA to vcenter Server, not to bare metal ESXi, or non-vmware solutions. 3. Select a server. 4. Deploy an OVA template: a. Accept the end user license agreement. b. Select the virtual disk format. When selecting the virtual disk format, the Thick Provision Lazy Zeroed option is recommended. The Thick Provision Eager Zeroed option yields the best performance but also take the most time to initialize. Thick provisioning does not fill the drive unless eager zeroed is selected. If thick provisioning is selected, the storage capacity for the entire virtual disk is allocated on the data store at virtual disk create time. With Thin provisioning, the capacity on the data store is allocated to the virtual disk as required, up to the file size of the virtual disk. 5. For the first node in the cluster specify the following network properties: a. In the Zinc Master field, ensure the option True is selected. b. In the Zinc Master Address field, leave the option blank. 6. For the Root Password field, specify the root password to be used for initial login. 7. For the Administrator Password field, specify the administrator password. 8. For the Time server field, specify the Time server. 9. For the Time Zone field, specify the time zone for the Isilon Search node. 10. If using DHCP, in the DHCP mode field, leave the default setting set to True. 11. If using static IPs, configure the following fields: a. For the DHCP mode field, select False. 28 Dell EMC Isilon Search 2.0 Installation and Administration Guide

29 Installing Isilon Search b. For the Network Address field, specify an IP address and a Netmask. c. For the Default Gateway field, specify a network gateway address. d. For the DNS field, specify one or more DNS servers. Configure the DNS server with the node names and IPs of all the nodes that you plan to deploy. 12. For the Network IP address field, specify an IPv4 address. (Optional) To support a mixed mode, you can specify an IPv6 address. a. Specify an address and gateway for IPv6 addresses in the following fields: Network IPv6 Address Default IPv6 Gateway If IPv6 is not required, leave these fields blank. b. To resolve the hostname of the appliance to the IP address, use the nslookup command. c. Specify the IPv6 address in the format that appears in the nslookup output. d. If the nslookup output returns the expanded form of the IP address, (2620:0000:0170:0714:6d63:c749:beec:c2e4), do not specify the compressed form of the IP address (2620:0:170:714:6d63:c749:beec:c2e4). Adding more Isilon Search nodes Use the following procedure to deploy additional nodes. Before you begin When deploying additional nodes, ensure that the following requirements are met: The deployment of the master node is complete. The DNS/DHCP servers have been configured, as described in previous procedures. 1. In the Zinc Master field, set the checkbox to False. 2. In the Zinc Master Address field: a. Specify the name of the master node that was first deployed. b. Ensure that there is a DNS record for all records including the master node. 3. For the Root Password field, specify the root password to be used for initial login. 4. For the Administrator Password field, specify the administrator password. 5. For the Time server field, specify the Time server. Adding more Isilon Search nodes 29

30 Installing Isilon Search 6. For the Time Zone field, specify the time zone for the Isilon Search node. 7. If using DHCP, in the DHCP mode field, leave the default setting set to True. 8. If using static IPs, configure the following fields: a. For the DHCP mode field, select False. b. For the Network Address field, specify an IP address and a Netmask. c. For the Default Gateway field, specify a network gateway address. d. For the DNS field, specify one or more DNS servers. Configure the DNS server with the node names and IPs of all the nodes that you plan to deploy. 9. For the Network IP address field, specify an IPv4 address. (Optional) To support a mixed mode, you can specify an IPv6 address. a. Specify an address and gateway for IPv6 addresses in the following fields: Network IPv6 Address Default IPv6 Gateway If IPv6 is not required, leave these fields blank. b. To resolve the hostname of the appliance to the IP address, use the nslookup command. c. Specify the IPv6 address in the format that appears in the nslookup output. d. If the nslookup output returns the expanded form of the IP address, (2620:0000:0170:0714:6d63:c749:beec:c2e4), do not specify the compressed form of the IP address (2620:0:170:714:6d63:c749:beec:c2e4). 10. Power on the OVA. Wait for the new node to appear. This process may take up to ten minutes. Logging in to Isilon Search for the first time Before you begin Wait a minimum of 10 minutes after the deployment has finished before attempting to log in. If sufficient time has not elapsed, the web page might not appear, or login tries are rejected. If an OVA installation was performed, ensure that the virtual machine where the OVA file that was deployed is powered on. To ensure that Isilon Search was deployed successfully, perform the following steps. 1. In a web browser, type the following: 30 Dell EMC Isilon Search 2.0 Installation and Administration Guide

31 Installing Isilon Search The Login page appears. You might be required to acknowledge a browser warning regarding self-signed certificates before proceeding. 2. To log in to the UI, type the username and password. Results a. For the Username field, type the following: Admin b. For the Password field, type the root password that was specified when deploying the OVA. After installation, to manage user accounts and roles, you can add one or more additional directory servers. Supported directory server types include the following: Open LDAP Microsoft Active Directory server (AD) Logging in to Isilon Search for the first time 31

32 Installing Isilon Search 32 Dell EMC Isilon Search 2.0 Installation and Administration Guide

33 CHAPTER 3 Configuring Isilon Search This section includes the following topics: Accessing the Administration window Configuring an Isilon source Viewing the status and summary of the source Rescanning the source and updating the index Configuring LDAP and AD Managing Indexes Managing notifications...49 Configuring container indexing (zip and tar files) Enabling index replication for data indexes...52 Enabling search operations on SmartLink files Setting search timeout options Optimizing search performance Configuring Full Content Indexing Configuring Isilon Search 33

34 Configuring Isilon Search Accessing the Administration window The Isilon Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can perform administration or search tasks. To log 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. To perform administration tasks, you must be assigned one or both of the following roles: System Administrator role Application Administrator role You must log in to the Isilon Search UI each time it is opened, or after an inactivity time out of 20 minutes or more. The default inactivity timeout is 20 minutes. To perform administration tasks, complete the following steps. 1. In a web browser, type the following: For example: You might be required to acknowledge a browser warning regarding self-signed certificates before continuing. 2. To log in: a. Type the username and password. The default username is Admin. A System Administrator or Application Administrator can assign roles to users. b. Click Sign In. The Administration UI opens. 3. To open the Administration window, click the following button: The Administration window appears and displays the available menu icons. 34 Dell EMC Isilon Search 2.0 Installation and Administration Guide

35 Configuring Isilon Search 4. To open the Search window, click the following button: The Search window appears and displays the search options. Search cannot begin until at least one Isilon cluster has been indexed. Configuring an Isilon source Creating an SMB share on /ifs Follow the procedures in this section to configure an Isilon source. To download files and access them for full content indexing, create a share on OneFS. 1. Create a share on /ifs. 2. Name the share: For versions of OneFS that support $, name the share zinc$. For versions of OneFS that do not support $, name the share zinc. Use zinc$ unless you are using a version of OneFS that does not support zinc$. Adding an Isilon user account for a dedicated Isilon Search user 1. Configure permissions for Isilon Search: a. Start the OneFS software on the Isilon cluster. b. Create a user with the following privileges: Table 6 User privileges Name Description Access Platform API Auth Log in to Platform API and WebUI Configure identities and authentication sources Read-Only Read-Only Audit Configure audit capabilities Read-Write Configuring an Isilon source 35

36 Configuring Isilon Search Table 6 User privileges (continued) Name Description Access If real time monitoring is not required, set the Audit privilege to Read-Only. CloudPool Configure CloudPools Read-Only Network Configure network interfaces Read-Only SMB Configure SMB server Read-Only Smartpools Configure Smartpools Read-Only Statistics Namespace Traverse Namespace Access View file system performance statistics Traverse and view directory metadata Access /ifs via RESTful Access to Namespace service Read-Only Read-Only Read-Only 2. To download or perform a full content index (FCI) of a file: a. Assign the dedicated Isilon Search user with the following access level: run as root read-only b. Provide the dedicated Isilon Search user with access to one of the following shares: /zinc$ share /zinc share Adding the source Isilon cluster In the Isilon Search Admin UI, identify one or more source Isilon clusters to be indexed. Indexing begins automatically after a source has been added. You can only add an Isilon source cluster with the Application Administrator role. 1. To select the Isilon Administration view, select Manage > Isilon from the top right of the Admin UI. 2. Select Administration > Sources. 3. To add a source, click the following button: The Add Source window appears. 36 Dell EMC Isilon Search 2.0 Installation and Administration Guide

37 Configuring Isilon Search 4. The Platform field is set to Isilon. This field cannot be modified. 5. In the Name field: a. Type a display name to easily identify the Isilon cluster. b. Ensure that the name meets the following requirements: Between 1 to 50 characters in length. No spaces are permitted in the name. The name must be combination of the following English characters, symbols, and numbers: Lowercase characters (a-z) Uppercase characters (A-Z) Numeric characters (0-9) Dash (-) Underscore (_) 6. In the Hostname field, type the fully qualified Smart Connect hostname of the Isilon cluster by using one of the following formats: IP address FQDN 7. In the Port field, leave the default entry unless the Isilon cluster has been configured with a different port. 8. In the User ID field: a. Type the account name of the user that you created for Isilon Search in the previous procedure. This account should have the following permissions: Table 7 User privileges Name Description Access Platform API Auth Log in to Platform API and WebUI Configure identities and authentication sources Read-Only Read-Only Audit Configure audit capabilities Read-Write If real time monitoring is not required, set the Audit privilege to Read-Only. CloudPool Configure CloudPools Read-Only Network Configure network interfaces Read-Only Adding the source Isilon cluster 37

38 Configuring Isilon Search Table 7 User privileges (continued) Name Description Access SMB Configure SMB server Read-Only Smartpools Configure Smartpools Read-Only Statistics Namespace Traverse Namespace Access View file system performance statistics Traverse and view directory metadata Access /ifs via RESTful Access to Namespace service Read-Only Read-Only Read-Only Selecting an analyzer b. Ensure that the account has full access to either of the following shares: /zinc$ share /zinc share 9. In the Password field, type the password for the corresponding user as identified in the User ID field. 10. Continue the configuration steps for selecting an analyzer. The analyzer is the criteria or language that the content is indexed with. Although the default standard analyzers are recommended for the majority of use cases, advanced users can select different analyzers for specific indexes. 1. To select the Isilon Administration view, select Manage > Isilon from the top right of the Admin UI. 2. Select Administration > Sources. The list of Isilon clusters appears. 3. Select the Isilon cluster and click the following button: The Add Source window appears. 4. In the Analyzer field specify the criteria or language that you would like to use: Option Description Standard Default analyzer Simple Includes lowercase words Disregards numeric values Splits text into tokens for non-letter characters 38 Dell EMC Isilon Search 2.0 Installation and Administration Guide

39 Configuring Isilon Search Option Description Whitespace Does not support lowercasing Splits text into tokens for whitespace characters Languages Supports language-specific stop words Supports stemming Managing Protocol Audit Monitoring 5. Continue the configuration steps for adding a source. The Protocol Audit Monitoring feature uses the OneFS software on the Isilon cluster to send events when a change occurs in the file system to Isilon Search through the Common Event Enabler (CEE). To keep the Isilon Search index updated with file system changes, enable the Protocol Audit Monitoring feature. When enabled, Isilon Search automatically configures the Isilon cluster for Protocol Audit Monitoring and CEE forwarding. If required, you can disable the Protocol Audit Monitoring feature and trigger manual rescans to keep the index updated with changes that occur after that initial scan. Consider disabling the Protocol Audit Monitoring feature for the following reasons: CEE forwarding is already configured for another third-party application. The extra load on the Isilon of Protocol Audit Monitoring is not desirable. An updated index is not required after a system change occurs. OneFS Considerations If using the Protocol Audit Monitoring feature on Isilon nodes running the following OneFS versions, consider the following: For Isilon nodes running OneFS versions earlier than 8.0.1, if events are generated at a faster rate than the Isilon cluster can forward, an index backlog might occur. Isilon nodes are limited to sending up to 8 million audit events per day. If more than 8 million events are generated, Isilon Search index rescans are required to update indexes. For Isilon clusters running OneFS versions or later, the Isilon Search system might not be able to process incoming events fast enough. If the Isilon Search system is unable to process the rate of delivered events, incoming queues overload the system and the CEE service drops events. Isilon Search index rescans are required to resynchronize indexes. Protocol Audit Monitoring only tracks changes that occur on the SMB/CIFS and NFS shares. Changes that are made through other methods, such as FTP, HTTP, or by using the local terminal, are not updated in the index. Use the following procedures in the sections that follow to enable or disable Protocol Audit Monitoring. Managing Protocol Audit Monitoring 39

40 Configuring Isilon Search Enabling the Protocol Audit Monitoring feature Select the Protocol Audit Monitoring feature to enable auditing and Common Event Enabler (CEE) forwarding from the Isilon cluster to Isilon Search. To keep Isilon Search indexes updated with file system changes, perform the following steps. 1. To select the Isilon Administration view, select Manage > Isilon from the top right of the Admin UI. 2. Select Administration > Sources. The list of Isilon clusters appears. 3. Select the Isilon cluster and click the following button: The Add Source window appears. 4. For the Protocol Audit Monitoring field, select Enable. Isilon Search performs the following actions: a. Checks to determine if auditing and CEE forwarding have been enabled on the Isilon cluster. b. Adds all Access Zones to the audited Zones list. c. Adds Isilon Search nodes to the list of CEE servers. 5. If existing CEE forwarding servers are detected, perform one of the following actions: To keep the existing CEE URIs and disable protocol audit monitoring: a. Select Keep the CEE forwarding settings. b. Follow the procedure to disable protocol audit monitoring for Isilon Search. To overwrite the existing CEE URIs with the Isilon Search CEE URIs, select Set events forwarding URL to Isilon Search CEE Server. Disabling the Protocol Audit Monitoring feature Overwriting the existing CEE URIs is not recommended. If the settings are overwritten, the current application that it is configured with will not work correctly. 6. Continue the configuration steps for adding a source. Use this procedure to disable automatic index updates when the file system is changed. If auditing is configured for another software program, disable the Protocol Audit Monitoring feature. Disabling protocol audit monitoring decreases the workload on the Isilon cluster because the Isilon cluster does not need to process and forward audit messages from Isilon Search each time the file system is updated. 40 Dell EMC Isilon Search 2.0 Installation and Administration Guide

41 Configuring Isilon Search 1. To select the Isilon Administration view, select Manage > Isilon from the top right of the Admin UI. 2. Select Administration > Sources. The list of Isilon clusters appears. 3. Select the Isilon cluster and click the following button: The Add Source window appears. 4. In the Add Source window, ensure that the Protocol Audit Monitoring field is not enabled. 5. Click Confirm. Indexing files within containers 6. Continue the configuration steps for adding a source. When enabled, the Indexing files within containers feature indexes the metadata of all the files (.zip,.tar,.gz,.tgz) and folders inside a container. By default, this feature is disabled when adding a source. This feature is separate from the initial scan, because it implements lazy indexing where containers are processed in the background after a scan completes. 1. To select the Isilon Administration view, select Manage > Isilon from the top right of the Admin UI. 2. Select Administration > Sources. The list of Isilon clusters appears. 3. Select the Isilon cluster and click the following button: Setting connection limitations The Add Source window appears. 4. In the Files Within Containers field, click Enable. 5. Continue the configuration steps for adding a source. Use the following procedure to restrict the number of connections that are made across all Isilon Search nodes. 1. To select the Isilon Administration view, select Manage > Isilon from the top right of the Admin UI. 2. Select Administration > Sources. The list of Isilon clusters appears. 3. Select the Isilon cluster and click the following button: Indexing files within containers 41

42 Configuring Isilon Search The Add Source window appears. 4. In the Connection Limitation field, click Enable. The Connection Limitation is disabled by default. 5. In the Indexing field, type a numeric value for the number of concurrent search operation connections, which include download or full content indexing (FCI), that are allowed to the Isilon cluster. 6. In the Action field, type a numeric value for the number of search actions that are allowed to the Isilon cluster. 7. Continue the configuration steps for adding a source. Setting the blackout window for indexing Use the following procedure to restrict indexing during a certain time period by setting a blackout window. Enabling this option prevents Isilon Search from interacting with the Isilon cluster 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. 1. To select the Isilon Administration view, select Manage > Isilon from the top right of the Admin UI. 2. Selecting Administration > Sources. The list of Isilon clusters appears. 3. Select the Isilon cluster and click the following button: The Add Source window appears. 4. In the Blackout Window field, click Enable. 5. Specify the time range. If the Only apply to full-content indexing box is selected, operations that collect metadata which include scan and rescan, can run at any time, including the blackout window. Only full content indexing is restricted during this blackout window. 6. Click Connect. The Isilon cluster is now available in the list of servers in Sources window. When a server is added, a system job is added to register the Isilon node and indexing begins. 42 Dell EMC Isilon Search 2.0 Installation and Administration Guide

43 Configuring Isilon Search Viewing the status and summary of the source View the configuration details of the source Isilon cluster. You can only view a summary of the Source from the Application Administrator role. 1. In the Administration window, select Manage > Isilon. The Isilon Administrator view appears. 2. Select Administration > Sources. The Sources window appears. 3. Select the source. 4. Click the Details button: A summary of the source details appears. For Isilon clusters with OneFS 8.0 or later, the summary includes an estimate of the number of files on the cluster and the time remaining to complete the scan. The number of displayed files includes snapshots and other file types that are not scanned by Isilon Search, which results in a higher than accurate file count. Rescanning the source and updating the index You might need to rescan the source and update the indexes in the following scenarios: The Protocol Audit Monitoring feature has been disabled, and you want to update the index with the latest changes. You have restored from a disaster recovery event and must update the index from the point that the index was last snapshot. If changes were made on the Isilon through FTP or HTTP, because the Common Event Enabler (CEE) monitoring code does not catch those changes. If monitoring the system is interrupted. If monitoring the system is disabled. You can only rescan a source from the Application Administrator role. You cannot rescan a source while another scan is in progress. 1. Select Administration > Sources. The Sources window appears. 2. Select the source. 3. Click the Details button: 4. Go to the Scan Summary section. Viewing the status and summary of the source 43

44 Configuring Isilon Search 5. Select Trigger scan jobs. 6. Select one of the options for the duration of time: Hours Days Weeks Months 7. In the Rescan all file/folder changes in the last field, specify a timeframe. The timeframe refers to a period during which data was added to, removed from, or changed on the OneFS file system. The timeframe does not refer to the last modified date. 8. Click Trigger. Configuring LDAP and AD Isilon Search comes with a built-in OpenLDAP service with preconfigured accounts. For example, the Admin user. The default Admin user is not configured with an address and cannot receive notifications. With the System Administrator role, you can add additional LDAP or AD services to define additional users who can administer Isilon Search and perform search operations. Isilon Search does not authenticate the user against the LDAP authority. The Authentication Service uses the UUID of either the user or the group that the user belongs to is used in the external authority. When authentication succeeds, the Authentication Service issues a token for the user. The GUI uses the token information to ensure that the user can perform only the activities that the user has privileges to perform. You can only configure LDAP and AD users with the Application Administrator role. 1. In the Administration window, select Manage > System. The System Administrator view appears. 2. Select Administration > Options > LDAP Options. The LDAP Options window appears. 3. To add an LDAP server, click the following button: 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: Active Directory OpenLDAP 44 Dell EMC Isilon Search 2.0 Installation and Administration Guide

45 Configuring Isilon Search 6. In the LDAP Server field, type either of the following: Hostname of the LDAP or AD server IP address of the LDAP or AD server 7. In the LDAP port field, type the port number that is used by the external authentication authority. For LDAP, the default port number is 389. For SSL, the default number for LDAPS changes to 636 when True is selected. 8. In the Base DN field, type the scope of the users and groups that are considered within the LDAP server. For example: DC=example, DC=com The Base DN determines the structure of the LDAP server where the search filter is applied. This 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 b. For Active Directory, ensure that the username is one of the following: Common name address Display name User principle name (UPN) Same account name Distinguished name (DN) c. For OpenLDAP, ensure that the username is one of the following: Common name address Entry distinguished name d. Ensure that the user has read access to the directory. e. To include notification, define the address for the account. Only admin accounts with defined addresses can receive notifications. The default admin user is not configured with an address and cannot receive notifications. 10. In the Password field, type the password of the user account that you specified in the Username field. Configuring LDAP and AD 45

46 Configuring Isilon Search Managing Indexes 11. In the SSL field, select either of the following options: To connect to an external authentication server using LDAPS, select True. The default port number automatically changes to 636. To not apply secure connection settings, select False. 12. In the Default field, leave the option set to False. Default refers to the Isilon Search built-in OpenLDAP server. 13. To test the connection, click Test Connection. 14. Click Save. After a source is added, indexing begins automatically. This section describes how to rename an index, restrict access to an index, and view an index. Indexing overview Indexing extracts metadata and content from files and stores them in indexes. You can specify the user and groups that can access them. An index may be one of the following types: Metadata-only indexing allows for the search of basic file attributes which include the following: File name File type Path Size Date last modified Date created Date last accessed Owner or Group ID Access Mode Metadata-only indexing does not index the content of the files. Full content indexing allows for the search of any text inside a file, in addition to basic file attributes. Restricting index access Restrict index access to limit the users of 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. 1. In the Administration window, select Manage > Isilon. The Isilon Administrator view appears. 2. Ensure that the user or group has been added as an Active Directory or OpenLDAP source. 46 Dell EMC Isilon Search 2.0 Installation and Administration Guide

47 Configuring Isilon Search 3. Select Administration > Indexes. The list of indexes appears. 4. Select the Index that you would like to give the user or group access to. 5. To manage search roles, click the following button: The Manage Search Roles window appears. 6. Click the add button: The Select User window appears. 7. In the Select User window, perform the following steps: a. In the Name field, restrict the search to one of the following categories: Users or Groups Users Groups b. Type the name of the user or group. c. In the Directory field, select one of the configured LDAP servers. d. Click Find. The list of user or user groups appears. 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 click Find. 8. Select a user or group, or select Select all, and then click OK. The Manage Search Roles window appears. 9. To assign roles to a user or group, select one of the following options: Option Search Admin All access Search Admin Read only Description No restrictions Cannot see inline preview for hits Cannot view full preview for hits Cannot download files locally Search User A specified user can only see the files that they own and have access rights to through a configured CIFS/SMB share. Restricting index access 47

48 Configuring Isilon Search Option Description A specified user can perform all actions on the files that they own Viewing indexes Indexes hold the indexed metadata and content extracted from the Isilon cluster. There is one index created for each Isilon cluster. You can specify the users and groups that have access to the index. You can only view Indexes with the Application Administrator role. 1. In the Administration window, select Manage > Isilon. The Isilon Administrator view appears. 2. Select Administration > Indexes. The Index window appears. For each index, the following information is displayed: The name and description of the index The size of the index The number of items in the index The date and time the index was created The analyzer that is used The current scan status The date of the last completed scan Updating an index You might need to rescan the source and update the indexes in the following scenarios: The Protocol Audit Monitoring feature has been disabled, and you want to update the index with the latest changes. You have restored from a disaster recovery event and must update the index from the point that the index was last snapshot. If changes were made on the Isilon through FTP or HTTP, because the Common Event Enabler (CEE) monitoring code does not catch those changes. If monitoring the system is interrupted. If monitoring the system is disabled. You can only rescan a source from the Application Administrator role. You cannot rescan a source while another scan is in progress. 1. Select Administration > Sources. The Sources window appears. 48 Dell EMC Isilon Search 2.0 Installation and Administration Guide

49 Configuring Isilon Search 2. Select the source. 3. Click the Details button: 4. Go to the Scan Summary section. 5. Select Trigger scan jobs. 6. Select one of the options for the duration of time: Hours Days Weeks Months 7. In the Rescan all file/folder changes in the last field, specify a timeframe. The timeframe refers to a period during which data was added to, removed from, or changed on the OneFS file system. The timeframe does not refer to the last modified date. 8. Click Trigger. Managing notifications Configuring System notifications Notifications alert you to activities, issues, and events within the Isilon Search system and Isilon cluster. This section describes how to configure system, Isilon cluster, and notifications. System notifications provide information on issues with the system at the cluster, node, index, and service levels. You can only configure and view System notifications with the System Administrator role. 1. In the Administration window, select Manage > System. The System Administrator view appears. 2. Select 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: Cluster Node Managing notifications 49

50 Configuring Isilon Search Index Service 5. Select the preferred language. 6. To configure notifications, click to toggle the switch to ON. notifications are disabled (OFF) by default. 7. Configure the following fields: Host (IP of the SMTP host) Port (Set a port, typically 25 or 587) User (An account authorized to connect to the SMTP service) Password 8. Click Save. Results Configuring Isilon notifications Notifications take effect 15 minutes after this setting is enabled. Isilon notifications alert you to index events, issues with the Isilon source cluster, and the status of search action events. You can only configure and view Isilon notifications with the Isilon Administrator role. 1. In the Administration window, select Manage > Isilon. The Isilon Administrator view appears. 2. Select 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: Index Source Job 5. Select one or more of the following job types that you would like to receive notifications for: Scan Monitor Rescan FCI (full content indexing) Download 6. Select the preferred language. 7. To configure notifications, click to toggle the switch to ON. notifications are disabled (OFF) by default. 50 Dell EMC Isilon Search 2.0 Installation and Administration Guide

51 Configuring Isilon Search 8. Configure the following fields: Host (IP of the SMTP host) Port (Set a port, typically 25 or 587) User (An account authorized to connect to the SMTP service) Password 9. Click Save. Results Configuring notifications Notifications take effect 15 minutes after this setting is enabled. You can configure Isilon Search to send notifications to specified SMTP users and hosts. The default admin user is not configured with an address and cannot receive notifications. 1. Select Administration > Options > Notification Options. The Notification Options window appears. 2. Click to toggle the switch to ON. notifications are disabled (OFF) by default. 3. Configure the following fields: Host (IP of the SMTP host) Port (Set a port, typically 25 or 587) User (An account authorized to connect to the SMTP service) Password 4. Click Save. Results Notifications take effect 15 minutes after this setting is enabled. Configuring container indexing (zip and tar files) When enabled, the Indexing files within containers feature indexes the metadata of all the files (.zip,.tar,.gz,.tgz) and folders inside a container. By default, this feature is disabled when adding a source. This feature is separate from the initial scan, because it implements lazy indexing where containers are processed in the background after a scan completes. You can only configure container indexing with the Application Administrator role. 1. Ensure that the Files Within Containers option was enabled for the source Isilon cluster. Configuring notifications 51

52 Configuring Isilon Search 2. Select Administration > Options > Container indexing. The Container Indexing Options window appears. 3. In the Maximum container size to download for metadata indexing field, specify the maximum file size. 4. In the Maximum depth of embedded container to index field, specify the number of levels of zip files that should be indexed. For example, a.tar file within a.zip file within a.gz file equals two levels. 5. To determine the container types that are indexed, review the Supported Containers field: Supported containers include:.zip.tar.gz.tgz 6. Click Save. Enabling index replication for data indexes If you have more than one Isilon Search node, you can enable replicas. Index replication keeps a redundant copy of index data that is spread over available nodes for high availability. If one node fails, the indexes are still available. However, if the Master node is down, the system will not work correctly. Replication requires the deployment of at least two indexing nodes. If more than one Isilon Search node is configured, system indexes are automatically replicated. Each index is divided into shards. The shards are distributed over the available index nodes. If the index replica feature has been 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 required administrator interaction. System data is automatically replicated when there is more than one Isilon Search node configured. However, replication for data indexes is disabled by default. Enabling replication for data indexes doubles the amount of data and therefore the amount of space used. 1. Select Administration > Options > Index options. The Search Options window appears. 2. Click to toggle the Index replica switch to ON. 3. Click Save. 52 Dell EMC Isilon Search 2.0 Installation and Administration Guide

53 Configuring Isilon Search Enabling search operations on SmartLink files Isilon Search supports the ability to move file data to the cloud. When a file is moved off the Isilon cluster, a stub file that acts as a pointer to the file's new location is left behind. This stub file is called a SmartLink file. Support for stub files is disabled by default. If the Support actions for stubbed files option is enabled, Isilon Search triggers the Isilon cluster to retrieve the file that is linked to the SmartLink file from the remote location. A search user can download, preview, or perform a full content index on the file. To prevent unwanted recalls of data from cloud storage, Isilon Search skips stubbed files for the following operations: Download Full content index (FCI) 1. In the Administration window, select Manage > Isilon. The Isilon Administrator view appears. 2. Select Administration > Options > Search Options. The Search Options window appears. Setting search timeout options 3. To enable search actions on stub files, select Yes in the Support actions for stubbed files field. The search timeout option sets a limit on the duration of a search operation. Only the System Administrator role can set search timeout options. 1. In the Administration window, select Manage > System. The System Administration view appears. 2. Select Administration > Options > Search Options. The Search Options window appears. 3. To set a limit on the duration of a search operation, specify a time in seconds in the Search timeout field. If a search operation is not completed in the time that is specified, a warning message is displayed indicating that results are incomplete. 4. To set a limit on the time it takes to build a visual filter graph from the search results, specify a time in seconds in the Aggregation search timeout field. Consider the following: Visual filter graphs require that matching items from the current search are aggregated. If a visual filter is not completed in the time that is specified, the current results display with a warning message indicating that the results are incomplete. Enabling search operations on SmartLink files 53

54 Configuring Isilon Search Figure 9 Visual filter graphs examples Optimizing search performance At the core of Isilon Search is Elasticsearch, a high performance indexing and search system capable of searching billions of objects within seconds. To leverage Elasticsearch replication at least two nodes are required, although a single node is supported. To further increase the speed at which search results are returned, observe the following best practices: Use search filters to narrow the search scope, and limit the number of results. Only add specific queries if you know the details of the content that you are looking for. For example, specify the file type, date, and owner using the search filters instead of typing them directly into the Search bar. Limit the number of simultaneous queries by different users. Configuring Full Content Indexing About Full Content Indexing The sections that follow describe the Full Content Indexing (FCI) feature and how to configure FCI options. Isilon Search performs metadata searches on indexed files and folders, and performs full content searches on files that have had their full content indexed. Isilon Search supports keyword and advanced Lucene search queries. Search results include a summary of certain fields for the file, such as file name, path, size, date, and ownership. By default, the search is sorted by Relevance (score), which defines how well the search results match the search criteria. Consider the following: 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. 54 Dell EMC Isilon Search 2.0 Installation and Administration Guide

55 Configuring Isilon Search 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. FCI Use cases If two billion files have been indexed with Isilon Search, you might want to only full content index two million of those files. File types that you might want to full content index include Microsoft Office documents, PDF, and text files. If you do not recall the name of a particular file, you can use FCI 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 take up significantly more space in the index, depending on the type and size of the files that are processed. Updated content When a file is full content indexed, the state of the file is classified as sticky. If any changes are made to the file, its full content is updated in the index. However, since files might be edited many times in a typical day, the process to index the new content only runs once each day. A lag might exist in the updates that reach the index. Consider the following: Some applications do not modify existing files when edits are made. These applications, like Microsoft Office, create files, rename the old versions, and then delete them. In these cases, since the file is new, it is not automatically full content indexed. A new FCI job can be applied to files at any time. Any files that are already full content indexed are skipped. Amount of Index space used and Full Content Indexing The metadata for each indexed object typically takes up a few hundred bytes, with any variation depending mostly on the path length. By contract, the size that is used by full content indexing can vary widely depending on the amount of text in the file. The amount of index space that is used by the full content indexing (FCI) feature differs depending on the file type. Table 8 File Type Index Space for FCI File Type Video file Index Size Requirements A 20 GB video file might only take up 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 PDF The amount of index space that is used is usually smaller than the file size because pictures and other formatting are removed. The amount of index space that is used is usually smaller than the file size because pictures and other formatting are removed. The amount of index space that is used is usually smaller than the file size because pictures and other formatting are removed. Amount of Index space used and Full Content Indexing 55

56 Configuring Isilon Search Application-specific metadata To manage low disk space, add additional nodes that have the same disk space with existing node. For example, an Isilon Search cluster already has three nodes with each node containing a 500 GB disk, add one or more nodes with a 500 GB disk to the cluster. 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. Examples of application-specific metadata include the following: Author Title Title and artist for audio files Word-count for Microsoft Office files Camera name Resolution for image files Limiting files that are full content indexed Set limits to further increase the speed of full content indexing and limit the size of the index. 1. Select Administration > Options > Full Content Indexing. The Full Content Indexing Options window appears. 2. To set a limit on the maximum file size within the index, in the Maximum item size to full content index field, specify the maximum file size. Files over the maximum item size are skipped during full content indexing. 3. To display preview text in the search results, in the Include preview text during FCI field, select Yes. Disabling this 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 file full content indexed is stored in the index. You can display the preview text without reaching back out to the Isilon cluster. 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. Any additional text over the maximum preview size is truncated. 5. To process all files, select Processes all files. 56 Dell EMC Isilon Search 2.0 Installation and Administration Guide

57 Configuring Isilon Search 6. To exclude certain file types: a. Select Processes all files. b. Select Exclude the types below. The following file types are excluded:.jar.log.json.exe.dll.obj 7. To include only certain file types, select Include only the types below. The following file types are included:.docx,.doc.xlsx,.xls.txt.pdf.html Limiting files that are full content indexed 57

58 Configuring Isilon Search 58 Dell EMC Isilon Search 2.0 Installation and Administration Guide

59 CHAPTER 4 Managing Roles and Users This section includes the following topics: About Roles Managing roles...72 Configuring LDAP and AD Managing Roles and Users 59

60 Managing Roles and Users About Roles A role is a set of privileges that are defined by the role. When you configure the Isilon virtual appliance, there are already predefined users from an OpenDLAP. System Administrator role Only a System Administrator can assign another System Administrator role. The System Administrator can: Assign the System Administrator role to other users and groups View the system health Configure and view system notifications Manage LDAP sources Assigning the System Administrator role Only a System Administrator can add another System Administrator role. 1. In the Administration window, select Manage > System. The System view appears. 2. Select Administration > Roles. The Manage Application Admins window appears. 3. Click the following button: 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: Users or Groups Users Groups b. Type the name of the user or group. c. In the Directory field, select one of the configured LDAP servers. For example, the following options might appear: Default OpenLDAP server 3 AD directories 2 OpenLDAP directories d. Click Find. The list of user or user groups appears. 60 Dell EMC Isilon Search 2.0 Installation and Administration Guide

61 Managing Roles and Users If you click Find before specifying a substring, the entire directory is returned. This action might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. Application Administrator role 5. Select a user, group, or click Select all. The Manage Application Admins window appears. 6. To assign the role to the user or group that has been added, select System Administrator. The Application Administrator can manage Isilon specific configurations. Only an Application Administrator can assign another Application Administrator role. The Application Administrator can perform the following tasks: Assign the following roles to users and groups: Application Administrator Search Administrator Search User View the status of jobs on the Isilon cluster Manage search roles for an index including the following: Search Admin All Access Search Admin Read Only Search User Add or edit a source Isilon cluster Manage LDAP sources Configure and view Isilon cluster notifications View the health of the Isilon cluster Application Administrator role 61

62 Managing Roles and Users Figure 10 Manage Application Admins Assigning the Application Administrator role Only an Application Administrator can assign the Application Administrator role. 1. In the Administration window, select Manage > Isilon. The Isilon Administration view appears. 2. Select Administration > Roles. The Manage Application Admins window appears. 3. To add a user or group, click the following button: 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: Users or Groups Users 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. 62 Dell EMC Isilon Search 2.0 Installation and Administration Guide

63 Managing Roles and Users If you click Find before specifying a substring, the entire directory is returned. This action might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. Search Administrator role 5. Select a user, group, or select Select all. The Manage Application Admins window appears. 6. To assign a role, select Application Administrator. The Search Administrator is a global search administrator that overrides any setting on indexes. Only an Application Administrator can assign the Search Administrator role. The Search Administrator can perform the following actions: Perform a full content index of a search result Preview search results Download files locally Assigning the Search Administrator role Only an Application Administrator can assign the Search Administrator role. 1. In the Administration window, select Manage > Isilon. The Isilon Administration view appears. 2. Select Administration > Roles. The Manage Application Admins window appears. 3. To add a user or group, click the following button: 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: Users or Groups Users 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. Search Administrator role 63

64 Managing Roles and Users d. Click Find. The list of user or user groups appears. If you click Find before specifying a substring, the entire directory is returned. This action might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. 5. Select a user or group or select Select all. The Manage Application Admins window appears. 6. To assign a role, select the Search Administrator checkbox. Search User role The Search User is a global search user that overrides any settings on indexes. Only an Application Administrator can assign the Search User role. A Search User can only see the files that they own and have access rights to through a configured CIFS/SMB share. Figure 11 Manage Search Roles A Search user can perform the following actions only on files that they own: Perform a full content index of a search result Preview search results Download files locally 64 Dell EMC Isilon Search 2.0 Installation and Administration Guide

65 Managing Roles and Users Figure 12 Search User View Assigning the Search User role Only an Application Administrator can assign the Search User role. 1. In the Administration window, select Manage > Isilon. The Isilon Administration view appears. 2. Select Administration > Roles. The Manage Application Admins window appears. 3. To add a user or group, click the following button: 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: Users or Groups Users Groups b. Type the name of the user or group. c. In the Directory field, specify an authentication provider. Search User role 65

66 Managing Roles and Users For example, the name of the Active Directory. d. Click Find. The list of user or user groups appears. If you click Find before specifying a substring, the entire directory is returned, which might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. Index specific search roles Search Admin All access role 5. Select a user or group or select Select all. The Manage Application Admins window appears. 6. To assign a role, select the Search User checkbox. The following roles can be applied to specific indexes. Only an Application Administrator can assign the Search Admin All access role. The Search Admin All access role can perform the following actions inside a specified index: Perform a full content index of a search result Preview search results Download files locally Figure 13 Search Administrator All access role 66 Dell EMC Isilon Search 2.0 Installation and Administration Guide

67 Managing Roles and Users Assigning Search Admin All access role Only an Application Administrator can assign the Search Admin All access role for a specific index. 1. Ensure that the user or group has been added as an Active Directory or OpenLDAP source. 2. Select Administration > Indexes. The list of indexes appears. 3. Select the Index that you would like to give the user or group access to. 4. To manage search roles, click the following button: The Manage Search Roles window appears. 5. Click the add button: 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: Users or Groups Users Groups b. Type the name of the user or group. c. In the Directory field, select one of the configured LDAP servers. For example, the following options might appear: Default OpenLDAP server 3 AD directories 2 OpenLDAP directories d. Click Find. The list of user or user groups appears. If you click Find before specifying a substring, the entire directory is returned. This action might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. Index specific search roles 67

68 Managing Roles and Users Search Admin Read only role 7. Select a user or group or select Select all. The Manage Application Admins window appears. 8. Click OK. The Manage Search Roles window appears. 9. To assign the role to a user or group, select Search Admin All access. Only an Application Administrator can assign the Search Admin Read only role. The Search Administrator Read only role can perform the following actions inside a specific index: Perform keyword searches Perform filter searches View metadata for the search results Figure 14 Search Administrator Read only role Assigning a Search Admin Read only role Only an Application Administrator can assign the Search Admin Read only role for a specific index. 1. Ensure that the user or group has been added as an Active Directory or OpenLDAP source. 2. Select Administration > Indexes. The list of indexes appears. 3. Select the Index that you would like to give the user or group access to. 4. To manage search roles, click the following button: 68 Dell EMC Isilon Search 2.0 Installation and Administration Guide

69 Managing Roles and Users The Manage Search Roles window appears. 5. Click the add button: 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: Users or Groups Users Groups b. Type the name of the user or group. c. In the Directory field, select one of the configured LDAP servers. For example, the following options might appear: Default OpenLDAP server 3 AD directories 2 OpenLDAP directories d. Click Find. The list of users or user groups appears. If you click Find before specifying a substring, the entire directory is returned, which might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. 7. Select a user or group or click the Select all checkbox. The Manage Application Admins window appears. 8. Click OK. The Manage Search Roles window appears. 9. To assign the role to a user or group, select Search Admin Read only. The Search Admin Read only role cannot perform the following actions: See inline preview for hits View full preview for hits Download files locally Index specific search roles 69

70 Managing Roles and Users Search User role The Search User is a global search user that overrides any settings on indexes. Only an Application Administrator can assign the Search User role. A Search User can only see the files that they own and have access rights to through a configured CIFS/SMB share. Figure 15 Manage Search Roles A Search user can perform the following actions only on files that they own: Perform a full content index of a search result Preview search results Download files locally 70 Dell EMC Isilon Search 2.0 Installation and Administration Guide

71 Managing Roles and Users Figure 16 Search User View Assigning an index specific Search User role Only an Application Administrator can assign the Search User role for a specific index. 1. Ensure that the user or group has been added as an Active Directory or OpenLDAP source. 2. Select Administration > Indexes. The list of indexes appears. 3. Select the Index that you would like to give the user or group access to. 4. To manage search roles, click the following button: The Manage Search Roles window appears. 5. Click the add button: 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: Users or Groups Index specific search roles 71

72 Managing Roles and Users Users Groups b. Type the name of the user or group. c. In the Directory field, select one of the configured LDAP servers. For example, the following options might appear: Default OpenLDAP server 3 AD directories 2 OpenLDAP directories d. Click Find. The list of user or user groups appears. If you click Find before specifying a substring, the entire directory is returned. This action might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. 7. Select a user or group or click the Select all checkbox. The Manage Application Admins window appears. 8. Click OK. The Manage Search Roles window appears. 9. To assign the role to a user or group, select Search User. A search user can only see the files that they own and have access rights to through a configured CIFS/SMB share. They can perform all actions on these files. Managing roles Adding users or groups This section describes how to add and edit user roles and assign access privileges to administrators. With the System Administrator or Application Administrator role, you can assign roles to users. 1. In the Administration window, select either Manage > Isilon or Manage > System. The Administration view appears. 72 Dell EMC Isilon Search 2.0 Installation and Administration Guide

73 Managing Roles and Users 2. Select Administration > Roles. The Manage Application Admins window appears. 3. To add a user or group, click the following button: 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: Users or Groups Users Groups b. Type the name of the user or group. c. In the Directory field, select one of the configured LDAP servers. For example, the following options might appear: Default OpenLDAP server 3 AD directories 2 OpenLDAP directories d. Click Find. The list of user or user groups appears. If you click Find before specifying a substring, the entire directory is returned, which might slow performance. For example, to search for all users that contain Admin: a. Type Admin. b. Click Find. 5. Select a user or group or click the Select all checkbox. The Manage Application Admins window appears. 6. To assign a role to a user or group, click one or more of the following options: Application Administrator Search Administrator Search User Adding users or groups 73

74 Managing Roles and Users Figure 17 Manage Roles Window Removing users or groups With the System Administrator or Application Administrator role, you can remove users or groups. 1. In the Administration window, select either Manage > Isilon or Manage > System. The Administration view appears. 2. Select Administration > Roles. The Manage Application Admins window appears. 3. Click the name of the user or group you would like to delete. 4. Click the Delete button: 5. In the Confirm window, to remove the user or group, click Confirm. Results Editing role assignments The users or groups are no longer listed. With the System Administrator or Application Administrator role, you can assign or edit roles. 1. In the Administration window, select either Manage > Isilon or Manage > System. The Administration view appears. 2. Select Administration > Roles. The Manage Application Admins window appears. 74 Dell EMC Isilon Search 2.0 Installation and Administration Guide

75 Managing Roles and Users 3. Choose a user or group whose role you want to edit. 4. Click one or more of the following options: Application Administrator Search Administrator Search User Figure 18 Manage Roles Window Configuring LDAP and AD Isilon Search comes with a built-in OpenLDAP service with preconfigured accounts. For example, the Admin user. The default Admin user is not configured with an address and cannot receive notifications. With the System Administrator role, you can add additional LDAP or AD services to define additional users who can administer Isilon Search and perform search operations. Isilon Search does not authenticate the user against the LDAP authority. The Authentication Service uses the UUID of either the user or the group that the user belongs to is used in the external authority. When authentication succeeds, the Authentication Service issues a token for the user. The GUI uses the token information to ensure that the user can perform only the activities that the user has privileges to perform. You can only configure LDAP and AD users with the Application Administrator role. 1. In the Administration window, select Manage > System. The System Administrator view appears. 2. Select Administration > Options > LDAP Options. The LDAP Options window appears. 3. To add an LDAP server, click the following button: The Add LDAP Configuration window appears. Configuring LDAP and AD 75

76 Managing Roles and Users 4. In the Name field, type the LDAP configuration name. 5. In the Server Type field, select either of the following authentication types: Active Directory OpenLDAP 6. In the LDAP Server field, type either of the following: Hostname of the LDAP or AD server IP address of the LDAP or AD server 7. In the LDAP port field, type the port number that is used by the external authentication authority. For LDAP, the default port number is 389. For SSL, the default number for LDAPS changes to 636 when True is selected. 8. In the Base DN field, type the scope of the users and groups that are considered within the LDAP server. For example: DC=example, DC=com The Base DN determines the structure of the LDAP server where the search filter is applied. This 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 b. For Active Directory, ensure that the username is one of the following: Common name address Display name User principle name (UPN) Same account name Distinguished name (DN) c. For OpenLDAP, ensure that the username is one of the following: Common name address Entry distinguished name d. Ensure that the user has read access to the directory. e. To include notification, define the address for the account. 76 Dell EMC Isilon Search 2.0 Installation and Administration Guide

77 Managing Roles and Users Only admin accounts with defined addresses can receive notifications. The default admin user is not configured with an address and cannot receive 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: To connect to an external authentication server using LDAPS, select True. The default port number automatically changes to 636. To not apply secure connection settings, select False. 12. In the Default field, leave the option set to False. Default refers to the Isilon Search built-in OpenLDAP server. 13. To test the connection, click Test Connection. 14. Click Save. Configuring LDAP and AD 77

78 Managing Roles and Users 78 Dell EMC Isilon Search 2.0 Installation and Administration Guide

79 CHAPTER 5 Using the Dashboard This section includes the following topics: Viewing collector nodes Viewing index cluster Viewing indexes Viewing source servers Viewing system notifications Viewing application notifications...81 Using the Dashboard 79

80 Using the Dashboard Viewing collector nodes Only a System Administrator can view the health of the collector nodes. 1. To select the System Administration view, select Manage > System. Viewing index cluster 2. To view the health of the collector nodes, select Administration > Dashboard > Collector Nodes. Only a System Administrator can view the health of the index cluster. 1. To select the System Administration view, select Manage > System. Viewing indexes Viewing source servers 2. To view the health of the index cluster, select Administration > Dashboard > Index Cluster. 3. To see more details, click More. You can view index health as a System Administrator or as an Application Administrator. To view the health of the indexes, select Administration > Dashboard > Indexes > More. Only an Application Administrator can view the health of the source servers. 1. To select the Isilon Administration view, select Manage > Isilon. 2. To view the health of the collector nodes, select Administration > Dashboard > Index Cluster. 80 Dell EMC Isilon Search 2.0 Installation and Administration Guide

81 Using the Dashboard 3. To go to the Sources page, click More. Viewing system notifications The notification pane allows you to view up to five recent notifications for the system. 1. To select the System Administration view, select Manage > System. 2. To view system notifications, select Administration > Dashboard > Notifications. Notifications display chronologically. 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 the following button and select an option: 5. To mark a notification as read or unread, select the following button: Viewing application notifications The notification pane allows you to view up to five recent notifications for tasks and jobs. 1. To select the Isilon Administration view, select Manage > Isilon. 2. To view application notifications, select Administration > Dashboard > Notifications. Notifications display chronologically. The first five notifications are displayed. 3. To view all notifications, click More. 4. Select a notification and click the following button to mark it as read: Viewing system notifications 81

82 Using the Dashboard 82 Dell EMC Isilon Search 2.0 Installation and Administration Guide

83 CHAPTER 6 Monitoring Jobs, Services, and System Health This section includes the following topics: Viewing job type and status...84 Monitoring search jobs...86 Monitoring index jobs...86 Monitoring system jobs Viewing system health...87 Viewing system services Monitoring Jobs, Services, and System Health 83

84 Monitoring Jobs, Services, and System Health Viewing job type and status To determine a job type or status, hover over a job button. To view the list of jobs, select Administration > Jobs. The following table describes the job types. Table 9 Job Types Job Types Description FCI Performing a targeted full content index of search results. Scan Scanning the source Isilon cluster to prepare an index. Rescan Scanning the source Isilon cluster to update the index. Monitor Monitoring the system health and services of the cluster, nodes, and indexes. Add Source Adding a new source Isilon cluster. Delete Source Deleting a source Isilon cluster. Download Downloading a search result. System Performing system jobs and services, including the updating of the status and cache for configured Isilon clusters. System jobs are hidden by default. They can be seen by updating the filters. The following table describes the task status. 84 Dell EMC Isilon Search 2.0 Installation and Administration Guide

85 Monitoring Jobs, Services, and System Health Table 10 Task Status Status Description Spawning Indicates a job has been triggered. Pending Indicates a job is waiting to begin. Running Indicates a job is currently being performed. Stopping Indicates a job is being stopped. Success Indicates a job has been performed successfully. Failed Indicates a job has failed. Stopped Indicates a job has stopped. Timeout Indicates a job has timed out. If an adding a source job is still running after 10 minutes, the job is marked as timeout. Paused Indicates a job has been paused. A job can be paused manually. A job pauses automatically when there is minimal disk space. Pausing Indicates a job is being paused. Resuming Indicates a paused job is starting up again. Viewing job type and status 85

86 Monitoring Jobs, Services, and System Health Monitoring search jobs Search jobs include full content indexing (FCI) and downloading. To monitor search jobs as a Search User or Search Administrator, select Search > View Jobs. To monitor jobs as an Application Administrator, select Administration > Jobs. Use the following procedure to limit the jobs view to search jobs only. 1. Select Administration > Jobs. The Jobs window opens. 2. To open the list of available job filters, click the following button: The filters menu appears. 3. To narrow the jobs list to display only search jobs, ensure that only the following job types are selected: FCI Download 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 status of each task displays. 6. To refresh the list of jobs, click the following button: Monitoring index jobs 1. Select Administration > Jobs. The Jobs window opens. 2. To open the list of available job filters, click the following button: The filters menu appears. 3. To narrow the jobs list to display only index jobs, ensure that only the following job types are selected: Scan Rescan Monitor 86 Dell EMC Isilon Search 2.0 Installation and Administration Guide

87 Monitoring Jobs, Services, and System Health Add Source Delete Source 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 status of each task displays. 6. To refresh the list of jobs, click the following button: Monitoring 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. 1. To select the Isilon Administration view, select Manage > Isilon. 2. Select Administration > Jobs. The Jobs window opens. 3. To view the system jobs together with all job types, click the following button: System jobs appear along with all other jobs. 4. To narrow the jobs list to display only system jobs: a. Click the following button: 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 status of each task displays. 6. To refresh the list of jobs, click the following button: Viewing system health You can view storage and memory thresholds and current values within the System Health window. Monitoring system jobs 87

88 Monitoring Jobs, Services, and System Health 1. To select the System Administration view, select Manage > System. Figure 19 System Administrator view 2. To view the health of the system, select Administration > System. The value in the Current column is color coded according to the following threshold values: Option Green Yellow Red Description Acceptable value Near threshold value Exceeds threshold value Notifications are sent when thresholds are exceeded. If free Data Disk space falls below the lower threshold of the space that is required, all active jobs are paused. Manually resume the paused jobs once more disk space becomes available. Viewing system services 3. To view system notifications, select Administration > Dashboard > Notifications > More. You can view the components, status, and version of each Isilon cluster within the System Services window. The status is updated every ten minutes. Clicking the refresh button the status to update more quickly. will not cause 1. To select the System Administration view, select Manage > System. 88 Dell EMC Isilon Search 2.0 Installation and Administration Guide

89 Monitoring Jobs, Services, and System Health Figure 20 System Administrator view 2. To view system services, select Administration > System. Notifications are sent when the status changes. If a service stops running, the system tries to restart the service automatically. If a problem that stopped the service is unresolved, the system might not restart. For example, the system is out of disk space or the network is down. After a service is restarted, the UI might not reflect the change in status until the next 10 minute refresh cycle. 3. To view system notifications, select Administration > Dashboard > Notifications > More. Viewing system services 89

90 Monitoring Jobs, Services, and System Health 90 Dell EMC Isilon Search 2.0 Installation and Administration Guide

91 CHAPTER 7 Performing Search and Viewing Search Results This section includes the following topics: About Searches...92 Optimizing search performance Using filters to optimize search results Using keywords to search Sorting search results Viewing the metadata of search results Downloading files from search results Searching for files within containers Managing full content index searches Performing Search and Viewing Search Results 91

92 Performing Search and Viewing Search Results About Searches Isilon Search performs metadata searches on indexed files and folders, and performs full content searches on files that have had their full content indexed. Isilon Search supports keyword and advanced Lucene search queries. Search results include a summary of certain fields for the file, such as file name, location, size, and date. Consider the following: If a file is indexed for metadata, keywords or phrases that are found in the name of the file or path are highlighted. If a file is indexed for full content indexing (FCI), 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 (score), which defines how well the search results match the search criteria. Figure 21 Search window Accessing only the Search window The Isilon Search virtual appliance is accessed as a web-based interface. Depending on your user privileges, you can perform administration or search tasks. To perform searches, you must be assigned one of the following roles: Search Admin All Access Search Admin Read Only Search User 92 Dell EMC Isilon Search 2.0 Installation and Administration Guide

93 Performing Search and Viewing Search Results You must log in to the Isilon Search UI each time it is opened, or after an inactivity time out of 20 minutes or more. The default inactivity timeout is 20 minutes. To perform searches, complete the following steps. 1. In a web browser, type the following: You might be required to acknowledge a browser warning regarding self-signed certificates before continuing. 2. To log in: a. Type the username and password. The default username is Admin. A System Administrator or Application Administrator can assign roles to users. b. Click Sign In. The Search UI opens. Optimizing search performance At the core of Isilon Search is Elasticsearch, a high performance indexing and search system capable of searching billions of objects within seconds. To leverage Elasticsearch replication at least two nodes are required, although a single node is supported. To further increase the speed at which search results are returned, observe the following best practices: Use search filters to narrow the search scope, and limit the number of results. Only add specific queries if you know the details of the content that you are looking for. For example, specify the file type, date, and owner using the search filters instead of typing them directly into the Search bar. Limit the number of simultaneous queries by different users. Using filters to optimize search results You can use one or a combination of the following filter options to narrow and optimize search results: File type File name Optimizing search performance 93

94 Performing Search and Viewing Search Results File size Location Source Unindexable content Create time Access Time Owner To change filter selection and modify the search, click Add Remove Filters. To view jobs for search results, click View Jobs. To apply the selected search filters, click Save and Close. The Search results window appears. Figure 22 Search filters Narrowing a search by folder or file 1. Open the Search window. 2. Click Search Type. 3. Select one or both of the following options: Isilon folder Isilon file 94 Dell EMC Isilon Search 2.0 Installation and Administration Guide

95 Performing Search and Viewing Search Results Narrowing a search by file type To narrow the search by file type, perform one of the following steps from the Search window. Search by file type To narrow the search by file type, type a file name extension in the Type field: 1. Click Type. 2. Type a file name extension, or multiple file extensions separated by commas. View and select from available file types To view and select from available file types, click the pie chart button. The pie chart breaks down the current search by frequency of file type: Only the top 10 most frequent file types in the search display. Each file type extension is listed below the pie chart. Narrow the view of the pie chart To narrow the view of the pie chart: 1. Click the pie chart button: 2. Click a section of the pie chart or a file extension from the legend. The pie chart adjusts and narrower slices are expanded for easier viewing. Figure 23 File type pie chart Narrowing a search by file type 95

96 Performing Search and Viewing Search Results Narrowing a search by file attributes You can narrow the search results by applying one or more of the following search filters. File name File size 1. In the Search window, click the Name field. 2. Specify the placement of the keyword. You can select from the following: Contains with (default) Begins with Ends with 3. Type the name. The name can include wildcard characters (*). 1. Open the Search window. 2. Click Size. 3. Specify a minimum or maximum file size. 4. To select a range of sizes, click the following button: File location 1. Open the Search window. 2. Click Location. 3. To search for a specific file path, enclose the entire 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. Narrowing a search by date and time attributes You can narrow the search results by applying one or more of the following search filters. Date The date represents the date the file or folder was last modified. 1. Open the Search window. 2. Click Date. 96 Dell EMC Isilon Search 2.0 Installation and Administration Guide

97 Performing Search and Viewing Search Results 3. Specify a minimum or maximum date. 4. To display a breakdown of results and filter the search by the month of a year: a. Click the following button: b. Select a specific month in which to search. Date created 1. Open the Search window. 2. Click Date Created. 3. Specify a minimum or maximum date. 4. To display a breakdown of results and filter the search by the month of a year: a. Click the following button: b. Select a specific month in which to search. 5. To display a visual breakdown of the current search results, click the following button: Date last accessed 1. Open the Search window. 2. Click Date Last Accessed. 3. Specify a minimum or maximum date. 4. To display a breakdown of results and filter the search by the month of a year: a. Click the following button: Specifying an Isilon cluster b. Select a specific month in which to search. 1. Open the Search window. 2. Click Source. 3. To display a visual breakdown of the current search results and filter for specific clusters, click the following button: Specifying an Isilon cluster 97

98 Performing Search and Viewing Search Results Including content that was not indexed in the search To search for items that were not successfully full content indexed, consider the following factors: The file type or size. The text was not extracted from the file. 1. Open the Search window. 2. Click Unindexable Content. 3. Select Yes. Narrowing a search by owner To narrow the search by owner perform one of the following steps from the Search window: To narrow the search by content owner 1. Open the Search window, by clicking the following button: The Search window appears and displays the search options. 2. Click Owner. 3. Type any of the following: The owner username. The owner domain. The owner domain and username. To view available owners 1. Click the pie chart button: 2. Consider the following: The pie chart breaks down the current search by ownership. Only the top 10 owners are displayed. To narrow the view of the pie chart 1. Click the pie chart button: Using keywords to search 2. Click a section of the pie chart. The pie chart adjusts and narrower slices are expanded for easier viewing. To use keywords to search, perform one of the following steps from the Search window: 98 Dell EMC Isilon Search 2.0 Installation and Administration Guide

99 Performing Search and Viewing Search Results 1. To open the Search window, click the following button: The Search window appears and displays the search options. 2. To perform a basic search: a. In the Search dialog box, type a keyword. b. Click Search. The Search Results page appears. 3. To perform an advanced search: a. In the Search field, type a Lucene query. b. Click Search. The following table includes Lucene syntax examples. Table 11 Example Lucene syntax Syntax examples field:value field:"phrase" field :(value1 OR value2) _ missing_:field _ exists_: field field:qu?ck bro * xvname:/joh?n(ath[oa]n)/ field:quikc~brwn~foks~ field:"fox quick"~ 5 xvdate:[ TO ] xvdate:{to } xvsize:>10000 quick brown +fox -news Description The field contains the value The field contains the exact phrase The field contains one or both values The field has no value or is missing The field has any non-null value Use wildcards Use regular expression Words that are similar No more than 5 words between them Match any day in range Specified date search All files with sizes over bytes The word fox must be present, news must not be Isilon Search uses Elasticsearch to leverage Lucene 5.5 The Search results page appears. 4. To enable a search for key words within a file that has been full content indexed (FCI): Using keywords to search 99

100 Performing Search and Viewing Search Results You can only perform a full content index or preview the contents of a file if you are the owner of the file, or if you have search administrator rights with all access privileges. a. On the Search Results page, select FCI from the list box of actions. b. To full content index a file, click the checkbox next to the files that you would like to full content index. c. Perform a full content index of the content of the file: To perform an FCI operation on all the file entries that appear on the page, click Select All. To perform an FCI on only the selected files, click Selected. To perform an FCI operation on search hits that match the current query, click All. Full content indexing a large number of items can take a long time; potentially days. Carefully filter the search to include only files that should be full content indexed. d. To monitor progress of a full content indexing job, click View Jobs. e. To refresh the search results, click Search and then re-run the search. The FCI button appears next to the file that has been full content indexed and the Preview option appears. f. To preview the file content, click Preview. You are now able to search for content within the file from the search bar. 100 Dell EMC Isilon Search 2.0 Installation and Administration Guide

101 Performing Search and Viewing Search Results Figure 24 FCI Enabled Search Results 5. To view the metadata of a file, in the Search results page click Detail for the file. 6. To download a file, full access permissions are required: You can only download files locally if you are the owner of the file, or if you have search administrator rights with all access privileges. Sorting search results a. On the Search Results page, select Download from the list box of actions. b. Next to the files that you would like to download, click the checkbox. c. Download the file: To download all the file entries that appear on the page, click Select All. To download only the selected files, click Selected. To download search hits that match the current query, click All. d. To monitor progress of the download, click View Jobs. To change the criteria on which the results are sorted, perform the following steps. Sorting search results 101

102 Performing Search and Viewing Search Results 1. From the Sort By (DESC) filter, select another item. The default sorting method is Relevance (sort score). The Relevance score determines how well the search results match the search criteria. 2. To change the filter order from ascending to descending, click the Z to A button beside the list box words. 3. Review the search results. Viewing the metadata of search results You can only view metadata details if you are the owner of the file, or if you have search administrator rights with all access or read only privileges. To view the metadata of a search result, in the Search results window click Detail for the file. The following search result information displays: The name of the application that stores the data, for example, Isilon The name of the index File name, location, type, and size The date the file was indexed For a file that was full content indexed, the application level metadata If the file resides in a container If the file cannot be indexed Share path Downloading files from search results You can only download files locally if you are the owner of the file, or if you have search administrator rights with all access privileges. 1. To download a single file: a. Select a file from the search results by clicking the checkbox. b. Click Download from the list box of actions. c. In the browser, view the download progress. 2. To download multiple files: a. Select multiple files by clicking their checkboxes. Alternatively, click Select All. b. Click Actions > Download. c. To monitor the progress of the download, click View Jobs. 102 Dell EMC Isilon Search 2.0 Installation and Administration Guide

103 Performing Search and Viewing Search Results Downloading a folder downloads all of the files inside of it. However, nested files are not downloaded. Searching for files within containers A file that resides inside a container is labeled as a Child file. If a.zip or.tar file is expanded, the file is labeled as Expanded. To browse and search for files within containers, use the following methods: To view all the children of an expanded file, next to the file click the checkbox, and then click Expand. To view the expanded file that the child file belongs to, next to the file click the checkbox, and then click Child. Figure 25 Container labels Managing full content index searches The sections that follow describe how to perform full content index (FCI) searches. Isilon Search performs metadata searches on indexed files and folders, and performs full content searches on files that have had their full content indexed. Isilon Search supports keyword and advanced Lucene search queries. Search results include a summary of certain fields for the file, such as file name, path, size, date, and ownership. By default, the search is sorted by Relevance (score), which defines how well the search results match the search criteria. Consider the following: If a file is indexed for metadata, keywords or phrases that are found in the name of the file or path are highlighted. Searching for files within containers 103

104 Performing Search and Viewing Search Results Search results include a summary of certain fields for the file, such as file name, path, size, date, and ownership. 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. Performing a Full Context Index on containers The Indexing files within containers feature allows individual files and folders inside a container (zip, tar, gz, tgz) files to be indexed as individual items. By default, this feature is disabled when adding a new source. In this scenario, when one of these file types is full content indexed, only the container is processed. The text for items that reside inside the container is included in the index. However, all that text in the container is considered part of the full content of the container and not an individual object. This feature is separate from the initial scan, because it implements lazy indexing where containers are processed in the background after a scan completes. If the Indexing files within containers feature is enabled for the source, each individual item inside the container is full content indexed separately and stored as separate items. For example, a zip file DocumentArchive.zip contains twenty Microsoft Word documents. One of these documents, CustomerList.docx, includes the word Confidential. After the initial scan, the administrator chooses to full content index DocumentArchive.zip: If the Files Within Containers option is Disabled, a search for Confidential matches the DocumentArchive.zip file. If the Files Within Containers option is Enabled, a search for Confidential matches the CustomerList.docx which resides in the DocumentArchive.zip file. Performing a full content index on search results Use the full content index (FCI) feature to perform a targeted full content index of search results so that you can view a preview of the content and search for keywords. You can only perform a FCI or preview the contents of a file or directory if you are the owner of the file or directory, or if you have Search Administrator rights with all access privileges. 1. Open the Search window by clicking the following button: The Search window appears. 2. Perform a search. The Search Results window opens. 3. To enable a search for key words within a file (FCI): 104 Dell EMC Isilon Search 2.0 Installation and Administration Guide

105 Performing Search and Viewing Search Results You can only perform a full content index or preview the contents of a file if you are the owner of the file, or if you have search administrator rights with all access privileges. a. On the Search Results page, select FCI from the list box of actions. b. Next to the files that you would like to full context index, click the checkbox. c. Perform a FCI of the content of the file: To perform an FCI operation on all the file entries that appear on the page, click Select All. To perfom an FCI on only the selected files, click Selected. To perform an FCI operation on search hits that match the current query, click All. Full content indexing a large number of items can take a long time; potentially days. Carefully filter the search to include only files that should be full content indexed. 4. To refresh the search results, click Search, and then re-run the search. The FCI button appears next to the file that has been full content indexed and the Preview option appears. Performing a full content index on search results 105

106 Performing Search and Viewing Search Results Figure 26 FCI Enabled Search Results 5. To monitor progress of a full content indexing job, click View Jobs. 6. To preview the file content, click Preview. You can now search for content within the file from the Search bar. 7. To perform a basic search of the Preview content: a. In the Search dialog box, type a keyword. b. Click Search. Searching for files that have not been full content indexed You can only perform a full content index (FCI) or preview the contents of a file or directory if you are the owner of the file or directory, or if you have Search Administrator rights with all access privileges. 1. Open the Search window by clicking the following button: 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 106 Dell EMC Isilon Search 2.0 Installation and Administration Guide

107 Performing Search and Viewing Search Results 4. Click Search. Restricting a search to only include files that have been full content indexed You can only perform a full content index (FCI) or preview the contents of a file or directory if you are the owner of the file or directory, or if you have Search Administrator rights with all access privileges. 1. Open the Search window by clicking the following button: 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. Searching for application specific metadata 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. Examples of application-specific metadata include the following: Author Title Title and artist for audio files Word-count for Microsoft Office files Camera name Resolution for image files You can only perform a full content index (FCI) or preview the contents of a file or directory if you are the owner of the file or directory, or if you have Search Administrator rights with all access privileges. 1. Open the Search window by clicking the following button: The Search window appears. 2. (Optional) To further limit the search, select a search filter. 3. In the Search bar, type the following keyword: xvmetadata:"metadata_subject:keyword" 4. Click Search. Restricting a search to only include files that have been full content indexed 107

108 Performing Search and Viewing Search Results Matches are highlighted in a short snippet. Figure 27 Application-specific metadata search results 5. To view the application-specific metadata, click Details. Figure 28 Details view 108 Dell EMC Isilon Search 2.0 Installation and Administration Guide