> CommCell Console > Backup and Restore Agents > Archive Agents > File Archiving > Advanced Archiving > Command Line Interface > Windows

Subclient Configuration

You can use the command line interface to create, modify and configure subclients and subclient properties.

Creating a Subclient

  1. Download the create_subclient_template.xml file and save it on the computer from where the command will be executed.

  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

     
    qoperation execute -af create_subclient_template.xml -appName 'File System' -clientName xxxxx -backupsetName xxxxx -subclientName xxxxx --enableOnePass true

Modifying a Subclient

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.

  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

     
    qoperation execute -af update_subclient_template.xml -appName 'File System' -clientName xxxxx -backupSetName xxxxx -subclientName xxxxx -contentOperationType xxxxx -content/path xxxxx

Getting Subclient Properties

  1. Download the get_subclient_template.xml file and save it on the computer from where the command will be executed.

  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values. 

     
    qoperation execute -af get_subclient_template.xml -appName 'File System' -clientName xxxxx -backupSetName xxxxx -subclientName xxxxx

Available Parameters for Subclient Configuration

The following table displays all the parameters you can use with the commands mentioned in the above sections. To add a parameter to your command, use the following syntax: (Some examples are provided at the end of the table.)

qoperation execute -af template XML file -parameter name value

Parameter

Description of Parameter Values

clientName

Name of the client computer.

turboNASClient/clientName

The option to set the proxy client for a NAS client. The proxy client is used for scan, backup, and stubbing operations.

Note: This parameter is used to assign the proxy client for OnePass for Hitachi NAS (VSP One File), OnePass for Celerra, and OnePass for NetApp.

backupsetName

Name of the backup set. If the backup set name is not specified in the command query, the default backup set is used by default.

appName

Name of the application. In this case it would be 'File System'.

subclientname

Name of the subclient.

enableOnePass

The option to enable OnePass.

Valid values are True/False.

enableArchivingWithRules

The option to enable archiving with archive rules. This parameter is available when the enableOnePass parameter is set to True.

Important: Once the enableArchivingWithRules parameter is set to True, the enableOnePass parameter cannot be set to False.

Valid values are True/False.

startCleaningIfLessThan

The option to archive files based on the percentage of available free space on the volume. To ignore this rule, enter 100. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are 0-100.

stopCleaningIfupto

The option to archive files based on the percentage of available free space on the volume. To ignore this rule, enter 100. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are 0-100.

fileAccessTimeOlderThan

The option to archive files whose access time is older than the number of days specified. To ignore this rule, enter 0. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are 0-1000.

fileModifiedTimeOlderThan

The option to archive files whose modified time is older than the number of days specified. To ignore this rule, enter 0. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are 0-1000.

fileCreatedTimeOlderThan

The option to archive files whose created time is older than the number of days specified. To ignore this rule, enter 0. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are 0-1000.

maximumFileSize

The option to archive files whose size is lesser than or equal to the kilobytes specified. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are numbers greater than 0.

fileSizeGreaterThan

The option to archive files whose size is greater than the kilobytes specified. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are any number greater than zero.

afterArchivingRule

The option to replace the archived file with a stub or delete the archived file. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are:

  • REPLACE_FILE_WITH_STUB

  • DELETE_THE_FILE

archiveReadOnlyFiles

The option to archive the read only files. This parameter is available when the enableArchivingWithRules parameter is set to True.

Valid values are True/False.

backupFilesQualifiedForArchive

The option to backup only the files that meet the archive rules.

Valid values are True/False.

useVSS

The option to enable/disable VSS (Volume Shadow Copy Service) to back up the file system data.

Valid values are True/False.

vssOptions

The option to use VSS for all files or for locked files only.

Valid values are:

  • USE_VSS_FOR_ALL_FILES, to use VSS snap for all files.

  • FOR_LOCKED_FILES_ONLY, to back up locked files.

useVSSForAllFilesOptions

The options to control what happens if the VSS snap fails because the VSS service is unavailable or it is unable to quiesce a volume. This parameter is available when the vssOptions parameter is set to USE_VSS_FOR_ALL_FILES.

  • FAIL_THE_JOB, to fail the backup job if VSS snap fails.

  • CONTINUE_AND_RESET_ACCESS_TIME, to reset access time of files when VSS snap fails. Select the Recursive scan method when you perform a backup.

  • CONTINUE_AND_DO_NOT_RESET_ACCESS_TIME, to not reset the access time of files when VSS snap fails.

catalogAdditional

The option to collect file and system data. The data is used in the Build-Your-Own Reports feature and the File Level Analytics Report.

Valid values are True/False.

catalogACL

The option to catalogue ACLs (Access Control Lists).

Valid values are True/False.

deletePSTFileOnly

The option to delete the protected PST (personal storage table) files.

Valid values are True/False.

scanOption

The method used to scan files before performing a backup.

Valid values are:

  • CHANGE_JOURNAL, to use NTFS change journal to determine which files in the subclient are modified

  • OPTIMAL_SCAN, to scan a large number of files and folders for the backup (the system maintains a separate database to track changes in the files)

  • RECURSIVE_SCAN, to scan FAT volumes, UNC paths and volumes with no drive letter

preserveFileAccessTime

The option to preserve the file access time at the time of backup. This option may increase the time required to complete a backup.

Valid values are True/False.

checkArchiveBit

The option to reset the archive bit of every file backed up during incremental and differential backups.

Valid values are True/False.

contentOperationType

The type of operation to perform on the subclient content. The content is defined in the content parameters.

Valid values are:

  • ADD, to add content to the subclient.

  • OVERWRITE, to overwrite content for the subclient. When you use OVERWRITE, you must define all of the content parameters you want to keep. For example, to update the subclient content and keep an existing exclusion defined for your content, you must use the following parameters in your command: 

     
    -contentOperationType OVERWRITE -content/path new_path_value -content/excludepath  existing_exclude_value

  • DELETE, to delete content from the subclient.

Examples

The following examples show how to add a parameter for a command:

Adding Content

To update the location for the subclient content, add the 'path' parameter to the following command:

qoperation execute -af update_subclient_template.xml -appName 'File System' -clientName client1 -backupSetName backupset1 -subclientName subclient1 -contentOperationType ADD -content/path 'c:temp'

Setting a Storage Policy

To assign a storage policy to a subclient, add the 'storagePolicyName' parameter to the following command:

qoperation execute -af update_subclient_template.xml -appName '$[File System]' -clientName client1 -backupSetName backupset1 -subclientName subclient1 -dataBackupStoragePolicy/storagePolicyName sp1
×

Loading...