#1 Global Leader in Data Resilience

How to Create a Custom SureBackup Test Script

KB ID: 1312
Product: Veeam Backup & Replication | 9.5 | 10 | 11 | 12 | 12.1 | 12.2 | 12.3 | 12.3.1
Published: 2011-10-24
Last Modified: 2022-03-09
mailbox
Get weekly article updates
By subscribing, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.

Cheers for trusting us with the spot in your mailbox!

Now you’re less likely to miss what’s been brewing in our knowledge base with this weekly digest

error icon

Oops! Something went wrong.

Please, try again later.

Purpose

This article provides information about creating custom SureBackup roles and scripts which can be used to enhance SureBackup testing.

Solution

Information regarding custom SureBackup roles can be found here:
https://helpcenter.veeam.com/docs/backup/vsphere/creating_xml_files.html

Information regarding custom Test Scripts can be found here:
https://helpcenter.veeam.com/docs/backup/vsphere/surebackup_job_tests_vm.html#test-script-settings

There are two locations where a test script can be defined:


 

Example of Testing Port 22

The following is a quick guide on creating a simple port test using the Veeam.Backup.ConnectionTester.exe included with Veeam Backup & Replication. In the example below, a test will be created to determine if port 22 is listening on VM that is being verified with SureBackup.

 

  1. On the Test Scripts tab, click [Add...]
Add test script button screenshot
  1. In the Test Scripts window, enter a name for the Test Script, then click [Browse...]
Test Scripts window name field and browse button
  1. Using the Select Script File window expand folders and locate the Veeam.Backup.ConnectionTester.exe.

    By default, this executable will be located in:
    C:\Program Files\Veeam\Backup and Replication\Backup\
Select a file window with Veeam.Backup.ConnectionTester.exe selected
  1. In the Arguments field, the variable %vm_ip% is used to represent the IP address of the VM that is being tested.

    The Veeam.Backup.ConnectionTester.exe is expecting the IP address of the target machine followed by the port number to test. So, for the argument field, %vm_ip% 22 will be entered.
Arguments field on test scripts tab
  1. Click [OK] to complete and add the test script to the Verification Options.
To submit feedback regarding this article, please click this link: Send Article Feedback
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.

Spelling error in text

Thank you!

Thank you!

Your feedback has been received and will be reviewed.

Oops! Something went wrong.

Please, try again later.

You have selected too large block!

Please try select less.

KB Feedback/Suggestion

This form is only for KB Feedback/Suggestions, if you need help with the software open a support case

Veeam Backup & Replication
Veeam Data Cloud for Microsoft 365
Veeam Data Cloud for Microsoft Entra ID
Veeam Data Cloud for Salesforce
Veeam Data Cloud for Microsoft Azure
Veeam Data Cloud Vault
Veeam Backup for Microsoft 365
Veeam Backup for Microsoft Entra ID
Veeam Backup for Salesforce
Veeam ONE
Veeam Service Provider Console
Veeam Agent for Microsoft Windows
Veeam Agent for Linux
Veeam Backup for Nutanix AHV
Veeam Backup for AWS
Veeam Backup for Microsoft Azure
Veeam Backup for Google Cloud
Veeam Backup for Oracle Linux Virtualization Manager and Red Hat Virtualization
Veeam Management Pack for Microsoft System Center
Veeam Recovery Orchestrator
Veeam Agent for Mac
Veeam Agent for IBM AIX
Veeam Agent for Oracle Solaris
Veeam Cloud Connect
Veeam Kasten for Kubernetes
By submitting, you are agreeing to have your personal information managed in accordance with the terms of Veeam's Privacy Notice.
Verify your email to continue your product download
We've sent a verification code to:
  • Incorrect verification code. Please try again.
An email with a verification code was just sent to
Didn't receive the code? Click to resend in sec
Didn't receive the code? Click to resend
Thank you!

Thank you!

Your feedback has been received and will be reviewed.

error icon

Oops! Something went wrong.

Please, try again later.