Skip to main content

Article ID

5053

Product Version

AhsayCBS: 7.17 or above

Operating System

All platforms

Description

After upgrading the backup server from version 6 to 9, how can one perform a Cyclic Redundancy Check (CRC) for legacy backup sets created in version 6 for backup clients installed on operating systems with or without a Graphical User Interface (GUI)?

Solution

To perform a Cyclic Redundancy Check (CRC) for a backup set, you can use the RunSingleUserRebuild.do API with the "CheckCrc" option enabled:

This article assumes that the reader has basic knowledge on JSON (JavaScript Object Notation).

Parameters of RunSingleUserRebuild.do

KeyTypeDescription
SysUserStringUsername of AhsayCBS system account with Admin or API Role
SysPwdStringPassword of AhsayCBS system account with Admin or API Role
LoginNameStringUsername of the correpsonding backup account
OwnerStringOwner of the corresponding backup account
BackupSetIDStringBackup set ID of the corresponding backup set to be rebuilt
CheckCRCBooleanEnable or disable Cyclic Redundancy Check
All Keys that are in bold are considered mandatory fields.

For example, your API call:

API URL: https://yourCBShostname.example.com/obs/api/json/RunSingleUserRebuild.do

{
	"SysUser":"system",
    "SysPwd":"system1",
	"LoginName":"acb",
	"BackupSetID":"1716451390565",
	"CheckCrc":"Y"
}

Administrators can use applications such as Postman (this is a 3rd party tool used as an example, you can use any other application as desired) to test the above API call.

  1. Start your chosen tool.
  2. Ensure that the HTTP method is set to POST.

    post

  3. Select the Body tab, then select raw amongst the options beneath it. In the drop down menu at the far end of the field, select JSON.

    options

  4. For the URL field, enter the following:

    https://yourCBShotname.example.com/obs/api/json/RunSingleUserRebuild.do

    Where cbs_hostname is the hostname or IP address of your AhsayCBS server.

  5. For the String body, enter the following:

    {
    		"SysUser":"system",
    		"SysPwd":"system1",
    		"LoginName":"acb",
    		"BackupSetID":"1716451390565",
    		"CheckCrc":"Y"
    	}
    	

    Where the 'system' and 'system1' is the login credentials of an AhsayCBS admin account with Admin or API role, 'acb' is the login name of the correpsonding backup account, '1716451390565' is the ID of the backup set to be rebuilt, with CRC enabled.

  6. Click on the SEND button beside the URL.

    send

The RunSingleUserRebuild.do will return status as 'OK' if the CRD job is started successfully. Now, to check on the progress of a CRC job, login to the AhsayCBS console, select Backup / Restore Logs:

logs

Select Activities Log, when the rebuild job is started the following log entry can be found:

activities

When the rebuild job is completed, the following log entry can be found:

complete

Note that a Cyclic Redundancy Check can only be started when there is no backup job running (of the corresponding backup set).

The time taken to complete the CRC job depends on number of factors such as the number of files / folders in the backup set(s), the number of backup sets, the hardware specifications of your AhsayCBS server such as the disk I/O and CPU performance, and if there are other resource intensive jobs running.