Custom Verification Scripts

In this article

    Veeam Backup & Replication can verify VMs with the following custom verification scripts:

    Microsoft SQL Server Checker Script

    If you need to verify a virtualized Microsoft SQL Server, you can instruct Veeam Backup & Replication to run the Microsoft SQL Server Checker script against it during the SureBackup job. The script sequentially performs the following operations:

    1. Connects to Microsoft SQL Server instances.
    2. Enumerates databases on these instances.
    3. Employs the USE SQL statement to connect to databases and check their availability.

    The script is located on the backup server in the Veeam Backup & Replication product folder. The path by default: C:\Program Files\Veeam\Backup and Replication\Backup\Veeam.Backup.SqlChecker.vbs.

    Credentials for Script Execution

    To execute the script, Veeam Backup & Replication connects to Microsoft SQL Server. By default, Veeam Backup & Replication uses the account under which the Veeam Backup Service is running. If you need to run the script under another account, you can specify credentials for this account. The script supports Microsoft Windows and SQL Server authentication methods.

    For the Microsoft Windows authentication mode, you can specify credentials for the account on the Credentials tab in the application group or SureBackup job settings.

    For the SQL Server authentication mode, you must pass credentials of the account as arguments to the script. You can do it using the command line interface or the UI.

    To pass credentials using the command line, run the script from the command line with the following parameters:

    cscript Veeam.Backup.SqlChecker.vbs [logs folder] <sql server[\instance]> <username> <password>

    To pass credentials using the UI:

    1. In the application group or SureBackup job settings, select to use a custom script.
    2. Specify a path to the Microsoft SQL Server Checker script. Paths by default: C:\Program Files\Veeam\Backup and Replication\Backup\Veeam.Backup.SqlChecker.vbs.
    3. Specify the user name and password in the Arguments field.

    Custom Verification Scripts 

    Important

    If you use the Microsoft SQL Server authentication mode, you may need to specify credentials of the account to connect to the machine on which Microsoft SQL Server is installed. To do this, use the Credentials tab in the application group or SureBackup job settings.

    Database Exclusion

    By default, Veeam Backup & Replication verifies all databases on all instances of Microsoft SQL Server. However, you can exclude specific databases from verification. For example, vCenter Server database. To exclude an instance or a database, you must open the script in the text editor and edit the Settings section in the following way:

    gDBsToExclude.Push "dbname1"

    gDBsToExclude.Push "dbname2"

    gInstancesToExclude.Push "instancename1"

    gInstancesToExclude.Push "instancename2"

    Important

    Instance and database names are case sensitive.

    Logging

    To define whether the script has completed successfully or not, Veeam Backup & Replication publishes the following return codes in the SureBackup job session statistics:

    Results of script execution are written to the log file located by the following path: %programdata%\Veeam\Backup\<name of the job>\<VM name>_SQLChecker.log. If necessary, you can change the log file location. To do this, pass a new path to the log file in the %log_path% argument in the application group or SureBackup job settings.

    Custom Verification Scripts 

    Backup File Validation

    In addition to recovery verification tests, Veeam Backup & Replication allows you to perform backup file validation. For backup file validation, Veeam Backup & Replication performs a CRC check for backup files of VMs verified by the SureBackup job. You can also validate backup files for VMs from the application group with this test.

    To validate the backup file, Veeam Backup & Replication uses the checksum algorithm. When Veeam Backup & Replication creates a backup file for a VM, it calculates a checksum for every data block in the backup file and stores this data in the backup file, together with VM data. During the backup file validation test, Veeam Backup & Replication decompresses the backup file, recalculates checksums for data blocks in the decompressed backup file and compares them with initial checksum values. If the results match, the test is passed.

    The backup file validation test is started after recovery verification tests. As soon as Veeam Backup & Replication completes all "live" verification for all VMs in the SureBackup job, it unpublishes VMs and starts the backup file validation test.

    The result of the backup file validation test impacts the state of the SureBackup job session. If the verification tests are completed successfully but the backup validation is not passed, Veeam Backup & Replication marks the SureBackup job session with the Failed status.

    Custom Verification Scripts