Search <book_title>...

Veritas NetBackup™ for Microsoft Azure Stack Administrator's Guide

Last Published: 2021-01-01

Product(s): NetBackup & Alta Data Protection (9.0.0.1, 9.0)

Configuring the Microsoft Azure plug-in using the azurestack.conf configuration file

NetBackup master server uses the azurestack.conf file to save the configuration settings for communication with Microsoft Azure Stack.

You must create the azurestack.conf file in the /usr/openv/var/global directory.

Configuration definitions must be in the format of "attribute = value"; the single space before and after the '=' is required.

The options and values are case-sensitive.

Note:

You must not provide a blank value for any of the parameters, or the backup job fails.

Here is a sample of the azurestack.conf file:

VM_STATE = Running
FETCH_STORAGE_KEYS = false
CA_FILE_PATH = //directory_path_system_CA_certificate/certificate_name.crt
VM_SNAPSHOT_IN_DISCOVERY = true
NO_OF_BACKUP_STREAMS_PER_NODE = 1
ENABLE_SNAPSHOT_CLEANUP = 0
SNAPSHOT_CLEANUP_MIN = 1440
SNAPSHOT_FETCH_RETRY_COUNT = 60
ASYNC_SNAPSHOT_SUPPORT = true
SET_PUBLIC_IP_DURING_RESTORE = false
STAGING_STORAGE_ACCOUNTS = headsuptsta, restorestadisks, stafordiskstorages

The possible values for VM_STATE are Running, Deallocated, or Stopped.
The value for SNAPSHOT_FETCH_RETRY_COUNT specifies the maximum retries that can happen if a VM snapshot process fails. The value cannot exceed 3.
The value for FETCH_STORAGE_KEYS specifies whether the storage account with access key is required in the Azure Stack credentials file. The value can be either true or false. If the value is true, then you do not specify the storage account with access keys in the credential file. The default value is true.
The value for CA_FILE_PATH is the directory path of the system CA certificate and the certificate name. For example, /etc/pki/tls/certs/ca-bundle.crt. This directory path is the default path for all system CA certificates.
The value for VM_SNAPSHOT_IN_DISCOVERY defines whether VM disk snapshots are created for all disks that are attached to the VMs that are specified in the backup selection in the backup policy. The default value is false, specifying that snapshots of all disks that are attached to a single VM are created at a time during the backup job.
The value for NO_OF_BACKUP_STREAMS_PER_NODE specifies the maximum number of backup streams per backup host. The default value is 1. You can define the value up to 8.
The value for ENABLE_SNAPSHOT_CLEANUP specifies when to clean up stale snapshots. You can use the following values:
- 0
  Do not delete the stale snapshots. This is the default value.
- 1
  Delete the stale snapshots after the backup job completes.
- 2
  Delete the stale snapshots as part of the next discovery job.
The value for SNAPSHOT_CLEANUP_MIN specifies the time in minutes after which the snapshot is deleted. The default value is 1440 minutes (24 hours). The ideal value is the time difference in minutes between two backup job.
The value for SNAPSHOT_FETCH_RETRY_COUNT specifies the retry count for the plug-in to check for the snapshot in a given storage container. The default value is 60 and the values can be between 60 and 120.
The value for ASYNC_SNAPSHOT_SUPPORT specifies that unmanaged disk snapshots are taken using the async REST API. The default value is true. Set the value to false to disable unmanaged disk snapshots using the async REST API.
The value for SET_PUBLIC_IP_DURING_RESTORE specifies whether to use a public IP address during the VM restore. The default value is true that specifies that the VM is restored with a public IP address. Set the value as false, to restore the VM with a private IP address.
The value for STAGING_STORAGE_ACCOUNTS is a comma separated list of storage account names that are already available on Azure Stack and the value is required for only managed disks VM restore or recovery. You can specify one or many storage accounts names for this key. Storage account name is required for restoring VHD blobs for the managed disks conversion operation. As per the target subscription location that is the selected as restore location, Netbackup Azure Stack plug-in automatically picks only one storage account from the list that is provided for this key. This is a one-time activity where you can specify all storage accounts needed for all restore jobs as per the target location selected for each restore job.

Note:

Do not add VM_STATE in the azurestack.conf file if you want to take a backup if all VMs.