Avamar: How to check backup contents using avtar and MCCLI
Summary: How to check the file and directory contents of an Avamar backup by using avtar and MCCLI command-line queries.
Instructions
To obtain a full list of files protected by a particular backup, use either the mccli backup show or the avtar --list command.
These commands can both be run from the Avamar Utility Node.
The avtar command can be run from any Avamar client which has access to the Avamar server.
avtar requires additional parameters such as the IP of the Avamar Utility Node and the Avamar login credentials.
Identify the Backup Label Number:
As both commands require the backup label number, identify the LabelNum of the backup to query using one of the following methods:
LabelNum values:
Example:
mccli backup show --name=/<full-domain-path>/<clientname.domain.com>
Created LabelNum Size Retention
----------------------- -------- ----------- ---------
2012-04-20 11:31:43 IST 34 132686304 N
2012-03-03 08:34:38 GMT 28 93336576 N
2012-03-03 08:33:34 GMT 27 6600942 N
2011-12-27 12:00:44 GMT 24 20730800 N
Once the LabelNum of the required backup is identified, this can be used with either the avtar or the MCCLI command method.
How to query backup contents using MCCLI:
The following mccli command can be used to check the top-level directories in the backup:
mccli backup show --name=/<full-domain-path>/<clientname.domain.com> --labelNum=<LabelNum>
0,23000,CLI command completed successfully.
Type Date Size Owner Group Permissions Name
---- ------------------- ------- ------- ---------------- ----------- ----
Dir 2016-12-19 08:39:15 3.2 GB unknown TrustedInstaller drwxrwxrwx C:/
Dir 2016-12-26 10:51:28 0 bytes SYSTEM unknown drwxrwxrwx E:/
Use of the --recursive flag lists the backup contents, including files and directories:
mccli backup show --name=/<full-domain-path>/<clientname.domain.com> --labelNum=<LabelNum> --recursive=true
Below is a small extract of the output:
Type Date Size Owner Group Permissions Name
File 2012-07-23 19:09:33 174 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/AppData/Roaming/Microsoft/Windows/Start Menu/desktop.ini
Dir 2009-07-14 02:34:59 0 bytes Administrators unknown drwxrwxr-x C:/Users/Default/AppData/Roaming/Microsoft/Windows/Templates/
Dir 2011-05-12 18:34:59 1.4 MB SYSTEM unknown drwxrwxr-x C:/Users/Default/AppData/Roaming/Microsoft/Windows/Themes/
File 2011-05-12 18:35:00 4.1 KB SYSTEM unknown -rwxrwxr-x C:/Users/Default/AppData/Roaming/Microsoft/Windows/Themes/slideshow.ini
File 2012-10-15 14:30:00 1.4 MB SYSTEM unknown -rwxrwxr-x C:/Users/Default/AppData/Roaming/Microsoft/Windows/Themes/TranscodedWallpaper.jpg
Dir 2009-07-14 05:08:56 0 bytes SYSTEM unknown drwxrwx--x C:/Users/Default/Application Data/
Dir 2012-07-23 19:09:33 67.2 KB SYSTEM unknown dr-xr-xr-x C:/Users/Default/Contacts/
File 2010-11-21 02:51:05 66.8 KB SYSTEM unknown -rwxrwxr-x C:/Users/Default/Contacts/Administrator.contact
File 2012-07-23 19:09:33 412 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Contacts/desktop.ini
Dir 2009-07-14 05:08:56 0 bytes SYSTEM unknown drwxrwx--x C:/Users/Default/Cookies/
Dir 2012-07-23 19:09:33 282 bytes Administrators unknown dr-xr-xr-x C:/Users/Default/Desktop/
File 2012-07-23 19:09:33 282 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Desktop/desktop.ini
Dir 2012-07-23 19:09:33 402 bytes Administrators unknown dr-xr-xr-x C:/Users/Default/Documents/
Dir 2009-07-14 05:08:56 0 bytes SYSTEM unknown drwxrwx--x C:/Users/Default/Documents/My Music/
Dir 2009-07-14 05:08:56 0 bytes SYSTEM unknown drwxrwx--x C:/Users/Default/Documents/My Pictures/
Dir 2009-07-14 05:08:56 0 bytes SYSTEM unknown drwxrwx--x C:/Users/Default/Documents/My Videos/
File 2012-07-23 19:09:33 402 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Documents/desktop.ini
Dir 2012-07-23 19:09:33 282 bytes Administrators unknown dr-xr-xr-x C:/Users/Default/Downloads/
File 2012-07-23 19:09:33 282 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Downloads/desktop.ini
Dir 2012-07-23 19:09:33 2.6 KB Administrators unknown dr-xr-xr-x C:/Users/Default/Favorites/
Dir 2011-11-07 19:04:30 306 bytes SYSTEM unknown dr-xr-xr-x C:/Users/Default/Favorites/Links/
File 2011-11-07 19:04:30 80 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Favorites/Links/desktop.ini
File 2012-07-23 17:33:42 226 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Favorites/Links/Web Slice Gallery.url
Dir 2010-11-21 02:51:27 666 bytes SYSTEM unknown drwxrwxr-x C:/Users/Default/Favorites/Microsoft Websites/
File 2012-07-23 17:33:42 133 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Favorites/Microsoft Websites/IE Add-on site.url
File 2012-07-23 17:33:42 133 bytes SYSTEM unknown -rwxrwxr-x C:/Users/Default/Favorites/Microsoft Websites/IE site on Microsoft.com.url
How to query backup contents using the avtar:
From the Avamar Utility Node:
avtar --list --labelnum=<LabelNum> --path=/<full-domain-path>/<clientname.domain.com>
From an Avamar client (avs\bin directory):
avtar --list --labelnum=<backup label number> --path=/<full-domain-path>/<clientname.domain.com> --hfsaddr=<Avamar utility node IP> --id=<Avamar user> --ap=<Avamar user's password>
Additional avtar parameters (for more information see the Avamar Technical Addendum):
-
- --id - Select an Avamar
userwhich has access to the client's domain. One example would beMCUser, which has global access. - --list - Lists the contents of a backup. Either --list or -t can be used.
--labelnum- this can be obtained using the user interface or CLI.- --internal - Shows the contents of the
.system_infohidden internal directory that is stored in the backup --verbose- This is equivalent to-v(This command parameter increases the detail that is provided in the log).- --verbose=2 (-
vv) --verbose=3 (-vvv) and --verbose=4 (-vvvv) are also available, however these levels of verbosity do not provide any additional information when run with theavtarlist command.
- --verbose=2 (-
- --format=xml - Displays results in xml
- --no-recursion - Do not recursively traverse directories (the default is to use recursion).
- --id - Select an Avamar
-
--verbose=1provides additional information with the file listing, including:- Permissions
User and Group- File modified date
-rwx------ xxxxxxxx/Domain Users 337081 0% 2011-03-18 22:54:00 C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/300-009-591-ADS_Rekick.pdf
Example avtar generated file listing (without verbose logging):
avtar --list --labelnum=34 --path=/domain1/Client1.customer.com
avtar Info <5551>: Command Line: /usr/local/avamar/bin/avtar.bin --flagfile=/usr/local/avamar/etc/usersettings.cfg --server=avamar-server.company.com --vardir=/usr/local/avamar/var --bindir=/usr/local/avamar/bin --id=root --password=********* --vardir=/usr/local/avamar/var --bindir=/usr/local/avamar/bin --sysdir=/usr/local/avamar/etc --list --sequencenumber=34 --account=/domain1/Client1.customer.com
avtar Info <6555>: Initializing connection (Avamar Deduplication Engine v2.0.0)
avtar Info <5552>: Connecting to Avamar Server (avamar-server.company.com)
avtar Info <5554>: Connecting to one node in each datacenter
avtar Info <5583>: Login User: "root", Domain: "default", Account: "//domain1/Client1.customer.com"
avtar Info <5580>: Logging in on connection 0 (server 0)
avtar Info <5582>: Avamar Server login successful
avtar Info <5550>: Successfully logged into Avamar Server
avtar Info <8745>: Backup from Windows XP Professional SP 3.0 host "/domain1/Client1.customer.com" (SomeAvamarClient) with plugin 3001 - Windows Filesystem
avtar Info <5538>: Backup #34 label "MOD-xxxxxxx" timestamp 2012-04-20 11:31:43 IST, 56 files, 126.5 MB
C:/
C:/Documents and Settings/
C:/Documents and Settings/user/
C:/Documents and Settings/user/My Documents/
C:/Documents and Settings/user/My Documents/AvaDocs/
C:/Documents and Settings/user/My Documents/AvaDocs/300-009-591-ADS_Rekick.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/ADS/
C:/Documents and Settings/user/My Documents/AvaDocs/ADS/ADS Gen1-4 rekickstart -300-009-591-ADS_Rekick.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/ADT 1 - Installation - 300-008-863.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/ADT 1 - Security 300-008-865.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/ADT logs.TXT
C:/Documents and Settings/user/My Documents/AvaDocs/Avamar 6.0 for VMware - 300-011-626.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/Avamar PSB07A_Draft_0.2.docx
C:/Documents and Settings/user/My Documents/AvaDocs/Configuration of High-Availability ADS Network Avamar Data Store Gen3 Technical Note - 300-011-174.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/DataDomain/
C:/Documents and Settings/user/My Documents/AvaDocs/DataDomain/MR-1CN-DDSADMIN.50G3.lb.gd.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/Tech Addendum - 300-008-817.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/v5 Backup Clients 300-008-819.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/v5 Software server installation - 300-008-827.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/v6/Utility Node Replacement Tech Note300-007-551.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/v6/v6 Avamar for VMware - 300-011-626.pdf
C:/Documents and Settings/user/My Documents/AvaDocs/v6/v6 Avamar for Windows Servers 300-011-627.pdf
...
avtar Info <5314>: Command completed (exit code 0: Success)
Example avtar generated file listing (with verbose=1 logging):
avtar --list --labelnum=34 --verbose=1 --path=/domain1/Client1.customer.com
avtar Info <5551>: Command Line: /usr/local/avamar/bin/avtar.bin --flagfile=/usr/local/avamar/etc/usersettings.cfg --server=avamar-server.company.com --vardir=/usr/local/avamar/var --bindir=/usr/local/avamar/bin --id=root -password=********* --vardir=/usr/local/avamar/var --bindir=/usr/local/avamar/bin --sysdir=/usr/local/avamar/etc --list --sequencenumber=34 --verbose=1 --account=/domain1/Client1.customer.com
avtar Info <6555>: Initializing connection (Avamar Deduplication Engine v2.0.0)
avtar Info <5552>: Connecting to Avamar Server (avamar-server.company.com)
avtar Info <5554>: Connecting to one node in each datacenter
avtar Info <5583>: Login User: "root", Domain: "default", Account: "/domain1/Client1.customer.com"
avtar Info <5580>: Logging in on connection 0 (server 0)
avtar Info <5582>: Avamar Server login successful
avtar Info <5550>: Successfully logged into Avamar Server
avtar Info <8745>: Backup from Windows XP Professional SP 3.0 host "/domain1/Client1.customer.com" (SomeAvamarClient) with plugin 3001 - Windows Filesystem
avtar Info <5538>: Backup #34 label "MOD-xxxxxxxxx" timestamp 2012-04-20 11:31:43 IST, 56 files, 126.5 MB
drwxrwxrwx Administrators/SYSTEM 132686301 0% 2012-04-19 09:13:11 C:/
drwxrwxr-x Administrators/SYSTEM 132686301 0% 2010-10-06 13:09:09 C:/Documents and Settings/
drwxrwx--- Administrators/SYSTEM 132686301 0% 2012-04-20 08:18:23 C:/Documents and Settings/user/
dr-x------ user/Domain Users 132686301 0% 2012-04-06 19:32:50 C:/Documents and Settings/user/My Documents/
drwx------ user/Domain Users 132686301 0% 2012-03-27 10:15:01 C:/Documents and Settings/user/My Documents/AvaDocs/
-rwx------ user/Domain Users 337081 0% 2011-03-18 22:54:00 C:/Documents and Settings/user/My Documents/AvaDocs/300-009-591-ADS_Rekick.pdf
drwx------ user/Domain Users 7109132 0% 2011-12-20 15:40:16 C:/Documents and Settings/user/My Documents/AvaDocs/ADS/
-rwx------ user/Domain Users 740667 0% 2011-11-23 11:59:22 C:/Documents and Settings/user/My Documents/AvaDocs/ADS/ADS Gen1-4 rekickstart -300-009-591-ADS_Rekick.pdf
-rwx------ user/Domain Users 3831369 0% 2011-12-20 15:40:16 C:/Documents and Settings/user/My Documents/AvaDocs/ADS/ADS Gen4 - single node install - 300-011-545.pdf
-rwx------ user/Domain Users 2537096 0% 2011-07-11 08:39:07 C:/Documents and Settings/user/My
-rwx------ user/Domain Users 2717 0% 2011-03-03 11:56:19 C:/Documents and Settings/user/My Documents/AvaDocs/ADT logs.TXT
-rwx------ user/Domain Users 3950628 0% 2011-07-20 13:34:51 C:/Documents and Settings/user/My Documents/AvaDocs/Avamar 6.0 for VMware - 300-011-626.pdf
-rwx------ user/Domain Users 2783560 0% 2011-05-13 14:33:45 C:/Documents and Settings/user/My Documents/AvaDocs/Avamar PSB07A_Draft_0.2.docx
-rwx------ user/Domain Users 818759 0% 2011-05-11 11:37:42 C:/Documents and Settings/user/My Documents/AvaDocs/Configuration of High-Availability ADS Network Avamar Data Store Gen3 Technical Note - 300-011-174.pdf
drwx------ user/Domain Users 7241382 0% 2011-12-19 17:26:51 C:/Documents and Settings/user/My Documents/AvaDocs/DataDomain/
avtar Info <5314>: Command completed (exit code 0: Success)
XML formatting
If --format=xml is specified, a file listing can be obtained displayed in xml format.
For Example:
<file date="2011-04-21 09:00:28" internal="0" group="Domain Users" protection="-rwx------" name="Windows Guide v5 300-010-672.pdf" size="3476325" links="0" user="tabitha" />
File listings for a specific directory:
A list of files or directories of interest can be included with the avtar command. Where no list is provided, avtar starts at the top of the backup.
By default, avtar recursively works through all directories to list files but if required, this can be prevented by using the --no-recursion flag.
For example, the following command lists the files and folders within the "AvaDocs" directory only. It does not descend into the 'v6' or the 'ADS' directories:
avtar --list --labelnum=34 --no-recursion --path=/domain1/Client1.customer.com "C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs"
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/300-009-591-ADS_Rekick.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/ADS/
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/ADS Gen3 customer service guide - 300-008-858.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/ADS Gen3 System Installation Manual - 300-008-856.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/ADT 1 - Installation - 300-008-863.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/ADT 1 - Security 300-008-865.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/ADT logs.TXT
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Avamar 6.0 for VMware - 300-011-626.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Avamar PSB07A_Draft_0.2.docx
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Configuration of High-Availability ADS Network Avamar Data Store Gen3 Technical Note - 300-011-174.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/DataDomain/
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/EMC_Software_Customer_Guide.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Error Codes -v5 - 300-008-813.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/EscTemplate.txt
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Exch Guide v5 300-008-821.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/hotkeys.txt
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Installation Guide v5 - 300-008-827.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/IP Hostname change tech note - 300-007-539.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/May 2011 - avamar-replication-wp.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/MCCLI Guide v5 - 300-008-818.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Operational Best Pract - 300-008-815.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Oracle Guide v5 300-008-824.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Tech Addendum - 300-008-817.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/v5 Backup Clients 300-008-819.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/v5 NDMP 300-008-823.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/v5 Product Security Guide - 300-008-816.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/v5 Release Notes 300-008-811.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/v5 Software server installation - 300-008-827.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/v5 SysAdmin 300-008-814.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/v6/
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Vmware Guide v5 - 300-010-712.pdf
C:/Documents and Settings/xxxxxxx/My Documents/AvaDocs/Windows Guide v5 300-010-672.pdf
avtar Info <5314>: Command completed (exit code 0: Success)Additional Information
- The
avtar--listcommand has been tested on the Avamar Utility Node with a Windows client backup. - The
--listflag should work elsewhere, but may display differently or be less effective with some client types or plugins.