Loading...

Elements Available for SharePoint Subclient Configuration from the Command Line Interface

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:

  • Documents
  • Databases
  • Site Collection

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:

  • ENC_MEDIA_ONLY, to encrypt the backup data after transmission and prior to storage on the media.
  • ENC_NETWORK_AND_MEDIA, to encrypt the backup data before transmission. The data is stored encrypted on the media.
  • ENC_NETWORK_ONLY, to encrypt the backup data for transmission and then decrypt the data prior to storage on the media.
  • ENC_NONE, to disable data encryption.

softwareCompression

Option to enable compression on the Client or MediaAgent computer.

Valid values are:

  • ON_CLIENT, to enable software compression on the client.
  • ON_MEDIAAGENT, to enable software compression on the MediaAgent.
  • OFF, to disable software compression.

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:

  • ON_CLIENT, to enable signature generation on the client.
  • ON_MEDIA_AGENT, to enable signature generation on the MediaAgent.
  • OFF, to disable signature generation.

    Note: Use this parameter when the enableDeduplication parameter is set to "true".

useGlobalFilters

Option to enable the use of global filters.

Valid values are:

  • ON, to enable global filters for the subclient.
  • USE_CELL_LEVEL_POLICY, to enable the use of global filters if the Use Global Filters on All Subclients option is enabled on the Control Panel (Global Filters) dialog. If the option is disabled, USE_CELL_LEVEL_POLICY will disable global filters for the subclient.
  • OFF, to disable global filters.

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:

  • USE_IMPERSONATION, to specify a user with enough privileges to run the scripts. When using this value, you also need to provide the user credentials:

    -prepostUserName/userName <user name> -prepostUserName/password <password>

  • USE_LOCAL_SYS_ADMIN, to use the administrator account to run the scripts.

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:

  • If you want to specify a wildcard to the content path, you must add '\/\/" (back and forward slash) at the end of the path to enable the detection of wildcard characters:

    -content/path 'datapath*\/\/'

  • If you are using a UNC path to specify the subclient content, you must also use the 'impersonateUser/userName' and 'impersonateUser/password' parameters to provide the credentials of a user account that has the required privileges to access the network share (where the content resides).

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:

  • 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:

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"

Last modified: 3/1/2018 7:59:49 PM