Advanced Configuration - Sybase iDataAgent

Table of Contents

Understanding the CommCell Console

The Sybase iDataAgent uses the following logical entities to manage backup and restore operations from the CommCell Console.

Agent

Facilitates the creation of Sybase Server instance.

Instance

Defines the Sybase Server to be backed up.

Subclient

Defines the Sybase databases to be backed up.

Managing the Sybase Server

In the CommCell Console each instance references a Sybase server. Hence it is necessary to create an instance for each Sybase Server to be backed up. You can manage your server/instance as described in the following sections:

Adding a New Sybase Server

Whenever a new Sybase Server is created on the client, you will add the Sybase Server to the CommCell using the following steps:

  1. From the CommCell Browser, navigate to Client Computers | <Client>.
  2. Right-click Sybase, point to All Tasks, and then click New Sybase Server.
  3. In the Server Name box type the Sybase server name.
  4. In the SA User Name box, type the Sybase administrator user name with the permissions to perform data protection, recovery and administrative operations.

    In the Account Password box, type the account password for the Sybase administrator user account.

    In the Confirm Password box, re-type the password.

  5. In the Sybase Home box, type the path to the directory where the Sybase application files reside. Alternatively, click Browse to select the location.
  6. In the Sybase ASE box, type the directory name where you installed Adaptive Server Enterprise (ASE) environment variable.

    You can view the path to the ASE directory in .env file residing in the Sybase home directory.

  7. In the Sybase OCS box, type the Sybase Open Client Server (OCS )environment variable.

    You can view this variable in sybase.env file residing in home directory.

  8. In the Configuration File box, type the path to the configuration file. Alternatively, click Browse to select the location.
  9. In the Shared Memory Directory box, type the location of the directory where you specify the shared memory file name. When you start an Adaptive Server, it creates a shared memory file that resides in the home directory. for example: /opt/sybase/ASE-15_0. Alternatively, click Browse to select the location.
  10. Specify a value in the Block Size box.
  11. In the Default Database Storage Policy box, select the storage policy.
  12. For Unix, in the User Name box, type the name of the user with read and write permissions to SnapProtect Software Installation Directory, client registry directory, Sybase software installation directories and Sybase database devices directories.

    Click OK.

    For Windows:

    In the User Name box, type the name of the local administrator with Sybase sysadmin role privileges in the following format:

    • Domain\user (if domain exists) or
    • Computer name\user” (where user is a local administrator).

    Type the password in the Account Password box and retype the password in Confirm Password box.

    Click OK.

  13. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  14. Right-click the <Instance>, and then click Properties.
  15. Select the Backup Server from the list.
  16. Click OK.

Changing the Sybase Home Directory

Sybase HOME directory refers to the location where the Sybase application resides. You can modify the home path location for an instance at any point of time. Use the following steps to change the Sybase HOME directory:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, and then click Properties
  3. In the Sybase Home box, type the path to the Sybase application. Alternatively, click Browse to select the location.
  4. Click OK.

Changing the Backup Server

If a backup server that is associated to a Sybase server instance reaches its maximum storage capacity even after compressing your earlier backups, you can change the backup server to enhance your backup and restore jobs.

Use the following steps to change the backup server:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, and then click Properties.
  3. From the Backup Server list, select the backup server name.
  4. Click OK.

Configuring the Environment Variables

By default, the Sybase ASE (Adaptive Server Enterprise) server library and Open Client Server (OCS )environment variable are located under the Sybase ASE server home directory. Use the following steps to configure Sybase environment variables:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, and then click Properties
  3. In the Sybase ASE box, type the Sybase ASE server directory.
  4. In the Sybase OCS box, type the Sybase OCS environment variable.
  5. Click OK.

Changing the Configuration File

Use the following steps to change the location of the configuration file:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, and then click Properties
  3. In the Configuration File box, type the path to the configuration file. Alternatively, click Browse to select the location.
  4. Click OK.

Changing the Shared Memory Directory

Sybase uses shared memory for inter process communication and caching the data. Use the following steps to change the location of the shared memory directory:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, and then click Properties
  3. In the Shared Memory Directory box, type the path to the Shared memory directory. Alternatively, click Browse to select the location.
  4. Click OK.

Changing the Block Size

By default, the block size is not specified in the dump command and will use the Sybase server's default block size. You can specify a block size (4096 X N), overriding the default block size. For example, if the Sybase server's default block size is 2k (2048), then you can specify the block size as (2048 x N).

Use the following steps to specify the block size (overriding the default block size) for Sybase backup:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, and then click Properties.
  3. In the Block Size box, specify the block size.
  4. Click OK.

Manually Creating a Master Database

When you restore an entire Sybase server or a master database, it is highly recommended to select Sybase create devices. However, you can also create a master database manually and then perform a restore without selecting Sybase create devices.

Use the following steps to manually create a master database:

  1. First, you need to shut down the Sybase server.

  2. Remove the old master database device and manually delete the master.dat from the database directory

  3. Execute the command to create the new master device with an empty password.

    Example:

    /sybase/syb1503/ASE-15_0/bin/dataserver -s S1503LNX -b200M -f -z 2048 -d /sybase/syb1503/data/master.dat -c /sybase/syb1503/ASE-15_0/S1503LNX.cfg

  4. Execute the command to alter the master database

    Example:

    alter database master on master="87M"

  5. Restart the Sybase server.

You can perform the Master Database Restore to verify that the master database is restored without a password.

Managing Subclients

When you create an instance, a default subclient is automatically created. The default subclient includes all the databases associated with that instance. If a new database is added to the instance, then that database is automatically assigned to the content of the default subclient. However, you can create user-defined subclients to backup individual or a group of databases.

Creating a User-Defined Subclient to Backup Specific Databases

If you want to back up groups of specific databases, you can do so by creating a user-defined subclient containing any number of databases that exist within the instance. This is useful if you want to back up a subset of databases at certain times or with a particular frequency.

If you want to divide your backups into smaller groups, you can do so by creating user-defined subclients using the following steps:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, point to All Tasks, and then click New Subclient.

  3. In the Subclient Name box, type the subclient name.
  4. Click the Content tab.
  5. Click Configure.
  6. Click Discover to discover the Sybase databases.
  7. Click the Subclient Name column adjacent to the existing databases, and then select the desired subclient from the drop-down list.

    Repeat this step to assign the available databases to the user-defined subclient.

  8. Click OK.

  9. Click the Storage Device tab.
  10. In the Storage Policy box, select the storage policy.
  11. Click OK.

Enabling and Disabling Automatic Discovery of Databases to the Default Subclient

When an automatic database discovery is enabled, all the existing Sybase databases are discovered automatically on the default subclient when a backup job is submitted. If any new databases are added after a previous backup, these newly added databases will be automatically discovered on the default subclient when a backup job is performed.

Use the following steps to enable automatic database discovery:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent.
  2. Right-click the <Instance>, and then click Properties.
  3. Select the Enable Auto Discovery check box.
  4. Click OK.

Manually Discovering Databases

Whenever a backup job is initiated, newly created Sybase databases are discovered automatically on the default subclient.  However, for a user-defined subclient, you need to  manually discover the databases prior to running any backup jobs. Use the following steps to manually discover the Sybase databases:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase iDataAgent | <Instance>.
  2. Right-click the desired <subclient> and then click Properties.
  1. Click the Content tab.
  2. Click Configure.
  3. Click Discover to discover the Sybase databases.
  4. Click the Subclient Name column adjacent to the desired database, and then select the desired subclient from the drop-down list.
  5. Click OK.

Configuring Sybase SQL Anywhere

Sybase's SQL Anywhere supports two types of backup:

  • Image Backup
  • Dump Backup

Image backup creates a copy of the database file and/or transaction log file. each of these database and transaction log files are created as separate files.

Dump database creates a SQL file that contains all the commands to rebuild the database.

You must install the SQL Anywhere client and server binaries on the client computer before configuring and performing SQL Anywhere backups and restores. However, you must use SnapProtect's file system iDataAgent to manage the subclients and perform backups and restores for Sybase's SQL Anywhere.

Configuring Image Backup

If you want to perform both data and log backups, then you must create two separate sub clients for database files and transaction log backups.

Creating a Subclient for Database Backup

Use the following steps to create a subclient for database backups:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System iDataAgent.
  2. Right-click the <BackupSet>, point to All Tasks, and then click New Subclient.

  3. In the Subclient Name box, type the subclient name.

  4. Click the Storage Device tab.
  5. In the Storage Policy box, select the storage policy.
  6. Click the Pre/Post Process tab.
  7. Click Browse to locate the data directory path and add the script for database backup.

    The script should contain the dbbackup command. This command should include the data backup directory path to backup database files as a pre-scan process.

  8. Click the Content tab.
  9. Click Add Paths.
  10. Add the local path for data backups and click OK.

  11. Click OK to create a subclient for data backup. Perform FULL backups of this subclient at periodic intervals.

The Database backup script for UNIX and Windows based file systems will be as follows:

dbbackup -d -y -o <log output file>  -c "<connect string>" <backup-directory>

where

-d : Performs database and user defined dbspace file backup. The transaction file will not be included.

-y : Creates the backup directory or replaces a previous backup file in the directory without confirmation. If you want to be prompted when an attempt is made to overwrite an existing file, do not specify -s or -y.

Example (UNIX)

dbbackup -d -y -o /temp/SqlAnywhereBackup.log -c "eng=demo11;dbn=mydb;uid=dba;pwd=sql;LINKS=ALL" /dataBackup/full

Example (Windows)

dbbackup -d -y -o c:\temp\SqlAnywhereBackup.log -c "eng=demo11;dbn=mydb;uid=dba;pwd=sql;LINKS=ALL" d:\dataBackup

Creating a Subclient for Log Backup

Use the following steps to create a subclient for log backups:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System iDataAgent.
  2. Right-click the <BackupSet>, point to All Tasks, and then click New Subclient.

  3. In the Subclient Name box, type the subclient name.

  1. Click the Storage Device tab.
  2. In the Storage Policy box, select the storage policy.
  3. Click the Pre/Post Process tab.
  4. Click Browse to locate the log directory path and add the script for log backup.

    The script should contain the dbbackup command. This command should include the log backup directory path to backup the transaction log files as a pre-scan process.

  5. Click the Content tab.
  6. Click Add Paths.
  7. Add the local path for log backups and click OK.

  8. Click OK to create a subclient for log backup. Perform Incremental backups for this subclient at periodic intervals as the system will pick up only the recent transaction log copies generated in the log backup directory.

The log backup script for UNIX and Windows based file systems will be as follows:

dbbackup -d -y -o <log output file>  -c "<connect string>" -r -t -n < log-backup-directory>

where

-t  : Backup transaction log.

-r : Rename and restart the transaction log.

-n : Rename local backup of transaction log to match server.

-x : Delete/truncate the transaction log

-y : Creates the backup directory or replaces a previous backup file in the directory without confirmation. If you want to be prompted when an attempt is made to overwrite an existing file, do not specify -s or -y.

Example (UNIX)

dbbackup -d -y -o /temp/SqlAnywhereBackup.log -c "eng=demo11;dbn=mydb;uid=dba;pwd=sql;LINKS=ALL" -r -t -n /databackup/logBackup

Example (Windows)

dbbackup -d -y -o c:\temp\SqlAnywhereBackup.log -c "eng=demo11;dbn=mydb;uid=dba;pwd=sql;LINKS=ALL" -r -t -n d:\logBackup

Configuring Dump Backup

Use the following steps to create a subclient for dump backups:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System iDataAgent.
  2. Right-click the <BackupSet>, point to All Tasks, and then click New Subclient.

  3. In the Subclient Name box, type the subclient name.

  4. Click the Storage Device tab.
  5. In the Storage Policy box, select the storage policy.
  6. Click the Pre/Post Process tab.
  7. Click Browse to locate the dump directory path and add the script for dump backup.

    The script should contain the dbunload command. Use the dbunload utility to obtain the SQL dump of the database, which can be used to rebuild the database. The dbunload command should include the output dump directory as a pre-scan process.

  8. Click the Content tab.
  9. Click Add Paths.
  10. Add the path for the reload SQL file and dump data directory to the sub-client content and click OK.

  11. Click OK to create a subclient for dump backup. Perform the backups of this subclient at periodic intervals.

The dump backup script for UNIX and Windows based file systems will be as follows:

dbunload -c "Connect-String" -r <dump-file-name> <directory-to-dump-data>

where

-r :  Name of the generated reload ISQL command file (default "reload.sql")

Example (UNIX)

dbunload -y -c "eng=demo11;dbn=mydb;uid=dba;pwd=sql;LINKS=ALL" -r /temp/myDBReload.sql /temp/dataDump

Example (Windows)

dbunload -y -c "eng=demo11;dbn=mydb;uid=dba;pwd=sql;LINKS=ALL" -r d:\myDBReload.sql D:\dataDump

Configuring User Accounts for Backups

The Sybase iDataAgent requires two user accounts to access the Sybase application and database to perform backup and restore operations:

  • Database user account with administrator privileges.

    On Unix computers, the account information for accessing the database is provided during the Sybase iDataAgent installation.

    On Windows computers, the account information is provided during the instance configuration after the installation of the Agent.

  • Operating system account with privileges to access the Sybase application.

The following table illustrates the required user account privileges for backup and restore operations:

Operations User Account Needed
Create Sybase server Sybase database administrator account (SA role)
Backup Sybase database and Restore non-system databases Operating system user account (operator role) with access to all the databases in an instance.
Restore Sybase system databases Sybase database administrator account (SA role)

Use the following steps to change the user account for accessing the Sybase instance:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Sybase.
  2. Right-click the <Instance> and click Properties.
  3. Click the Accounts tab.
  4. Type the user name in the User Name box.
  5. Type the SA user name in the SA User Name box.
  6. Type the password in the SA Account Password box and retype it in the SA Confirm Password box.
  7. Click OK.

At the Client Computer Group Level

This user account will be used for all computers within a Client Computer Group. Configure the user account at this level if different users will be conducting backup and restore operations for each Client Computer Group in your organization. This user account will override the user account configured at the CommCell level.

  1. From the CommCell Browser, navigate to the Client Computer Groups node.
  2. Verify that all the Agent clients for which you wish to configure the user account are included in the Client Computer Groups.
  3. Right-click the <Client Group> and click Properties.
  4. Click the Advanced Settings tab.
  5. Click the Override higher levels settings check box.
  6. Select one of the following:
    • Use Local System Account, if the computer's Administrator account contains the required privileges.
    • Impersonate User, if you want to use a different account that contains the required privileges. Type the User Name and Password for this account in the space provided.
  7. Click OK.

The user credentials provided at the client computer group level are ignored if the client belongs to more than one group. In this case, provide the user credentials at the instance level.

Configuring Streams for Backups

During a backup operation, the SnapProtect software sends the backup data in two parallel streams by default. The parallel streams reduce the backup time by half when compared with the backup time with one data stream.

You can increase the number of streams for backing up a subclient. For example, if you increase the number of streams from two to three, then the backup time reduces from half to one-third.

Note: The number of streams used to back up a subclient are equal to the number of streams used to restore the subclient.

If you perform a restore operation from a secondary copy that has the combined stream option enabled, the restored data is temporarily staged in the Job Results folder before it is restored to the Sybase database. You can change the location of the staging folder by changing the value of additional setting sStageFolderAuxCopyRestore.

Procedure

  1. In the CommCell Browser, expand Client Computers > client > Sybase > instance.
  2. Right-click the subclient and then click Properties.

    The Subclient Properties dialog box is displayed.

  3. On the Storage Device tab:
    1. Click the Data Storage Policy tab.
    2. In the Number of Data Backup Streams box, type the number of streams to use when you perform a backup.

      Note: The number of streams cannot be greater than the number that is configured for the subclient storage policy (.Storage Policy Properties dialog box,  General tab, Device Streams box).

  4. Click OK.

Configuring Sybase ASE Cluster for a Single Node

You need to specify the path of the Quorum device which is usually a raw device to backup Sybase ASE cluster for a single node.

For example, if Sybase instance name is asece1 and the raw device path is /dev/sdb1, then you need to specify the registry key as follows under Sybase Agent:

asece1_QuorumDevice /dev/sdb1

Use the following steps to detect and configure the path of the Quorum device for the Sybase instance:

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> to be configured and then click Properties.
  3. Click Advanced.
  4. Click the Additional Settings tab and then click Add.
  5. In the Name field, type <Sybase Instance Name>_QuorumDevice and click Lookup.
  6. In the Value field, type the path of the Quorum device.
  7. Click OK.

Modifying an Agent, Instance, or Subclient

There are several configurable properties available for your agent that can be modified from the agent, instance, or subclient level as per need.

It is recommended that that you do not modify the properties of a subclient when a job is in progress for that specific subclient. If a job is in progress, either wait for the job to complete or kill the job from the Job Controller.

The following table describes the properties that can configured from the agent, instance, and subclient levels.

Option Description Related Topics
Change Storage Policies You can modify the storage policies in any of the following situations:
  • To include a different media for the backup operation.
  • To use a storage policy with a different retention criteria.

You can change the storage policies from the subclient level.

  1. From the CommCell Browser, right-click the subclient.
  2. Click Properties.
  3. Click Storage Device.
  4. Select the Storage policy from the drop-down menu.
  5. Click OK.
Refer to Storage Policies.
Rename a Subclient

You can rename a subclient:

  1. From the CommCell Browser, right-click the subclient.
  2. Click Properties.
  3. Type the new name in the  Subclient name field.
  4. Click OK.
 
Data Transfer Options You can configure the available resources for transferring data secured by data protection operations from the subclient level. This includes the following:
  • Enable or disable Data Compression either on the client or on the MediaAgent.
  • Configure the transfer of data in the network using the options for Network Bandwidth Throttling and Network Agents.

You can configure the data transfer options.

  1. From the CommCell Browser, right-click the subclient.
  2. Click Properties.
  3. Click Storage Device.
  4. Click Data Transfer Option tab.
  5. Choose the appropriate software compression option for this subclient.
  6. Select Throttle Network Bandwidth and set the required bandwidth.
  7. Click OK.
Refer to Data Compression and Network Bandwidth Throttling.
View Data Paths You can view the data paths associated with the primary storage policy copy of the selected storage policy or incremental storage policy. You can also modify the data paths including their priority from the subclient level.
  1. From the CommCell browser, right-click the subclient.
  2. Click Properties.
  3. Click Storage Device.
  4. Select Storage Policy from the drop-down menu.
  5. Click Data Paths.
 
Configure a Subclient for Pre and Post Processing of Data Protection You can add, modify or view Pre/Post processes for the subclient. These are batch files or shell scripts that you can run before or after certain job phases.
  1. From the CommCell browser, right-click the subclient.
  2. Click Properties.
  3. Click Pre/Post Process.
  4. Click one of the following phases and type the full path of the process that you want to execute during that phase. Alternatively, click Browse to locate the process (applicable only for paths that do not contain any spaces).
    • Pre-Backup Process
    • Post-Backup Process
  5. Click OK.
  6. Select Run Post Backup Process for all attempts to run a post backup process for all attempts.
  7. For subclients on Windows platforms, Run As displays Not Selected.

    If you want to change the account that has permission to run these commands, click Change.

    1. In the User Account dialog box, select Use Local System Account, or select Impersonate User and enter the user name and password. click OK.
    2. If you selected Local System Account, click OK to the message advising you that commands using this account have rights to access all data on the client computer.
Refer to Pre/Post Processes.
Configure Activity Control You can enable backup and restore operations from the agent and subclient level. However, you can enable restore operations only from the agent level.
  1. From the CommCell browser, right-click the subclient.
  2. Click Properties.
  3. Click Activity Control, select or clear option(s) as desired.
  4. Click OK.
Refer to Activity Control.
Enable and Disable Data Encryption When you configure encryption at the client level, it is configured automatically for all the subclients associated with all the agents installed on that client. If you want to disable or change the encryption at the subclient level, follow the steps given below:
  1. From the CommCell browser, right-click the subclient.
  2. Click Properties.
  3. Click Encryption.
  4. Select the desired encryption.
  5. Click OK.
Refer to Data Encryption.
View Software Version and Installed Updates At the client level, the Version tab of the Properties dialog box displays the software version of the component.
  1. From the CommCell Browser, expand Client Computers.
  2. Right-click the appropriate client, and then click Properties.
  3. Select the Version tab.
  4. Click OK.
 
CommCell Configuration Report The CommCell Configuration Report provides the properties of the CommServe, MediaAgents, clients, agents, subclients, and storage policies within the CommCell based on the selected filter criteria.
  1. From the CommCell browser, click Reports icon.
  2. Select CommCell Configuration.
  3. Click Run.
Refer to CommCell Configuration.

Deleting an Agent, Instance, or Subclient

The following sections describe the steps involved in deleting an agent, instance, or subclient.

When you delete an instance or backupset, the associated data is logically deleted and you can no longer access the corresponding data from CommCell Console for recovery purposes.

Refer to the troubleshooting article on Recovering Data Associated with Deleted Clients and Storage Policies for information on how to recover data if you accidentally delete an entity.

Deleting an Agent

You need to uninstall or DeConfigure the agent software from the client computer before deleting from CommCell Browser. After you delete the client software, you can either leave the corresponding data intact for appropriate action or you can remove the data immediately. If you choose to remove the data immediately, you must delete the agent from the CommCell Browser. If you delete the agent, all of the agent's data is irretrievably lost.

  • You cannot delete an agent while operations for that agent are running.
  1. From the CommCell Browser, navigate to Client Computers | <Client>.
  2. Right-click the <Agent>, and then click Delete.
  3. A confirmation message is displayed with the following message:

    This operation will permanently delete the data backed up from this level and it cannot be restored.

  4. Click OK to continue with the deletion operation or click No to abort the deletion.

Deleting an Instance

Consider the following before deleting an instance:

  • When you delete a specific instance all job schedules and job histories that pertain to any of the levels within the deleted instance are deleted.
  • You cannot delete an instance if it is being backed up. Attempts to delete an instance under such conditions cause the deletion to fail. If a backup is in progress, either wait for the backup to complete or kill the backup job using the Job Manager. Once the backup is no longer in progress, you can delete the instance level.
  • You cannot delete an instance if there is only one instance present for an agent. To delete the final instance, you must remove the agent software from the client computer.
  1. From the CommCell Browser, navigate to Client Computers | <Client> | <Agent>
  2. Right-click the <Instance> that you want to delete, point to All Tasks and then click Delete.
  3. Click Yes to confirm the deletion. (Clicking No cancels the deletion and retains the node.)
  4. Type the requested phrase in the Enter Confirmation Text dialog box and click OK. This should delete the instance.

Deleting a Subclient

Consider the following before deleting a subclient:

  • You cannot delete a default subclient.
  • Schedules associated with the subclient are also automatically deleted.
  1. From the CommCell Browser, navigate to Client Computers | <Client> | <Agent> | <Instance>.
  2. Right-click the <Subclient> that you want to delete, and then click Delete.
  3. A confirmation message is displayed, asking if you want to delete the subclient.

    Click No to cancel the deletion and retain the subclient, or click Yes to continue the deletion.