Loading...

Elements for Configuring the Exchange Database Agent Subclients

The following table lists all the elements that you can use to configure Exchange Database subclients using the command line interface. To add an element to your command, use the syntax:

qoperation execute -af <template XML file> -<parameter_name> <value>

Element

Description of the element value

clientName

Name of the client computer.

backupsetname

Name of the backup set.

appName

Name of the application. In this case it is Exchange Database.

subclientname

Name of the subclient.

enableBackup

Enables backup.

True | False

encryptionFlag

Sets the encryption points during backups.

  • ENC_MEDIA_ONLY

    Encrypts the backup data after transmission and prior to storage on the media.

  • ENC_NETWORK_AND_MEDIA

    Encrypts the backup data before transmission. The data is stored encrypted on the media.

  • ENC_NETWORK_ONLY

    Encrypts the backup data for transmission and then decrypt the data prior to storage on the media.

  • ENC_NONE

    Disables data encryption.

networkAgents

Number of network agents.

softwareCompression

Enables compression on the client or MediaAgent computer.

  • ON_CLIENT

    Enables software compression on the client.

  • ON_MEDIAAGENT

    Enables software compression on the MediaAgent.

  • OFF

    Disables software compression.

throttleNetworkBandwidth

The maximum network bandwidth per network agent (in MB per hour).

Range: 2 to 2147483647

applicableReadSize

The amount of application data that backup jobs will read for each unit that is transferred to the MediaAgent.

Valid kilobyte values are 64, 128, 256, 512, 1024, 2048, or 4096.

enableDeduplication

Enables deduplication on subclient.

True | False

generateSignature

A component of deduplication performed on the client or MediaAgent computer.

  • ON_CLIENT

    Enables signature generation on the client.

  • ON_MEDIA_AGENT

    Enables signature generation on the MediaAgent.

  • OFF

    Disables signature generation.

dataBackupStoragePolicy/storagePolicyName

Name of the associated storage policy backup.

postBackupCommand

Path to the post-process script that runs after the backup.

postScanCommand

Path to the post-process script that runs after the scan phase

preBackupCommand

Path to the pre-process script that runs before the backup.

preScanCommand

Path to the pre-process script that runs before the scan phase

runAs

Specifies the name of the user who has permissions to run the pre-process and post-process scripts.

  • USE_IMPERSONATION

    Specifies a user with sufficient privileges to run the scripts. When this value is used, you must also provide the user credentials.

-prepostUserName/userName <user_name> -prepostUserName/password <password>

  • USE_LOCAL_SYS_ADMIN

    Use the administrator account to run the scripts.

exchangeDBContent/storageGroup

Name of the storage group where the Exchange database to be backed up resides. This parameter must be used along with the exchangeDBContent/databaseName and contentOperationType parameter. For example:

-contentOperationType <value> -exchangeDBContent/storageGroup "group name" -exchangeDBContent/databaseName "database name"

exchangeDBContent/forceFull

Forces a full backup of the databases in the subclient.

True | False

This parameter must be used along with the contentOperationType parameter. For example:

-contentOperationType <value> -exchangeDBContent/forceFull <value>

contentOperationType

Modification type.

  • ADD

    Adds content to the subclient.

  • OVERWRITE
  • Overwrites contents in the subclient.
  • DELETE

    Deletes the contents from the subclient.

Examples

Task

Command

Add content

To update the location for the subclient content, use the following command:

qoperation execute -af update_subclient_add_template.xml -appName "Exchange Database" -clientName client1 -subclientName subclient1 -contentOperationType ADD -exchangeDBContent/storageGroup "Microsoft Information Store" -exchangeDBContent/databaseName "DB1"

Set a storage policy

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

qoperation execute -af update_subclient_add_template.xml -appName "Exchange Database" -clientName client1 -subclientName subclient1 -dataBackupStoragePolicy/storagePolicyName sp1

Last modified: 4/10/2018 8:43:41 PM