Online Help

You can use the Catalog tab of the MediaAgent Properties dialog box to view and modify index file parameters and retention criteria.

Index Directory

Enable this Access Path

Select this check box to make the path in index directory active.

Index Directory

The directory where index data is stored.

You can change this directory. If it does not already exist, the MediaAgent software creates it in the default location, software_installation_directory/IndexCache.

When you change this setting, the MediaAgent copies the existing cache contents to the newly specified index cache directory, and directs all new cache entries to the new directory. Because the Windows MediaAgent copies the existing cache contents, you can manually delete the original directory to free up disk space.

Notes

  • Use a file system dedicated to index data, so that non-index data does not consume index capacity.

  • Estimate your index cache space requirements with a sufficient margin of safety by allocating more space rather than less. If you are maintaining backward-compatible content indexes generated by a previous software version, the index cache directory may require more space.

  • For best performance, locate the index cache directory on a solid state drive (SSD).

  • Do not locate the index cache directory on a compressed drive.

  • For Windows, do not place the index cache directory directly under the software_installation_directory.

  • For UNIX, do not specify root as the index directory.

  • The index cache directory path must meet the following requirements:

    • It may not exceed 75 characters.

    • It may not contain the "!" character.

    • It may not contain Unicode characters.

  • Do not host the index cache directory on your CommServe computer, unless you only have one MediaAgent and that MediaAgent is located on that computer.

Browse

Click to locate the index cache directory in a Windows tree, and then set it.

Offline Reason

If the index cache directory is offline, this field displays the reason.

Index Retention

Retain index for n days

Note

This option does not apply to Indexing Version 2. For information about index retention in Indexing Version 2, see Index Cleanup and Compaction Operations (Indexing Version 2).

When an index becomes older than this parameter, the system runs a cleanup job that automatically deletes the index and log files within 24 hours.

Generate alerts when free space falls below n GB

If the amount of free space in the index cache falls below this parameter (default = 50GB), the system sends alerts to the administrator email account. For more information, see the predefined alert "Disk space low on MediaAgent" in Alerts and Notifications - Predefined Alerts.

Note

If you want to set this parameter to 10 GB or less, you must use the Change Index Cache Configuration workflow. You cannot set this parameter to 10 GB or less in the MediaAgent Properties dialog box.

Take the Index offline when free space falls below n GB

This is the total space that must be available in the index cache for it to remain online. If free space falls below this parameter (default = 10GB), the system takes the index cache offline and begins event-driven cleanup. For more information, see "Event-Driven Cleanup" in Index Cache Directory Cleanup.

Note

If you want to set this parameter to 1 GB or less, you must use the Change Index Cache Configuration workflow. You cannot set this parameter to 1 GB or less in the MediaAgent Properties dialog box.

Cleanup until free space is at least

Note

This option does not apply to Indexing Version 2. For information about index retention in Indexing Version 2, see Index Cleanup and Compaction Operations (Indexing Version 2).

During an event-driven cleanup, the system checks to see if the percentage of free space remaining is greater than or equal to this parameter. If the percentage of free space remaining is less than this parameter, even after aged indexes are deleted, then additional indexes will be removed on a least-recently-used basis, until the free disk space percentage becomes greater than or equal to this value. For more information, see "Event-Driven Cleanup" in Index Cache Directory Cleanup.

Index Directory Space

These fields display the current state of index cache directory space usage. For more information about index space requirements, see Planning (Indexing Version 1) or Planning (Indexing Version 2).

Total Size

The total volume size (in MB or GB) that the index cache directory resides on.

Index

Index cache directory disk space (in MB or GB) currently used by index files. The number in parentheses shows the usage as a percentage of the Total Size disk space. Note that when index files are changed, added, or deleted, it make take up to 30 minutes for the Index value to update.

Other Data

Index cache directory disk space (in MB or GB) currently used by data other than index files. The number in parentheses shows the usage as a percentage of the Total Size disk space.

Free Space

Free disk space (in MB or GB) available to the index cache directory. The number in parentheses shows the free disk space as a percentage of the Total Size disk space.

Loading...