How to use indexer-enumerator.sh

If you want to enumerate an entire cluster and you have an Search (Indexer) Feed already configured, you may use the indexer-enumerator.sh script from the support tools bundle to do so.

For a smaller query, it might be easier to use the Content UI portal (if it’s installed on a Content Gateway). This script is for enumerating potentially large data sets where the UI would be less helpful.

Tips

You can run the script with “bash -x” to get examples of the curl syntax that you can adapt for your own custom indexer calls.
You can search by domain, bucket, prefix, size, date written, and type of object.
When you have the match you want, you can remove the -orc options and from there output the object match results to file.

Be careful to run this script from a directory/partition with plenty of disk space if you are returning millions of objects.

For full enumerations of larger data sets, you may want to add the -s option to echo the enumerator loop count. Each call to the indexer has a maximum of 10k returned values, so knowing how many iterations of that 10k figure the script has returned is valuable for larger enumerations.

Instructions

This is an extended example of how you can use this script to investigate what is in your cluster.

The environmental variable SCSP_HOST is set to a storage node IP to avoid having to put -a [storage-node-ip] on every example below.

1 Listing domains
2 Counting objects and space usage
3 Counting untenanted objects
4 Counting buckets
5 Searching objects
6 Searching unnamed objects
7 Searching metadata
8 Searching across multiple domains
9 Searching by age
10 Search by size

Listing domains

Run indexer-enumerator.sh -D to find out what domains exist in your cluster.

[root@c-csn1 tmp]# indexer-enumerator.sh -D
A complete domain listing can be found here: ./OUTPUTDIR-2020_0722-124732/domains.txt

Because a domain listing should be short, I use the -or options to output the results to stdout: