Search <book_title>...

Arctera Data Insight Administrator's Guide

Last Published: 2025-01-21

Product(s): Data Insight (7.1)

Platform: Windows

Section I. Getting started
1. Introduction to Arctera Data Insight administration
  1. About Arctera Data Insight administration
    1. Operation icons on the Management Console
    2. Data Insight administration tasks
2. Configuring Data Insight global settings
Section II. Configuring Data Insight
Section III. Configuring native file systems in Data Insight
Section IV. Configuring SharePoint data sources
1. Configuring monitoring of SharePoint web applications
2. Configuring monitoring of SharePoint Online accounts
Section V. Configuring cloud data sources
Section VI. Configuring Object Storage Sources
1. Amazon S3
Section VII. Health and monitoring
1. Using Arctera Data Insight dashboards
2. Monitoring Data Insight
Section VIII. Alerts and policies
1. Configuring policies
Section IX. Remediation
1. Configuring remediation settings
Section X. Reference

Name

indexcli.exe — a utility that manages the index segments available on an Indexer worker node.

SYNOPSIS

indexcli.exe
              --display|--archive|--purge|--restore|--rearchive|--rehash|--
             list-jobs|--stop-jobs|--import-tags [OPTIONS]

indexcli.exe -A <name of the index segments to be archived>

indexcli.exe -c

indexcli.exe -D <name of the index segments to be purged>

indexcli.exe -d

indexcli.exe -h

indexcli.exe -j

indexcli.exe -r

indexcli.exe -t

indexcli.exe -u

indexcli.exe -H

indexcli.exe -V

Archive options

indexcli.exe -A -a ¦ -f <FILERS> ¦ -m 
<SHARES> ¦ -S <SITECOLLS> ¦ -w <WEBAPPS> ¦ -I
 <MONTHS>

-a, --all: Archives all index segments older than the specified interval.

-f, - - filer<name of filer(s)>: Archives all index segments for the specified list of filers.

-i, -- older-than <interval in months>: Archives segments older than the specified interval. The segments which have been restored earlier are not archived.

-m, --share <name of share(s)>: Archives all index segments for the specified list of shares.

-S,--sitecoll <SITECOLLS>: Archives segments for specified list of Microsoft SharePoint site collections.
-w, --webapp <WEBAPPS><: Archives segments for specified list of Microsoft SharePoint web applications.

Purge options

indexcli.exe -D -a ¦ -f <FILERS> ¦ 
-m <SHARES> ¦ -S <SITECOLLS> ¦ -w <WEBAPPS> ¦ 
-i <MONTHS>

-a, --all: Purges all index segments older than the specified interval.

-f, - - filer <name of filer(s).: Purges all index segments for the specified list of filers.

-i, -- older-than,interval in months.: Purges segments older than the specified interval. The segments which have been explicitly restored earlier, for which the lease is still valid, are not purged.

-m, --share <name of share(s)>: Purges all index segments for the specified list of shares.

-S,--sitecoll <SITECOLLS>: Purges segments for specified list of Microsoft SharePoint site collections.
-w, --webapp <WEBAPPS><: Purges segments for specified list of Microsoft SharePoint web applications.

Warning:

Purged segments cannot be restored back to the index.

Display options

indexcli.exe -d -a ¦ -f <FILERS> ¦ 
-m <SHARES> ¦ -S <SITECOLLS> ¦ -w <WEBAPPS> ¦ 
-s <STATES>

-a, --all: Displays information for all shares.

-f, - - filer<name of filer(s)>: Displays information for the specified list of filers.

-m, --share <name of share(s)>: Displays information for the specified list of shares.

-s <name of state>: Displays index segments for the given state only. Multiple stars can be separated by comma. Possible states are, ARCHIVING, RE-ARCHIVING, ARCHIVED, RESTORING, RESTORED, RESTORE, FAILED, or DELETED.

-S,--sitecoll <SITECOLLS>: Displays information for a specified list of Microsoft SharePoint site collections.
-w, --webapp <WEBAPPS><: Displays information for a specified list of Microsoft SharePoint web applications.

Restore options

indexcli.exe -r -a ¦ -f <FILERS> ¦ 
-m <SHARES> ¦ -S <SITECOLLS> ¦ -w <WEBAPPS> [-C] -F <FROM> ¦  
¦ -R <RANGE>
[-l <MONTHS> ¦ -L <MONTHS> ¦ -y]

-a, --all: Restores the index segments for all shares.

-C,--continue-on-error: If the continue-on-error option is not specified, the restore command fails if the segment files required to restore data for the specified parameters are not available.

-f, - - filer<name of filer(s)>: Restores all index segments for the specified list of filers.

-F,--from<month from which the segments need to be restored>: Specify the month in the format, YYYY/MM. For example, indexcli.exe -r -F 2010/01 restores segments from January 2010 till date.

-L,--setlease <interval in number of months>: Resets lease on segments that are restored earlier using -l option. Specify the new lease interval in months. This command replaces the previous lease interval. Setting the value to 0 will make the lease permanent.

-l,--lease<interval in number of months>: Restores segments for a temporary lease in months. After the lease expires, restored segments are automatically re-archived. If this option is not specified, segments remain restored till you re-archive them with the -u, --rearchive, option.

-m, --share <name of share(s)>: Restores all index segments for the specified list of shares.

-S,--sitecoll <SITECOLLS>: Restores segments for a specified list of Microsoft SharePoint site collections.
-w, --webapp <WEBAPPS><: Restores segments for a specified list of Microsoft SharePoint web applications.

--R,--range<range in months>: Restore all index segments for the specified month range. Specify the month in the format, YYYY/MM-YYYY/MM. For example, indexcli.exe -r -R 2010/01-2010-03 restores segments from January 2010 to March 2010.

-y,--dryrun: Instead of restoring segments, this option displays the list of files that must be available before restoring the specified segments.

Re-archive options

indexcli.exe -u -a ¦ -f <FILERS> ¦ 
-m <SHARES>  ¦ -S <SITECOLLS> ¦ -w <WEBAPPS>  
-F <FROM> ¦ -R <RANGE>

-a: Re-archives all previously restored index segments.

-f <name of filer(s)>: Re-archives previously restored index segments for the specified list of filers.

-F <month FROM which the segments need to be restored>: Specify the month in the format, YYYY/MM. For example, indexcli.exe -u -F 2010/01 restores segments from January 2010 till date.

-m <name of share(s)>: Re-archives previously restored index segments for specified list of shares.

-S,--sitecoll <SITECOLLS>: Re-archives previously restored segments for a specified list of Microsoft SharePoint site collections.
-w, --webapp <WEBAPPS><: Re-archives previously restored segments for a specified list of Microsoft SharePoint web applications.

-R <range in months>: Restore all index segments for the specified month range. Specify the month in the format, YYYY/MM-YYYY/MM. For example, indexcli.exe -u -R 2010/01-2010-03 restores segments from January 2010 to March 2010.

List jobs options

indexcli.exe -j [-I] [-P] 
-j,--list-jobs     list index jobs
-I   if specified, displays all jobs related to updating activity index
 -P   if specified, displays all jobs related to updating control point

Stop jobs options

indexcli.exe -c [-I] [-P] -c,--stop-jobs     stop all index jobs
 -I   if specified, stops all jobs related to updating activity index
 -P   if specified, stops all jobs related to updating control point

Tags import options

indexcli.exe -t -o <OUTPUT> -T <TAGSDB>

-t,--import-tags   imports tags
 -o,--output <OUTPUT>   output folder where the processed per-share tag
                        databases will be placed
 -T,--tagsdb <TAGSDB>   tags database to import

Rehash options

indexcli.exe -H [-n]

-H,--rehash        rehash all indexes
 -n,--noforce   If specified, only those indexes which don't have the file
                rehash.log will be rehashed

EXAMPLES

EXAMPLE 1: The following command archives index segments for specified list of filers.

indexcli.exe -A -f \\filer1,\\filer2,ID1,ID2

EXAMPLE 2: The following command archives index segments for specified list of shares.

indexcli.exe -A -m \\filer1\share1,\\filer2\shares2,ID3,ID4

EXAMPLE 3: The following command purges index segments for specified list of filers.

indexcli.exe -D -f \\filer1,\\filer2,ID1,ID2

EXAMPLE 4: The following command purges segments for specified list of shares.

indexcli.exe -D -m \\filer1\share1,\\filer2\shares2,ID3,ID4

EXAMPLE 5: The following command restores index segments for specified list of filers.

indexcli.exe -r -f <\\filer1,\\filer2,ID1,ID2>

EXAMPLE 6: The following command restores index segments for specified list of shares.

indexcli.exe -r -m \\filer1\share1,\\filer2\shares2,ID3,ID4

EXAMPLE 7: The following command re-archives previously restored index segments for specified list of filers.

indexcli.exe -u -f \\filer1,\\filer2,ID1,ID2

EXAMPLE 8: The following command re-archives previously restored index segments for specified list of shares.

indexcli.exe -u -m \\filer1\share1,\\filer2\shares2,ID3,ID4

EXAMPLE 9: The following command archives segments for specified list of Microsoft SharePoint site collections.

indexcli.exe -S,--sitecoll<http://sp_webapp:8000/sc1,ID2,ID3...>

EXAMPLE 10: The following command archives segments for specified list of Microsoft SharePoint web applications.

indexcli.exe - w,--webapp<http://sp_webapp:8000,ID2,ID3,...>

EXAMPLE 11: The following command purges segments for specified list of Microsoft SharePoint site collections.

indexcli.exe -S,--sitecoll<http://sp_webapp:8000/sc1,ID2,ID3...>

EXAMPLE 12: The following command purges segments for specified list of Microsoft SharePoint web applications.

indexcli.exe - w,--webapp<http://sp_webapp:8000,ID2,ID3,...>

EXAMPLE 13: The following command displays information for specified list of Microsoft SharePoint site collections.

indexcli.exe -S,--sitecoll<http://sp_webapp:8000/sc1,ID2,ID3...>

EXAMPLE 14: The following command displays information for specified list of Microsoft SharePoint web applications.

indexcli.exe - w,--webapp<http://sp_webapp:8000,ID2,ID3,...>

EXAMPLE 15: The following command restores segments for specified list of Microsoft SharePoint site collections.

indexcli.exe -S,--sitecoll<http://sp_webapp:8000/sc1,ID2,ID3...>

EXAMPLE 16: The following command restores segments for specified list of Microsoft SharePoint web applications.

indexcli.exe - w,--webapp<http://sp_webapp:8000,ID2,ID3,...>

EXAMPLE 17: The following command re-archives previously RESTORED segments for specified list of Microsoft SharePoint site collections.

indexcli.exe -S,--sitecoll<http://sp_webapp:8000/sc1,ID2,ID3...>

EXAMPLE 18: The following command re-archives previously RESTORED segments for specified list of Microsoft SharePoint web applications.

indexcli.exe - w,--webapp<http://sp_webapp:8000,ID2,ID3,...>