Index Cache - How To

Topics | How To | Troubleshoot | Related Topics


Create a Network Share Profile

Configure a MediaAgent for Index Cache Sharing

Enable (or Disable) Index Cache Sharing for a Job

Delete a Network Share Profile

Edit a Network Share Profile

Set the Index Retention Criteria

Move an Index Cache

Move a Shared Index Cache

Manually Relocate the Index Cache

Unshare a Shared Index Cache

Intermediate Index Cache


Create a Network Share Profile

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To create a network share profile for index cache sharing:

  1. From the CommCell Browser, right-click the CommServe, click Control Panel, and select Shared Catalog Configuration.

    Alternatively, from the CommCell Browser, right-click the MediaAgent, and click Configure.

  2. From the Shared catalog Configuration dialog box, click Add to create a Network Share Profile.
  3. Enter the name of the Profile to be created in Profile Name box.
  4. Select the type of index share:
  5. In the Profile Properties area, specify the following retention criteria for the shared index cache.
  6. Click OK to create the profile. You can use this profile on a MediaAgent to share the index cache.

Configure a MediaAgent for Index Cache Sharing

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To configure a MediaAgent for index cache sharing:

  1. From the CommCell Browser, right-click the MediaAgent you wish to share the index cache and click Properties.
  2. From the MediaAgent Properties window click the Catalog tab.
  3. Select Catalog Profile option to enable index cache sharing.
  4. To use a Network Share, click Network Share and select a Network Share profile from the list. All Network Share profiles created from the Shared Catalog Configuration window will be available for selection.

    Point your index cache to the network share location. 

    For Windows MediaAgents:

    For Unix MediaAgents:

  5. The index cache is shared.
  6. Now this index is available to be shared from other MediaAgents.

  7. Right-click another MediaAgent that will share the index and then click Properties.
  8. Click the the Catalog tab.
  9. Select Catalog Profile option to enable index cache sharing.
  1. To use a Network Share, click Network Share and select a Network Share profile from the list. All Network Share profiles created from the Shared Catalog Configuration window will be available for selection.

    Point your index cache to the network share location. 

    For Windows MediaAgents:

    For Unix MediaAgents:

  2. Repeat steps 8 -10 on all the MediaAgents that share the index cache.

Enable (or Disable) Index Cache Sharing for a Job

Before You Begin

The catalog server option for the job is applicable only if the MediaAgent performing the backup is configured for index cache sharing.

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To enable (or disable) index cache sharing using catalog server:

  1. From the CommCell Browser, select one of the following:
  2. If you chose a level higher than subclient (i.e., backup set, etc.), you are prompted to confirm that you want to back up all the subclients below that level. Click Yes.
  3. If you want to adjust the granular restartability option for the backup job, click Advanced from the Backup Options window.

    From the Advanced Backup Options (Data) tab, select one of the following options.

  4. Click OK.

Delete a Network Share Profile

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To delete a catalog server profile:

  1. From the CommCell Browser, right-click the CommServe, click Control Panel, and select Shared Catalog Configuration.
  2. From the Shared catalog Configuration dialog box, click Delete to delete a Network Share Profile. A confirmation message is displayed. Click OK to delete the Network Share Profile.
  3. Click OK to save changes in the shared catalog Configuration and close the dialog box.

Edit a Network Share Profile

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To edit a network share profile:

  1. From the CommCell Browser, right-click the CommServe, click Control Panel, and select Shared Catalog Configuration.

    Alternatively, from the CommCell Browser, right-click the MediaAgent, and click Configure.

  2. From the Shared catalog Configuration dialog box, select the profile you wish to edit and click Edit. The Shared Catalog Configuration window is displayed.
  3. Change the name of the profile in the Profile Name box.
  4. You can change the following retention parameters:
  5. Click OK to save the configuration.

Set the Index Retention Criteria for Network Share Profiles

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To establish the index retention criteria for network share profiles:

  1. From the CommCell Browser, click the MediaAgents icon. All the MediaAgents available in the CommCell are displayed on the right-pane of the CommCell Browser.
  2. Right-click the MediaAgent whose index cache parameters you wish to modify, and then click Properties.
  3. Click the Catalog tab of MediaAgent Properties dialog box.
  4. You can change the following retention parameters:
  5. Click OK to save the configuration.

Move an Index Cache

Before You Begin

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To move an index cache:

  1. From the CommCell Browser, right-click the MediaAgent for which you wish to move the index cache and then click Properties.
  2. Click the Catalog tab.
  3. Provide details in the Index Cache area.

    For Windows MediaAgents:

    For Unix MediaAgents:

  4. Click OK to save the configuration.
  5. If the index is moved from a local drive to a network share, a Confirm prompt is displayed, asking you whether you wish to copy the index cache. Click one of the following:
  6. The index cache is moved to the new folder.

NOTES


Move a Shared Index Cache

Before You Begin

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To move a shared index cache:

  1. From the CommCell Browser, right-click any one of the MediaAgents that share the shared index cache and then click Properties.
  2. Click the Catalog tab.

    For Windows MediaAgents:

    For Unix MediaAgents:

  3. Click OK to save the configuration.
  4. Repeat the above steps on all the MediaAgents that share the index cache.  If this is not done, the index cache will be turned offline after 30 minutes, and all the jobs accessing the MediaAgents that share this index cache may fail as a result.

NOTES


Manually Relocate the Index Cache

The Index Cache can be moved from the CommCell Console, as described in Move an Index Cache. But in some situations it might be necessary to manually relocate the index cache. For example, if the index cache folder is too large, MediaAgent install folder needs to be moved, etc. Use the following procedure in such situations.

Before You Begin

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To manually relocate an index cache:

  1. Copy the Index Cache to the desired location.
  2. Navigate to this location and delete the icl_label.txt file.
  3. From the CommCell Browser, right-click the MediaAgent for which you wish to move the index cache and then click Properties.
  4. Click the Catalog tab.
  1. Provide details in the Index Cache area.

    For Windows MediaAgents:

    For Unix MediaAgents:

  1. Click OK to save the configuration.
  2. Click NO in the Confirm prompt.

    The index cache is relocated to the new folder.


Unshare a Shared Index Cache

Before You Begin

Required Capability: Capabilities and Permitted Actions

wedge.gif (136 bytes)To unshared a shared index cache:

  1. From the CommCell Browser, right-click the MediaAgent for which you wish to unshare the shared index cache and then click Properties.
  2. From the Catalog tab, uncheck the Catalog Profile option. The index cache is no longer shared.
  3. If you were using a Network Share, then you will have to provide a local path for the index cache. Perform one of the following:

    For Windows MediaAgents:

    For Unix MediaAgents:

  4. Click OK to save the configuration.

Intermediate Index Cache

You can use Intermediate Index Cache Directory when configuring Index Cache on a network share. With this option turned on the index is written to the local disk first and at commit points uploaded to the Network share. This will avoid failures due to network disruptions/failures writing to the index on the network share. This can be done for both Windows and Unix MediaAgents.

Windows MediaAgents

  1. In the CommCell browser, expand Storage Resources and then navigate to MediaAgents.
  2. Right-click the MediaAgent you wish to share and click Properties.
  3. From the MediaAgent Properties window click the Catalog tab.
  4. Select the Catalog Profile option and click Network Share.
  5. Select a Network Share profile from the list.
    All Network Share profiles created from the Shared Catalog Configuration window will be available for selection.
  6. Select Use Network Share and in the Index Cache Directory box, type the path to the index cache directory.

    You may alternatively use the Browse button to select the path.

  7. Click the Change button. In the Change User Account dialog box, type the user account and password that must be used to access the Index Cache and then click OK.
  8. Select Enable Intermediate Index Cache Directory and type the path to the index cache directory or use the Browse button to select the path.
  9. Click OK to save the configuration.

    The index cache is shared.

Unix MediaAgents

  1. In the CommCell browser, expand Storage Resources and then navigate to MediaAgents.
  2. Right-click the MediaAgent you wish to share and click Properties.
  3. From the MediaAgent Properties window click the Catalog tab.
  4. Select the Catalog Profile option and click Network Share.
  5. Select a Network Share profile from the list.
    All Network Share profiles created from the Shared Catalog Configuration window will be available for selection.
  6. Select Enable Intermediate Index Cache Directory and type the path to the index cache directory or use the Browse button to select the path.
  7. Click OK to save the configuration.

    The index cache is shared.