Creating a Subclient
-
Download the create_subclient_template.xml file and save it on the computer from where the command will be executed.
-
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
-
Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
-
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 -enableOnePass true -enableArchivingWithRules true -fileSizeGreaterThan xxxxx
Getting Subclient Properties
-
Download the get_subclient_template.xml file and save it on the computer from where the command will be executed.
-
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
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 valueNote
The default retention setting for user or archived deleted files is set to Immediately when you enable OnePass from command line.
|
Parameter |
Description and Parameter Values |
|
clientName |
The name of the client. |
|
backupsetName |
The name of the backup set. If the backup set name is not specified, the default backup set is used. |
|
appName |
The name of the application. In this case it would be 'File System'. |
|
subclientname |
The 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. Parameters under the <diskCleanupRules> element are available when enableArchivingWithRules is set to True. Note 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 stop archiving files based on the percentage of available free space on the volume. To ignore this rule, enter 100. 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. 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. 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. Valid values are 0-1000. |
|
fileSizeGreaterThan |
The option to archive files whose size is greater than the kilobytes specified. To ignore this rule, enter 0. Valid values are numbers greater than zero. |
|
maximumFileSize |
The option to archive files whose size is lesser than or equal to the kilobytes specified. To ignore this rule, enter 0. Valid values are numbers greater than 0. |
|
afterArchivingRule |
The option to replace the archived file with a stub or to delete the archived file. Valid values are:
|
|
archiveReadOnlyFiles |
The option to archive the read only files. Valid values are True/False. |
|
backupFilesQualifiedForArchive |
The option to back up only the files that meet the archive rules. Valid values are True/False. |
|
useNativeSnapshotToPreserveFileAccessTime |
The option to use a native snapshot to preserve the file access time. Valid values are True/False. |
|
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:
|
|
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. |
Examples
The following examples show how to add a parameter for a command:
|
Setting the File size greater than n KB Archiving Rule |
To archive files with file size greater than a specified value, add the 'fileSizeGreaterThan' parameter to the following command:
|
|
Setting the File access time older than n days Archiving Rule |
To archive files which have not been modified for a specified number days, add the 'fileAccessTimeOlderThan' parameter to the following command:
|