Loading...

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.

appName

Name of the application. In this case it would be NDMP.

subclientName

Name of the subclient.

enableBackup

Option to enable/disable backup.

Valid values are True/False.

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.

numberOfBackupStreams

Option to set the number of backup streams.

description

A general description of the subclient if needed.

networkAgents

Number of Network Agents.

dataBackupStoragePolicy/storagePolicyName

Name of the Storage Policy to be associated for backup.

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>'

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>'

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_add_template.xml -appName NDMP -clientName client1 -subclientName subclient1 -description 'add content' -contentOperationType ADD -content/path '/vol/vol1/vol123'

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_add_template.xml -appName NDMP -clientName client1 -subclientName subclient1 -storagePolicyName sp1

Last modified: 4/24/2019 6:12:09 PM