The following table displays all of the elements that you can use to configure SharePoint subclients from the command line interface. To add an element to your command, use the syntax:
qoperation execute -af <template XML file> -<parameter name> <value>
Parameter |
Description of Parameter Values |
clientName |
Name of the client computer. |
backupsetName |
Name of the SharePoint Server backup set. Valid values are:
|
appName |
Name of the application. In this case it is "SharePoint Server''. |
subclientname |
Name of the SharePoint Server subclient. |
newName |
New name of the subclient. |
enableBackup |
Option to enable backup of a subclient. Valid values are True/False. |
collectObjectListDuringBackup |
To enable or disable object list collection during backup. |
networkAgents |
Number of Network Agents. Valid range is 1 to 4. |
throttleNetworkBandwidth |
Enhancing backup performance by reducing network bandwidth overhead. Valid values are 0/1. |
encryptionFlag |
Option to set the encryption points during backups. Valid values are:
|
softwareCompression |
Option to enable compression on the Client or MediaAgent computer. Valid values are:
|
dataBackupStoragePolicy/storagePolicyName |
Name of the storage policy to be associated for backup. |
enableDeduplication |
Option to enable deduplication on a subclient. Valid values are True/False. |
generateSignature |
A component of deduplication performed on the client or MediaAgent computer. Valid values are:
|
useGlobalFilters |
Option to enable the use of global filters. Valid values are:
|
postBackupCommand |
Path to the post-process script that will be run after the backup. |
postScanCommand |
Path to the post-process script that will be run after the scan phase. |
preBackupCommand |
Path to the pre-process script that will be run before the backup. |
preScanCommand |
Path to the pre-process script that will be run before the scan phase. |
runPostBackup |
Option to run a process after backup completes. Valid values are Yes/No. |
runAs |
Option to specify the user name who has permissions to run the pre-process and post-process scripts. Valid values are:
|
content/path |
Location of the content to be backed up. This parameter must be used along with the 'contentOperationType' parameter, for example: -contentOperationType <value> -content/path '<path value>' Note the following:
|
content/excludepath |
Location of the content to be excluded from backup. This parameter must be used along with the 'contentOperationType' parameter, for example: -contentOperationType <value> -content/excludepath '<path value>' |
content/includepath |
Location of the content to be included in the backup from the excluded list. This parameter must be used along with the 'contentOperationType' parameter, for example: -contentOperationType <value> -content/includepath '<path value>' |
impersonateUser/userName |
User name of the account that has the required privileges to access the data on a network share when specifying UNC paths for the subclient content. |
impersonateUser/password |
Password of the account that has the required privileges to access the network share. This parameter must be used along with the 'impersonateUser/userName' parameter. |
contentOperationType |
The type of operation to perform on the subclient content. The content is defined in the content parameters. Valid values are:
|
Examples
The following examples show how to add a parameter for a command:
Set Exclude Filter |
qoperation execute –af modify_subclient_template.xml -appName "SharePoint Server" -clientName "xxxxx" -instanceName defaultInstance -backupsetName Documents -subclientName "xxxxx" -contentOperationType ADD -content/spExcludeFilterPath "xxxxx" |
Set Except Filter |
qoperation execute –af modify_subclient_template.xml -appName "SharePoint Server" -clientName "xxxxx" -instanceName defaultInstance -backupsetName Documents -subclientName "xxxxx" -contentOperationType ADD -content/spExceptFilterPath "xxxxx" |