Command Line - Configuration - Image Level iDataAgent

  • This product is deprecated for AIX and Linux. New installations of the Image Level Agent are no longer supported in V10, but the agent will continue to function normally. Upgrade to the latest service pack in V10 is supported. You cannot use your installed version of the Image Level Agent to perform backups in the next version of SnapProtect.
  • This functionality is now available using Block-Level Backup. We recommend that you begin backing up data by using the block-level backup method instead of using the Image Level Agent as soon as you are able to. No new license is required for Block-Level Backup. For instructions on transitioning to block-level backups, see Transitioning from Image Level Agent to Block-Level Backups.

See Deprecated Features, Products, and Platforms for comprehensive information on deprecated products.

Table of Contents

Log On to the CommServe

To run command line operations, you must first login to the CommServe.

From Command prompt, navigate to <Software_Installation_Directory>/Base and run the following command:

qlogin -cs <commserve name> -u <user name>

For example, to log on to CommServe 'server1' with username 'user1':

qlogin -cs server1 -u user1

Subclient Configuration

Creating a Subclient

  1. Download the create_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af create_subclient_template.xml -appName 'Image Level on Unix' -clientName xxxxx -backupsetName defaultBackupSet -subclientName xxxxx -storagePolicyName xxxxx -contentOperationType ADD -content/path 'xxxxx'

Modifying Subclient

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -appName 'Image Level on Unix' -clientName xxxxx -backupSetName defaultBackupSet -subclientName xxxxx -contentOperationType ADD -content/path 'xxxxx'

Deleting Subclient

  1. Download the delete_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af delete_subclient_template.xml -appName 'Image Level on Unix' -clientName xxxxx -backupSetName defaultBackupSet -subclientName xxxxx

Getting Subclient Properties

  1. Download the get_subclient_properties_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af get_subclient_properties_template.xml -appName 'Image Level on Unix' -clientName xxxxx -backupSetName defaultBackupSet -subclientName xxxxx

Available Command Attributes for Subclients

The following table displays all the attributes you can use with the commands mentioned in the above sections. To add an attribute to your command, use the following syntax: (Some examples are provided at the end of the table.)

qoperation execute -af <template XML file> -<attribute name> <value>

Attribute Description
clientName Name of the client computer.
backupsetname Name of the backup set. For the Image Level agent, the backup set is always 'defaultBackupSet'.
appName Name of the application. In this case it would be 'Image Level on Unix'.
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.
networkAgents Number of Network Agents.
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.
throttleNetworkBandwidth The maximum network bandwidth per network agent (in MB per hour).

Valid values are 2-2147483647.

enableDeduplication Option to enable deduplication on 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.
storagePolicyName Name of the Storage Policy to be associated for backup.
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.
useVSS Option to enable/disable VSS for backing up the file system data.

Valid values are True/False.

useVSSForSystemState Option to enable/disable VSS for backing up the system state.

Valid values are True/False.

backupSystemState Option to enable/disable back up of the system state.

Valid values are True/False.

backupSystemStateforFullBkpOnly The option to backup the system state only during full backups. This parameter is available when backupSystemState is set to True.

Valid values are True/False.

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
runAs Option to specify the user name who has permissions to run the pre/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 attribute must be used along with the contentOperationType attribute, for example:

-contentOperationType <value> -content/path '<path value>'

content/excludepath Location of the content to be excluded from backup. This attribute must be used along with the contentOperationType attribute, 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 attribute must be used along with the contentOperationType attribute, for example:

-contentOperationType <value> -content/includepath '<path value>'

contentOperationType Modification type. Valid values are
  • ADD, to add content to the subclient
  • OVERWRITE, to overwrite contents to the subclient.
  • DELETE, to delete the contents from the subclient.

Examples

The following examples show how to add an attribute for a command:

Adding Content To update the location for the subclient content, add the 'path' attribute to the following command:

qoperation execute -af update_subclient_template.xml -appName 'Image Level on Unix' -clientName client1 -backupSetName defaultBackupSet -subclientName SN -contentOperationType ADD -content/path '/etc'

Setting a Storage Policy To assign a storage policy to a subclient, add the 'storagePolicyName' attribute to the following command:

qoperation execute -af update_subclient_template.xml -appName 'Image Level on Unix' -clientName client1 -backupSetName defaultBackupSet -subclientName SN -storagePolicyName SP

Log Off from the CommServe

Once you have completed the command line operations, you can logout from the CommServe using the following command:

qlogout -cs commserve

For example, to log out from the CommServe 'Server1'.

qlogout -cs Server1