Introduction
Zmanda Windows Client (or ZWC) backs up data from Microsoft Windows clients to an Amanda backup server. Zmanda Windows Client has 32bit and 64bit installers for respective architectures. Zmanda recommends the latest Windows service packs must be installed as recommended by Microsoft. The list of Windows platforms and applications supported are documented in the supported platforms matrix.
Requirements
Zmanda Windows Client uses Volume Shadow Copy services. Volume Shadow Copy service must be started and not be disabled on the Windows client.
Windows clients must open inbound TCP ports 10080 and 10081, and outbound TCP ports 800:840. On Windows 7, 8, 10 and Windows server 2008, 2012, 2016, 2019 ZWCService.exe added to the "Exceptions list" during ZWC installation if the Windows firewall is turned on. Please ensure that these ports are not used by other software. Some Anti-Virus software is known to use these ports. Please contact Zmanda Support if you need help in avoiding port conflicts.
The Zmanda Windows Client utilities such as ZWCconfig and ZWCsupport must run as Administrator (either logged in as Administrator or by right-clicking the utility from the Windows Start menu and choosing Run as administrator).
Downloading and Installing/Upgrading Zmanda Windows Client
Important Note: During installation, an amandabackup user account is created on the Zmanda Windows Client using local rules (i.e., Domain Controller/Domain/Standalone Workstation) for password creation. These OS users run backup and restore processes. When you change the account passwords eventually, be careful to ensure that security policies (such as strong passwords, password expiration) are followed. If an amandabackup user password expires, the Zmanda Windows Client service will fail to start, returning a Login Failure message.
You can upgrade from Zmanda Windows Client 3.1.4,3.3,3.5 and 3.6 to the latest 4.1 version.
Unattended Windows Client Installation/Uninstallation
If you are planning to install Windows Client on multiple machines, you should record the user input for playback. Using the user input recorded file, you can install Windows client using the command line on multiple machines in an unattended manner.
To record user input, run
setup.exe /r /f1<recording file>
The recording file will contain all user input for playback.
Windows client installer can read the user input recorded file from the same directory. Alternate location for user input can be provided using /f1 option. The installation log file will be created in the same directory (default: Setup.log). Alternate location for the log can be provided using /f2 option. An example command for replaying user input from C:\Temp\Setup.iss file.
setup.exe /s /f1"C:\Temp\Setup.iss"
The command will complete before the installation or uninstallation process is completed. Use /WAIT flag if you want the setup.exe command to wait for the process to be completed. For example: Run the following installation command that will wait till process is completed in Windows command shell
start /WAIT setup.exe /w /s /f1"C:\tmp\Setup.iss''
The Zmanda Windows client zip archive file (downloaded from Zmanda Network) provides default install.iss and uninstall.iss that can be used of unattended installation and uninstallation. This example setup files assumes
Installation Troubleshooting
If the installation failed for some reason, the ZWC installer rolls back the installation to the last working configuration.
The installation program logs messages to the following locations:
Installation can fail for a variety of reasons. For example, the user set a Password not conforming to Windows requirements, or running the installation program without the necessary permissions. The log messages will explain what went wrong.
Changing the Location of the Installation Data Directory
The Windows Client Installation Data Directory contains following critical folders:
The database stores the list of files that are backed up and their meta data. This information is stored between full backups to track what was backed up and determine what should be backed up in incremental backups. Doing full backup of the directory will cause all the information stored about earlier incremental backups to be removed (and so database size will be reduced). The size of database is directly proportional to number of files in the directory or volume being backed up.
If you find that the ZWC installation folder runs out of disk space while processing backup sets, you can move location of these files. There are two methods of doing this:
----------------------------------------------
[mysqld]
datadir=SQL_data_dir
----------------------------------------------
where SQL_data_dir is the new data location.
Backing Up Windows Clients
Windows clients can be backed up using a number of different methods. The method you choose will depend on:
There are four methods that require the Zmanda Windows Client (CIFS/Samba-based backup does not require that the ZWC is installed):
o Create a consistent backup of files/directories across drives and partitions on a Windows client.
o Configure pre-backup and post-backup scripts on the Windows client to perform such actions as deleting temporary files, sending out user notifications, etc.
ZMC/AEE allows concurrent backups of at most one application backup object (such as Oracle or MS Exchange) and either one Windows filesystem backup object or one Windows template backup. Editing DLEs using the ZMC will result in all windows backup object/DLEs having spindle values supporting this behavior.
However, note that the Windows template backup object type does support multiple concurrent file system-based DLEs (for example, the Program Files and My Documents folders).
Please make sure no other backup software is scheduled to run at the same time as the Amanda Windows Client backup.
Windows File System Backup
The Zmanda Management Console (ZMC) allows backup objects (also known as Disk List Entries or DLEs) with different Host Types to be included in the same Backup Set. Disk List Entries for Windows Clients resemble entries for other host types (Linux, Solaris, etc.).
Please see Zmanda Management Console Sources documentation for details on exclude files and compression. Windows client compression uses ZIP deflate algorithm. It is not possible to change the compression algorithm used on the Windows client.
Enable client encryption while creating the source on Sources page for the Windows DLE that needs to be encrypted on the client. The key to be used for encryption should be specified using the Advanced Settings in Zmanda Windows Client Configuration Tool. For more details on Windows client encryption please see Windows Encryption section.
Note : Data Integrity Check is not valid if we add Windows DLE with encryption strategy as “AES 256-bit on client”.
Backing up Windows-Mapped Drives
The Zmanda Management Console can back up mapped drives on a Windows client provided the drives have been mapped from the 'amandabackup' account on the Windows machine. This constraint is because few windows server drive letters are not global; different users can map different directories on different servers to the same drive letter. For further information, see the article "Backing up network mapped drives on Windows clients" on Zmanda's Knowledgebase.
Restoring to Windows-Mapped Drives
The Zmanda Management Console can restore to a mapped drive. The pre-requisites for restoring to a Windows mapped drive are the same as that for backing up the Mapped drive. See the knowledgebase article for requirements.
You can restore the data backed up from mapped drive to original location or to another mapped drive (alternate location). In ZMC Restore Where page, select the following options:
Original Location: Restoring data backed up from mapped drive to original location.
Alternate Location: To restore to an alternate location, use the Windows Folder option in the ZMC Restore Where page. Specify the Mapped drive letter or a path in the Mapped drive where the data needs to be restored to. For example, Z:\ or X:\test.
Backing up Windows Applications
If you have purchased and installed the relevant Zmanda licenses, Amanda Enterprise can perform intelligent backups of selected Windows applications such as Exchange and Oracle. These backups use Microsofts VSS (Volume Shadow Service) to capture a consistent copy of the database(s) in question.
Refer to the Zmanda Application Module User Guide for further details.
Backing Up Hardlinked Files
If only one of the hard linked files is present in the backup set, then the information about its other hard link files will not be backed up. Also at restore time, if only one hard link file is selected for restore, then its other hard link file will not be restored. Please see this Zmanda Knowledgebase Article for details.
Restoring a Windows Client
The Restore procedure for a Windows client is similar to the procedure for other clients. You can restore Windows backup image to the Linux/Solaris server. The backup image will be restored as a zip file (ZIP64 format).
Completing the Restore Where page for Windows Clients
Destination Host Type
Restoring to Windows-Mapped Drives
The Zmanda Management Console can restore to a mapped drive. The pre-requisites for restoring to a Windows mapped drive are the same as that for backing up the Mapped drive. See the knowledgebase article for requirements.
You can restore to the data backed up from mapped drive to original location or to another mapped drive (alternate location). In ZMC Restore Where page (see the figure in the last section), select the following options:
Original Location: Restoring data backed up from mapped drive to original location.
Alternate Location: To restore to an alternate location, use the Windows Folder option in the ZMC Restore Where page. Specify the Mapped drive letter or a path in the Mapped drive where the data needs to be restored to. For example, Z:\ or X:\test.
Windows System State Backup and Recovery
Windows System State refers to a collection of several key operating system elements and their files. Backing up the Windows System State is crucial for a successful disaster recovery strategy. Zmanda Windows Client can back up the Windows System State of all supported Windows platforms. Windows System State is always a full backup (level 0).
The system state can be restored to the original location or a different location. Partial restoration of Windows System State can be done only to a different directory location. Windows System State files require special handling to back up because they are always locked.
Restoring a system state backup from one computer to the second computer of a different make, model, or hardware configuration is not supported. See the following Microsoft Knowledgebase article for details: http://support.microsoft.com/kb/249694
Depending on the type of Windows system, Zmanda Windows Client software backs up the following System State information in a comprehensive and coherent fashion:
Workstations
Workstation in this context means any Windows machine which does not have an Active Directory (AD).
- On Windows XP and Windows 2003: SystemDrive\NTDETECT.COM, SystemDrive\ntldr, SystemDrive\boot.ini(SystemDrive is usually c:).
-On Vista: SystemRoot\boot directory (SystemRoot is usually c:\windows)
Domain Controllers
A Domain Controller (or DC) is any Windows machine with Active Directory installed. DC backups include all of the state information listed above for Workstations, plus the Active Directory database, log files, and Group Policy Objects (GPOs).
Windows System State Backup from the ZMC
To back up the Windows System State (which is always a full backup), choose Windows System State as the type under File Systems on Sources page of the Zmanda Management Console, and the following options are displayed:
Host Name The Fully Qualified Domain Name (FQDN) or IP address of the Windows system to be backed up.
Data Deduplication
Select the checkbox to enable deduplication. Note that user is not allowed to select any encryption and compression
strategies if data deduplication is enabled.
Encryption & Compression Options
Lists Encryption and Compression choices. See Enabling Encryption for Windows Backups for details.
Advanced Options - Estimate
If estimates are taking too long and the databases being backed up do not change in size that much from backup to the
backup, use the Historical Average calculated from previous backups. In most cases, the default of Reliably Accurate is
appropriate.
Backup Set
Select backupset from dropdown menu to which DLE will be added upon saving.
After you have set the options, click the Save button to add the Windows snapshot to the backup set. You can then configure the backup set just as you would any other by setting the options on Backup Where, Backup How, and Backup When, etc.
Windows System State Restore from the ZMC
To restore Windows system state, specify the Initial Directory as SystemState in the Restore What page of ZMC.
Please note the following requirements and cautions regarding System State backup and restores through the Zmanda Windows Client:
Changing the Password for the Amandabackup User
During the installation process, the amandabackup user is created and a password is set. To change the password, shut down the Zmanda Windows Client service, then use the Windows Control Panel utility to edit the amandabackup user account. Use the same procedure as for any other Windows-based password-protected service. Restart the Zmanda Windows Client service when you are done. Note that the service must restart without any errors for the changed password to take effect.
Please update the amandabackup user password using Zmanda Windows Client Configuration Utility (Advanced options). See the next section.
Zmanda Windows Client Configuration Utility
The Zmanda Windows Client configuration utility (ZWCConfig) can be used to
All Zmanda Windows Client Configuration utility operations have to be performed as Administrator.
Log on to the workstation as the Administrator and start ZWCConfig utility by clicking Start->Programs->Zmanda Client for Windows->ZWCConfig. Alternatively, you can right-click the menu option to Run as administrator. After you start the program, The Zmanda Windows Configuration dialog is displayed.
Creating and Managing Windows Templates
A Windows template is roughly equivalent to a backup object in the Zmanda Management Console, or a Disk List Entry (DLE) in Amanda. A template is useful if you want to back up different files and folders that reside on different drives as part of a single backup object/DLE.
In addition to specifying drives and folders for backup (which can be accomplished via ZWCconfig), you can also manually edit the template file to specify programs or scripts that should run before and after the backup.
Templates created using ZWCConfig utility are stored in the template.txt file located in the \Misc directory of the Zmanda Windows Client installation directory on Windows XP and Windows 2003 systems, or %ProgramData%\misc in on Windows Vista, Windows 7 and Windows 2008 systems.
Template Name
Unique name of the template. Only alphanumeric characters and '_' is
allowed for a template name.
Files/folder to include
List of files and folders to be backed up.
Add
Opens a dialog that lets you browse for and select files/folders to back up.
Delete
Deletes the currently selected file/ folder from the list of files and folders to include. Click on an entry in the list to select, then click Delete to remove it.
Templates
Lists the templates that have been created and saved to template.txt. Use the dropdown menu to select a template to edit, or select <New Template> to create a template.
Add Template
Click to add a new template.
Delete Template
Click to delete the currently-displayed template from template.txt.
Specifying Scripts to Run Before and After backup and Restore Operations.
You may want to perform automated operations before and after a backup run and/or before and after a restore run, such as deleting temporary files, starting or stopping services, or other such operations that can be performed from a Windows script or batch file. By editing the template.txt file described above, you can specify such scripts to run automatically either before or after a backup run and/or before and after a restore run for a given backup template.
Simply add a <PRE_BACKUP_SCRIPT> or <POST_BACKUP_SCRIPT> (or <PRE_RESTORE_SCRIPT> or <POST_RESTORE_SCRIPT>) tag(s) to the template.txt file for a given template. The tag's content is the path to script. For example, the following shows what the code would look like to add pre- and post-backup scripts to the MyTemplate template, which backs up c:\data after running c:\preScript.bat (which takes the input file prebackup.txt as an argument), and then runs postScript.bat:
<MyTemplate>
<DLE_NAME>MyData</DLE_NAME>
<DLE_TYPE>USER-DEFINED</DLE_TYPE>
<FILE_LIST>
<FILE_NAME>c:\data</FILE_NAME>
</FILE_LIST>
<PRE_BACKUP_SCRIPT>C:\preScript.bat prebackup.txt</PRE_BACKUP_SCRIPT>
<POST_BACKUP_SCRIPT>C:\postScript.bat
postbackup.txt</POST_BACKUP_SCRIPT>
</MyTemplate>
If the pre-backup script fails, the backup returns ZWC_ENG_ERR_PRE_SCRIPT (error code 278). If the pos-tbackup script fails, the error will be logged and backup status will be success.
If the pre-restore script fails, an error is logged. If the post-restore script fails, the restore returns the appropriate error.
Setting the Amanda Server
Click the Server tab to display server settings:
Server Name
The Fully Qualified Domain Name (FQDN) of the Amanda Backup server. To specify an IP address instead, you can leave this field blank and use the IP Address field instead.
IP Address
The IP Address of the Amanda backup server. To specify an FQDN, you can leave this field blank and use the Server Name field instead.
Server List
This drop-down menu lists previously-saved Server Names that you can select for viewing and changing settings.
Add/ Delete Server
Lets you save the current Server Name (along with its settings) to the Server list dropdown.
Click Exit to save any changes you have made and exit the ZWCconfig utility.
Changing the Log Settings
[Text Wrapping Break]
Click the Logging tab to display log settings:
Log File Location
Log file will be stored in the \Debug subdirectory of the Zmanda Windows Client Installation directory by default.
Log Level
Range of 1-5. Increasing the level generates more detailed logs; decreasing the level results in more compact (but less detailed) logs. The default level is 2.
Log File Size (in MB)
Depending on the Log Overwrite setting (see below), when this file size limit is reached, the log file will either be renamed to NLogFileNumber.txt (allowing more recent information to be saved in LogFile.txt) or simply overwritten with newer information. If log rotation is enabled, older files are overwritten after the Log File Count is reached.
Log File Count
When log rotation is enabled (i.e., Log Overwrite is disabled), sets the number of logfiles that can be saved before older files are overwritten with newer log entries.
Log Overwrite
If checked, disables the rotating log feature (in other words, newer log entries will overwrite older entries in LogFile.txt after Log File Size has been reached).
Save
Saves the log settings currently displayed.
Reset
Resets all log settings to their default values.
Exit
Exit the ZWCconfig utility.
Advanced Settings
Data Queue Size
Set the number of buffers allowed within each queue of the ZWC messaging framework. Do not change from the default of 50 unless a different value is recommended by the Zmanda Support Team.
Temporary Directory
Sets the location of temporary files created during backup and restore processes. For Windows Vista, the default is C:\ProgramData\Zmanda; for other Windows platforms it is the \Misc subdirectory of the ZWC installation.
Backup Port/ Restore Port
Ports to use for backup of and restore to the Windows client.
Encryption AES Key
Sets the encryption passphrase to use when AES 256 bit encryption is chosen while taking backup. The encryption passphrase is set for each Windows machine. All backups done on the Windows machine are encrypted using the same key as long as AES 256 bit client encryption is configured on the ZMC.
Zmanda Windows Client does not manage keys. Customers must backup encryption keys separately.
Password for user amandabackup
Update amandabackup user password if it has been changed since Zmanda Windows
Client installation.
Save
Saves the advanced settings currently displayed.
Reset
Resets all advanced settings to their default values.
Exit
Exit the ZWCconfig utility.
When you exit the program, you are prompted to restart the ZWCservice, which is necessary for the configuration changes to take effect.
The Zmanda Windows client service can also be manually restarted from the Windows services user interface (Administrative Tools > Services). An example services screen is shown below.
Exporting and Importing Key container
Zmanda Key Container is required only if you have backup archives client encrypted using ZWC 3.6 release.
Encryption Metadata for the association between amandabackup user and the digital certificate used is stored under the Zmanda key container on disk on the backup client machine.It is important to export the key container before uninstalling ZWC on the client machine. Also, this key container will be needed, in the case of restoring encrypted archives on a different machine.
The exported XML file is needed for disaster recovery and must be backed up. To export and import key containers, .NET framework (version 2.0 or greater) must be installed on the Windows machine. It is usually found under C:\WINDOWS\Microsoft.NET\Framework and Framework64 folders.
To export the Zmanda key container to XML file, run the following command (Windows Start > Run > command):
aspnet_regiis -px “Zmanda” “<Name of XML file to be created>” -pri
IMPORTANT: Before importing Zmanda key container from another machine, make sure you have exported Zmanda key container from the current machine. This step is necessary if you are importing Zmanda Key container to a machine that is already performing Amanda encrypted backups. Use the above procedure to export Zmanda key container. To import the Zmanda key container from the XML file, run the following command (Windows Start > Run > command):
aspnet_regiis -pi “Zmanda” “<Name of the exported XML file>” -exp
You will need to import the exported key container from the current machine, in order to recover from encrypted archives backed up from this machine.
After importing the Zmanda key container, the digital encryption certificates have to be imported for the amandabackupuser. This is necessary to recover from encrypted archives.
Compatibility with Previous Versions of the Zmanda Windows Client
If you have created backup images using Amanda Enterprise edition Windows Client 2.6.1 or older, the older version of the client is required to recover the files to a Windows machine. Contact the Zmanda Support team for assistance. Alternatively, you can use the current version of Amanda Enterprise to recover the files to the backup server and then move them manually to the client.
Running the Windows Client Support Script
The zwc-support utility collects system log files, log files related to ZWC and system related information. The utility then archives these log files into a single compressed file.You must run the utility as the Administrator. This compressed file can be then sent to the Zmanda Support team for analysis.
Location
The Zmanda Windows Client support utility zwc-support.bat is included with the Zmanda Windows Client. To start the script, click Start->Programs->Zmanda Client for Windows->zwc-support
Files Gathered
The following types of log files are gathered by zwc-support:
Zmanda Windows Client Installation Logs
Zmanda Windows Client Debug Logs:
System Logs:
Additional information:
Output File
After the utility is run, an output file with the name zwc-logs-datetimestamp.cab is created in the Zmanda installation directory.