Step 2. Enabling Custom Scripts Functionality

To enable the functionality of custom scripts on AHV Backup Proxy, do the following:

  1. Log into to the Nutanix Prism console.
  2. Go to the VMs dashboard, where you can find the AHV Backup Proxy VM.
  3. Select the AHV Backup Proxy VM and click Launch Console.
  4. Open the appsettings.json file.

sudo nano /opt/VeeamBackupAgent/appsettings.json

  1. Find the 3rdPartyJobScripts parameter and change the value of the Enable argument to true.

"3rdPartyJobScripts": {

   "Enable": true,

   "ExecutionTimeLimitSec": 1200,
   "FailScriptAfterTimeout": true,
   "FailScriptExecutionAfterPolicyCancel": true
 }

  1. Configure other parameters if required. For the list of available parameters, see the table below.

Argument

Description

Enable

Possible values:

  • true: backup job uses the custom script specified in the backup job settings.
  • false: backup job does not use custom scripts.

ExecutionTimeLimitSec

Possible values: a positive integer (0, MAX_INT)

FailScriptAfterTimeout

Possible values:

  • true: if the script execution exceeds the timeout period, the script execution is interrupted with a timeout error.
  • false: if the script execution exceeds the timeout period, the backup job fails with an error.

FailScriptExecutionAfterPolicyCancel

Possible values:

  • true: if the backup job session is cancelled while the script is running, execution of the script will be interrupted. The backup job will fail with an error.
  • false: if the backup job session is cancelled while the script is running, the script execution will be continued in the background. The backup job will fail with an error.
  1. Restart the VeeamBackupAgent service.

sudo service VeeamBackupAgent restart;

Defining AHV Cluster Administrator Credentials

To use the script, you must specify credentials that will be used to connect to the AHV cluster and its IP address.

  1. Log into the AHV Backup Proxy VM console.
  1. Open the nutanix.conf file.

sudo nano /opt/VeeamBackupAgent/CustomScripts/nutanix.conf

  1. Specify the cluster IP address and credentials.

nutanixClusterIp = "172.22.22.01"

nutanixLogin = "joelle.van.dyne"

nutanixPass = "Password"

Note

If you perform backup of the AHV Backup Proxy configuration settings, credentials specified in the custom script will be stored in the plain text format. To avoid this, you can relocate the nutanix.conf file and change its default path in the script.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.