Managing IBM i File System Subclients

Subclients contain information about what data is backed up. You can create a user-defined subclient to manage and back up specific data files.

Subclients can contain a combination of files and directories.

You can use wildcards to define the subclient content, exclusions, and exceptions.

For more information on the supported IBM i wildcards, see Supported Wildcards for IBM i File Systems.

You can create subclients for specific folders and files that frequently change or have a different backup schedule.

About This Task

The following subclient content options are available:

  • Commvault pre-defined content that consists of one or more of the following data:

    • Security objects

    • Configuration objects

    • IBM system libraries

    • User libraries

    • Documents, folders, and distribution objects

    • IBM directories and the user objects that are contained in the directories

  • User-defined content is a set of folders and directories that you define.

Before You Begin

  1. If you do not want to use the default backup set, create a backup set.

  2. Make sure that you have the following information:

    • The plan to assign to the subclient


      You can only assign a plan to a subclient when it is the only subclient in the backup set.

      Plans contain information about how often the software backs up the data and the storage library.

      For more information, see Plans.


  1. From the navigation pane, go to Protect > File Servers.

    The File Servers page appears.

  2. Click the IBM_i_server.

    The IBM_i_server page appears.

  3. Under Subclients, on the right of the page, click Add subclient.

    The Add subclient dialog box appears.

  4. In the Subclient name box, type the subclient name.

  5. In the Save while active section, complete the following steps:

    1. To determine whether a user can update an object while the object is being saved, in the Save while active box, select one of the following options:

      If you selected



      Select this option when you do not want to save the objects that are in use.


      Select this option when you need to save the objects in a library while they are used by another job. All of the objects reach a checkpoint at the same time and are saved in a consistent state in relationship to each other.


      This option is only available when you have custom subclient content that contains libraries.

      Select this option when you want to have all the objects and libraries that are part of the save operation reach a checkpoint together and be saved in a consistent state in relationship to each other.

      When you select this option, the software makes the Backup library content(s) as objects check box unavailable.

      Note: You cannot specify more than 32 libraries.

      When you synchronize a backup, the software:

      Starts the synchronization by using the "STRSAVSYNC" command

      Sends messages that are related to synchronization to the message queue (when this is selected)

      Runs a command after the synchronization completes (when this option is specified)

      Saves the objects and libraries that are part of the save operation when they reach a checkpoint together in a consistent state


      Select this option when you need to save the objects in a library while they are in use by another job. Objects in a library may reach checkpoints at different times and may not be in a consistent state in relationship to each other.

    2. To set the time that the backup operation waits for an object that is in use, or for transactions that have a pending change to reach a commit boundary before it continues the save operation, in the Save active wait time (seconds) box, type the number of seconds.

      If you selected


      *LIB or *SYSDFN

      Valid values: 0-99999


      Valid values: 0-99999

      The default is 600 seconds.

    3. Optional: To specify the message queue that the save operation uses to notify the user that the checkpoint process for a library is complete, in the Synchronization queue box, type the message queue.

      The format must be "<Library_Name>/Message_Queue>" (for example, QGPL/SYNCQ).

    4. Optional: To specify the command path that the software runs when the libraries that are in the subclient content reach the synchronized checkpoint, in the Command to be run when libraries are synchronized box, enter the command path.

      For example, "/QSYS.LIB/QGPL.LIB/SYNC.CMD".

  6. In the Backup Configuration section, perform one of the following steps to determine the plan or policies to use for the backup operations:

    • To use a server plan, enable the Use backup plan slider, and then select a server plan.


      To use a VTL library for data storage, select an IBM i VTL plan.

    • To use a storage policy and a schedule policy, disable the Use backup plan slider, select a storage policy and a schedule policy.

  7. In the Backup process settings section, enter the following information:

    • Pre-backup process: Enter the path to the batch file.

      For example, /QRCA.LIB/PREBACKUP.PGM.

    • Post-backup process: Enter the path to the batch file.

      For example, /QRCA.LIB/POSTBACKUP.PGM.

    For more information about pre-processes and post-processes, see Example: Creating a Pre- or Post-Process Script.

  8. Click Save.


The software adds the subclient and you can perform backup and restore operations on the subclient. If you assigned a plan to the subclient, the following operations happen:

  • The software automatically backs up the subclient according to the schedule plans

  • The software assigns the plan to the subclient's backup set