Avamar: How to create a dynamic dataset
Summary: This article describes how to provide Avamar with a dynamic list of files to be backed up. This is possible without modifying the Avamar dataset each time the backup list changes.
This article applies to
This article does not apply to
This article is not tied to any specific product.
Not all product versions are identified in this article.
Instructions
Avamar provides "include" or "exclude" statements which enable a user to target selected files that must be backed up.
The user must write a script which generates a list of files to be backed up. The script must dump the list to a file which Avamar can parse.
1) Using the Avamar Administrator console
Configure the dataset for the client so that it contains any source drives from where data may need to be backed up. Any source drives are fully scanned by Avamar. In order to avoid long-running backups, be sure that unnecessary drives are not included.
2) On the Avamar client
a) In the avs/var directory edit (or create if one does not already exist) the file "avtar.cmd".
b) The avtar.cmd file should be configured with a line to exclude all files from being backed up.
--exclude=*
This ensures that Avamar does not back up all the files under source file systems defined by the dataset.
c) The avtar.cmd file should also contain a line with --include-from=FILE
FILE is a plain text file with a list of files which should Avamar should back up. This is the dataset to be backed up. The contents of FILE is generated by your custom script.
d) The avtar.cmd file should include a line with --run-at-start=SCRIPT
This instructs Avamar to run the SCRIPT before the backup takes place.
3) Create a file called SCRIPT which is called as described earlier. The script must generate a fresh list of files which must be backed up and add them to FILE before the Avamar backup starts.
Information about Avamar pre-scripts is available in the Avamar system administration guide.
The script does not need to be run as an Avamar pre-script. Use whatever method is most appropriate. This could be a native daily batch or cron job run by the operating system. The important thing is that SCRIPT maintains FILE so that it contains an up-to-date list of files which Avamar should back up.
You may include as part of the backup both FILE and SCRIPT. This helps you understand what avtar was instructed to back up for auditing purposes. Or, in case it is necessary to troubleshoot a problem with the backup.
The user must write a script which generates a list of files to be backed up. The script must dump the list to a file which Avamar can parse.
1) Using the Avamar Administrator console
Configure the dataset for the client so that it contains any source drives from where data may need to be backed up. Any source drives are fully scanned by Avamar. In order to avoid long-running backups, be sure that unnecessary drives are not included.
2) On the Avamar client
a) In the avs/var directory edit (or create if one does not already exist) the file "avtar.cmd".
b) The avtar.cmd file should be configured with a line to exclude all files from being backed up.
--exclude=*
This ensures that Avamar does not back up all the files under source file systems defined by the dataset.
c) The avtar.cmd file should also contain a line with --include-from=FILE
FILE is a plain text file with a list of files which should Avamar should back up. This is the dataset to be backed up. The contents of FILE is generated by your custom script.
d) The avtar.cmd file should include a line with --run-at-start=SCRIPT
This instructs Avamar to run the SCRIPT before the backup takes place.
3) Create a file called SCRIPT which is called as described earlier. The script must generate a fresh list of files which must be backed up and add them to FILE before the Avamar backup starts.
Information about Avamar pre-scripts is available in the Avamar system administration guide.
The script does not need to be run as an Avamar pre-script. Use whatever method is most appropriate. This could be a native daily batch or cron job run by the operating system. The important thing is that SCRIPT maintains FILE so that it contains an up-to-date list of files which Avamar should back up.
You may include as part of the backup both FILE and SCRIPT. This helps you understand what avtar was instructed to back up for auditing purposes. Or, in case it is necessary to troubleshoot a problem with the backup.
Additional Information
Custom scripts cannot be developed or debugged by Dell Support, it is the user's responsibility to make sure they provide a correctly working script which generates the required output.
If assistance is required configuring an Avamar client according to the guidelines in this article, discuss with your local Dell account manager or implementation team.
More information about the "--include-from=FILE" parameter
This flag Specifies a FILE containing a list of matching patterns. The patterns decide which files are included in a backup or restore.
If assistance is required configuring an Avamar client according to the guidelines in this article, discuss with your local Dell account manager or implementation team.
More information about the "--include-from=FILE" parameter
This flag Specifies a FILE containing a list of matching patterns. The patterns decide which files are included in a backup or restore.
Common glob operators (wildcards) such as asterisk (*) and question mark (?) are allowed.
When specifying inclusions, case sensitivity varies according to the target computing platform you are backing up. Inclusions specified for Windows platforms are not case-sensitive; inclusions specified for most other platforms are case-sensitive.
Multiple include files can be used. However, each one must be preceded by a separate --include-from=FILE option.
More information about the "--run-at-start=SCRIPT" parameter
The SCRIPT must be placed in:
/usr/local/avamar/etc/scripts on AIX and Linux
/opt/AVMRclnt/etc/scripts on HP-UX and Solaris
C:\Program Files\avs\etc\scripts on Windows
On Windows clients, SCRIPT must have a .bat, .js or .vbs extension. There are no limitations on other client platforms.
Affected Products
AvamarProducts
AvamarArticle Properties
Article Number: 000156615
Article Type: How To
Last Modified: 10 Feb 2025
Version: 4
Find answers to your questions from other Dell users
Support Services
Check if your device is covered by Support Services.