EMC CONFIDENTIAL

EMC® Avamar® 7.2

Technical Addendum
P/N 302-001-936
REV 01
EMC CONFIDENTIAL

Copyright © 2001- 2015 EMC Corporation. All rights reserved. Published in the USA.

Published June, 2015

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without
notice.

The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect
to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular
purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

EMC2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other countries.
All other trademarks used herein are the property of their respective owners.

For the most up-to-date regulatory document for your product line, go to the technical documentation and advisories section on the
EMC online support website.

2 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

CONTENTS

Preface

Chapter 1 Advanced Technical Information

Checkpoints................................................................................................ 24
Full checkpoints .................................................................................... 24
Valid checkpoints ................................................................................. 24
Checkpoint verification ............................................................................... 24
Important terms and concepts............................................................... 25
Operational overview ............................................................................ 25
Common hfscheck error codes .............................................................. 26
HFS check throttling .............................................................................. 28
Types of checks performed.................................................................... 29
Automatic stripe repair.......................................................................... 30
Rolling HFS checks ................................................................................ 33
Event throttling ........................................................................................... 35
Retention types........................................................................................... 36
Server dynamic load balancing ................................................................... 38
Storage file types ........................................................................................ 39
Timezone notes .......................................................................................... 40
Maintenance window compatibility ....................................................... 40
Consult the local site administrator ....................................................... 40
Daylight savings time considerations .................................................... 40
Avoid local timezones that ignore local DST laws .................................. 40
Do not use GMT as local timezone for England ...................................... 40
Select capital city or nearest large city for small countries ..................... 41
Additional timezone resources .............................................................. 41

Chapter 2 Command Reference

Run locations .............................................................................................. 47
Boolean option behavior and syntax ........................................................... 47
Wildcards.................................................................................................... 47
Numeric plug-in descriptors ........................................................................ 48
5minute_cron_run ...................................................................................... 51
10minute_cron_run .................................................................................... 52
ascd............................................................................................................ 53
asktime ...................................................................................................... 54
avacl........................................................................................................... 60
avagent....................................................................................................... 61
avidbmaint.pl ............................................................................................. 67
avinstaller.pl ............................................................................................... 68
avldap ........................................................................................................ 69
avlockboxcfg............................................................................................... 71
avmaint ...................................................................................................... 73
avmaint access ..................................................................................... 81
avmaint atrestencryption ...................................................................... 82
avmaint autorestart............................................................................... 84
avmaint cancelremovebadhashes ......................................................... 86
avmaint cat ........................................................................................... 86

EMC Avamar 7.1 Technical Addendum 3

EMC CONFIDENTIAL
Contents

avmaint checklogs ................................................................................ 87

avmaint checkpoint............................................................................... 88
avmaint config ...................................................................................... 89
avmaint conversion............................................................................... 98
avmaint crunch ..................................................................................... 99
avmaint decommission ....................................................................... 101
avmaint ducp ...................................................................................... 102
avmaint findbadhashes ...................................................................... 102
avmaint garbagecollect ....................................................................... 104
avmaint gcstatus................................................................................. 105
avmaint gendata ................................................................................. 106
avmaint getclientmsgs ........................................................................ 107
avmaint geterrors ................................................................................ 108
avmaint getrefby ................................................................................. 109
avmaint hfscheck................................................................................ 110
avmaint hfscheckstatus ...................................................................... 114
avmaint hfscheckthrottle .................................................................... 117
avmaint infomessage .......................................................................... 119
avmaint kill ......................................................................................... 120
avmaint logscan.................................................................................. 121
avmaint lookup ................................................................................... 124
avmaint ls ........................................................................................... 125
avmaint lscp ....................................................................................... 126
avmaint networkconfig........................................................................ 129
avmaint nodelist ................................................................................. 130
avmaint perf........................................................................................ 132
avmaint ping ....................................................................................... 136
avmaint poolcheck.............................................................................. 137
avmaint rebuildstripe .......................................................................... 139
avmaint removebadhashes ................................................................. 140
avmaint rmcp ...................................................................................... 141
avmaint sched .................................................................................... 143
avmaint sessions ................................................................................ 150
avmaint stats ...................................................................................... 150
avmaint stripels .................................................................................. 152
avmaint suspend ................................................................................ 153
avmaint test ........................................................................................ 154
avmaint testintegrity ........................................................................... 155
avmaint timesync................................................................................ 156
avmaint timing .................................................................................... 157
avmaint tracehash .............................................................................. 158
avmgr ....................................................................................................... 159
avregister.................................................................................................. 170
avregister.bat............................................................................................ 170
avscc ........................................................................................................ 171
avsetup_avamarbin .................................................................................. 173
avsetup_avi.pl .......................................................................................... 173
avsetup_connectemc.pl ............................................................................ 173
avsetup_ems ............................................................................................ 174
avsetup_mccli........................................................................................... 175
avsetup_mcs ............................................................................................ 176
avsetup_mds ............................................................................................ 179
avsetup_snmp .......................................................................................... 180
avsetup_webstart ..................................................................................... 181
avsetup_wrapper ...................................................................................... 181

4 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Contents

avsysconfig............................................................................................... 182
avsysreport ............................................................................................... 183
avtar ......................................................................................................... 192
avtar.bin ................................................................................................... 216
axion_install ............................................................................................. 216
axionfs...................................................................................................... 219
backendreport .......................................................................................... 222
backup_upgrade_files............................................................................... 224
btfix .......................................................................................................... 226
capacity.sh ............................................................................................... 227
change-passwords .................................................................................... 228
change_nodetype ..................................................................................... 230
check.dpn................................................................................................. 231
check.mcs................................................................................................. 234
checklib.pm .............................................................................................. 234
clean_db.pl............................................................................................... 235
clean.dpn ................................................................................................. 238
convert-probe ........................................................................................... 239
copy-ata-drive ........................................................................................... 240
copy-checkpoint........................................................................................ 242
cp_cron..................................................................................................... 244
cplist ........................................................................................................ 245
cps ........................................................................................................... 248
create_newconfigs .................................................................................... 249
cron_env_wrapper .................................................................................... 249
dbcreate_mds........................................................................................... 250
dbload.sh ................................................................................................. 250
dbmaint.sh ............................................................................................... 251
dbpurge.sh ............................................................................................... 252
dbUpdateActivitiesExt.pl........................................................................... 254
decommission.node ................................................................................. 254
delete-snapups......................................................................................... 255
disktest.pl ................................................................................................ 257
dpn.pm..................................................................................................... 258
dpncron.pm .............................................................................................. 258
dpnctl ....................................................................................................... 258
dpnfsctl .................................................................................................... 268
dpnnetutil................................................................................................. 269
dpnsummary............................................................................................. 277
dpn-time-config ........................................................................................ 280
dt and dtsh ............................................................................................... 282
dump_accounts ........................................................................................ 284
dumpmaintlogs ........................................................................................ 285
emserver.sh.............................................................................................. 286
emwebapp.sh ........................................................................................... 288
errchk ....................................................................................................... 289
evening_cron_run ..................................................................................... 290
expire-snapups ......................................................................................... 291
gathergsankeydata ................................................................................... 293
gcblitz....................................................................................................... 294
gc_cron..................................................................................................... 296
gc_report .................................................................................................. 298
gen-ssl-cert ............................................................................................... 299
gethostbyname ......................................................................................... 300
getlogs...................................................................................................... 301

EMC Avamar 7.1 Technical Addendum 5

EMC CONFIDENTIAL
Contents

getnodelogs.............................................................................................. 301
getsnapupstats ......................................................................................... 302
health_check.pl ........................................................................................ 304
hfscheck_cron........................................................................................... 306
hfscheck_kill............................................................................................. 310
hfsclean.................................................................................................... 312
hfssetup ................................................................................................... 312
initacnt ..................................................................................................... 313
initialize_connectemc ............................................................................... 314
java_update.sh ......................................................................................... 315
java_update_avi.sh................................................................................... 316
lm ............................................................................................................. 316
load_accounts .......................................................................................... 318
logmrg ...................................................................................................... 319
mapall ...................................................................................................... 320
mcdbmaint.sh........................................................................................... 323
mcdbsql.sh............................................................................................... 324
mcconfigfirewall_snmp ............................................................................. 325
mcddrcopy_sshkey ................................................................................... 325
mcddrcreate_sshkey ................................................................................. 325
mcddrsetup_sshkey.................................................................................. 326
mcddrsnmp .............................................................................................. 327
mcfeature ................................................................................................. 328
mcflush.pl................................................................................................. 329
mcgui.bat ................................................................................................. 330
mcgui.sh................................................................................................... 331
mcgui_login.bat........................................................................................ 332
mcserver.sh .............................................................................................. 334
mcsmon_run............................................................................................. 338
mcsnmp.................................................................................................... 338
mcsnmp_cron ........................................................................................... 338
mds_ctl..................................................................................................... 339
metadata_cron.......................................................................................... 339
mktime ..................................................................................................... 340
modify-snapups........................................................................................ 342
mondo ...................................................................................................... 344
monmcs.................................................................................................... 344
monthly_cron_run..................................................................................... 345
morning_cron_run .................................................................................... 345
msgbrokerctl.pl......................................................................................... 346
nodedb..................................................................................................... 347
nodedb add if ..................................................................................... 351
nodedb add node................................................................................ 352
nodedb create..................................................................................... 355
nodedb delete if.................................................................................. 356
nodedb delete module ........................................................................ 356
nodedb delete nat............................................................................... 357
nodedb delete node............................................................................ 357
nodedb print ....................................................................................... 358
nodedb update if ................................................................................ 360
nodedb update module....................................................................... 362
nodedb update node........................................................................... 363
nodenumbers ........................................................................................... 364
opstatus.dpn ............................................................................................ 366
permctl ..................................................................................................... 367

6 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Contents

pingmcs.................................................................................................... 368
probe........................................................................................................ 368
probeaux .................................................................................................. 369
probedump............................................................................................... 370
probesingle............................................................................................... 371
propagate-gsan......................................................................................... 372
psregrep ................................................................................................... 373
pull-checkpoint ......................................................................................... 374
rebuild.node ............................................................................................. 375
repl_cron .................................................................................................. 379
replicate ................................................................................................... 379
resite ........................................................................................................ 387
restart.dpn................................................................................................ 397
resume_crons ........................................................................................... 401
rollback.dpn ............................................................................................. 402
rununtil..................................................................................................... 403
sched.sh................................................................................................... 404
scn ........................................................................................................... 406
securedelete ............................................................................................. 409
showperfhistory........................................................................................ 411
shutdown.dpn .......................................................................................... 413
site_inventory ........................................................................................... 415
ssn ........................................................................................................... 418
start.dpn................................................................................................... 421
start.nodes ............................................................................................... 428
stats.sh .................................................................................................... 430
status.dpn ................................................................................................ 431
store-checkpoint ....................................................................................... 433
stunctl ...................................................................................................... 434
suspend_crons ......................................................................................... 436
swraidctl................................................................................................... 437
timedist .................................................................................................... 438
timerange ................................................................................................. 440
timesyncmon ............................................................................................ 441
tomcatctl .................................................................................................. 443
transfer-key............................................................................................... 445
truncate .................................................................................................... 445
ugcheck .................................................................................................... 446
ugcopy...................................................................................................... 447
ugprep ...................................................................................................... 448
wait.crunch ............................................................................................... 453
wait.dpn ................................................................................................... 455
website..................................................................................................... 456
zzdpn........................................................................................................ 458

Chapter 3 Environment Variables

AVAMAR_INSTALL_BASEDIR_PATH ............................................................. 460
AVAMAR_INSTALL_VARDIR_PATH ............................................................... 460
SYSNODEDB.............................................................................................. 460
SYSPROBEDIR ........................................................................................... 460
SYSPROBEUSER ........................................................................................ 461

EMC Avamar 7.1 Technical Addendum 7

EMC CONFIDENTIAL
Contents

Chapter 4 Important Files

.avamar .................................................................................................... 464
avagent.cfg ............................................................................................... 464
AVAMAR-MCS-MIB.txt................................................................................ 464
avinstaller.xml .......................................................................................... 464
com.avamar.asn.module.datastore ..................................................... 465
com.avamar.avi................................................................................... 465
com.avamar.avi.repo .......................................................................... 466
com.avamar.avigui.............................................................................. 466
com.avamar.mc.compatibility ............................................................. 466
com.avamar.mc.dpn ........................................................................... 466
com.avamar.mc.mcsvars..................................................................... 467
avw_start_dpn_options.txt ....................................................................... 468
axionfs.cfg ................................................................................................ 468
checkpoints.xml........................................................................................ 468
config_info................................................................................................ 469
Multi-node servers .............................................................................. 469
Single-node servers ............................................................................ 469
Avamar NDMP Accelerator ................................................................... 470
CAT servers ......................................................................................... 470
Spare nodes........................................................................................ 470
emclient.xml ............................................................................................. 471
emserver.xml ............................................................................................ 472
com.avamar.asn ................................................................................. 472
com.avamar.asn.module.datastore ..................................................... 473
com.avamar.asn.module.mail ............................................................. 473
com.avamar.asn.service...................................................................... 473
com.avamar.mc .................................................................................. 474
com.avamar.mc.ca .............................................................................. 474
com.avamar.mc.compatibility ............................................................. 476
com.avamar.mc.dashboard................................................................. 476
com.avamar.mc.dpn ........................................................................... 476
com.avamar.mc.event ......................................................................... 477
com.avamar.mc.mcvars ...................................................................... 477
/etc/hosts ................................................................................................ 478
File format and syntax ......................................................................... 478
Default /etc/hosts files ....................................................................... 478
gsankeydata.xml....................................................................................... 479
gsan.log.................................................................................................... 479
license.xml ............................................................................................... 480
Login manager configuration files ............................................................. 481
logs.DATE.tar............................................................................................. 482
mccli.xml .................................................................................................. 482
com.avamar.mc.cli .............................................................................. 482
mcclient.xml ............................................................................................. 483
com.avamar.mc.gui............................................................................. 483
mcclimcs.xml ............................................................................................ 484
Default command parameters ............................................................. 484
Profiles ............................................................................................... 484
Behavior ............................................................................................. 484
Default file settings ............................................................................. 484
Practical examples .............................................................................. 486
mcserver.xml ............................................................................................ 487
com.avamar.asn ................................................................................. 487
com.avamar.asn.module.datastore ..................................................... 488

8 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Contents

com.avamar.asn.module.mail ............................................................. 491

com.avamar.asn.service...................................................................... 492
com.avamar.mc .................................................................................. 492
com.avamar.mc.burm ......................................................................... 493
com.avamar.mc.connectemc............................................................... 494
com.avamar.mc.cr............................................................................... 494
com.avamar.mc.datadomain............................................................... 495
com.avamar.mc.dpn ........................................................................... 497
com.avamar.mc.dpn.users .................................................................. 500
com.avamar.mc.dtlt ............................................................................ 500
com.avamar.mc.event ......................................................................... 501
com.avamar.mc.ldap........................................................................... 502
com.avamar.mc.lm.............................................................................. 502
com.avamar.mc.mcsdk ....................................................................... 503
com.avamar.mc.mcsm ........................................................................ 503
com.avamar.mc.mcsvars..................................................................... 504
com.avamar.mc.mon........................................................................... 505
com.avamar.mc.repl ........................................................................... 508
com.avamar.mc.rpt ............................................................................. 508
com.avamar.mc.security ..................................................................... 509
com.avamar.mc.um............................................................................. 509
com.avamar.mc.vmware ..................................................................... 509
com.avamar.mc.wo ............................................................................. 510
mktime.custom......................................................................................... 512
mktime.out ............................................................................................... 512
ntp.conf* .................................................................................................. 512
probe.out.................................................................................................. 513
Reading a probe.out file ...................................................................... 513
Parsing and naming ............................................................................ 513
Physical versus logical node numbers ................................................. 514
Manually creating a probe.out file ....................................................... 515
probe.xml ................................................................................................. 517
Elements and attributes used by the probe.xml file ............................. 517
Processing precedence ....................................................................... 519
Example script for creating probe.xml for a single-node server ............ 520
Example probe.xml file for multi-node server....................................... 520
Example script for returning storage node addresses .......................... 521
repl_cron.cfg............................................................................................. 522
step-tickers* ............................................................................................. 522
usersettings.cfg ........................................................................................ 522
web.xml .................................................................................................... 522

Chapter 5 Important Directories

Multi-node server utility nodes.................................................................. 524
Multi-node server storage nodes ............................................................... 524
Single-node servers .................................................................................. 524
Client ........................................................................................................ 525

EMC Avamar 7.1 Technical Addendum 9

EMC CONFIDENTIAL
Contents

10 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

TABLES

Title Page

1 Revision history .......................................................................................................... 19

2 Important checkpoint verification terms and concepts ................................................ 25
3 Common HFS check error codes .................................................................................. 27
4 HFS check throttling command line options................................................................. 28
5 Types of HFS checks.................................................................................................... 29
6 Details for each HFS check type................................................................................... 29
7 Rules for automatic repair in HFS check....................................................................... 30
8 Detail elements for HFS check error elements .............................................................. 31
9 Command results when corrupted stripes are detected ............................................... 32
10 Post automatic repair considerations .......................................................................... 32
11 --modified option values ............................................................................................. 33
12 Data stripe checking example ..................................................................................... 33
13 Sample retention schedule ......................................................................................... 36
14 Data stripe file extensions........................................................................................... 39
15 Command wildcards ................................................................................................... 47
16 Numeric plug-in descriptors ........................................................................................ 48
17 Command options for the5minute_cron_run command ............................................... 51
18 Command options for the10minute_cron_run command ............................................. 52
19 Command options for the ascd command ................................................................... 53
20 Command options for the asktime command .............................................................. 54
21 Deprecated command options for the asktime command ............................................ 54
22 Environment variables used by the asktime command ................................................ 55
23 Files produced by the asktime command..................................................................... 55
24 Troubleshooting information for the asktime command............................................... 58
25 Command options for the avacl command................................................................... 60
26 Command options for the avagent command .............................................................. 61
27 Avamar-only advanced command options for the avagent command........................... 63
28 Deprecated command options for the avagent command ............................................ 66
29 Options for the avidbmaint.pl Perl script ..................................................................... 67
30 Options for the avidbmaint.pl --restore command........................................................ 67
31 Options for the avinstaller.pl Perl script ....................................................................... 68
32 User authentication mechanisms ................................................................................ 69
33 Commands for the avldap Perl script ........................................................................... 69
34 Options for the avldap Perl script ................................................................................ 70
35 Commands for the avlockboxcfg command.................................................................. 71
36 Command options for the avlockboxcfg command....................................................... 71
37 Commands for the avmaint command ......................................................................... 73
38 Global options for the avmaint command .................................................................... 75
39 Avamar-only advanced commands for the avmaint command ..................................... 76
40 Avamar-only advanced command options for the avmaint command........................... 79
41 Deprecated commands for the avmaint command....................................................... 80
42 Deprecated command options for the avmaint command ............................................ 80
43 Parameters for the avmaint access command.............................................................. 81
44 Command options for the avmaint access command ................................................... 81
45 Command options for the avmaint atrestencryption command .................................... 82
46 Command options for the avmaint autorestart command ............................................ 84
47 Files for the avmaint autorestart command.................................................................. 85
48 Parameters for the avmaint cat command.................................................................... 86
49 Command options for the avmaint cat command......................................................... 86
50 Command options for the avmaint checklogs command .............................................. 87

EMC Avamar 7.1 Technical Addendum 11

EMC CONFIDENTIAL
Tableses

51 Command options for the avmaint checkpoint command ............................................ 88

52 Deprecated command options for the avmaint checkpoint command .......................... 88
53 Parameters for the avmaint config command............................................................... 89
54 Command options for the avmaint config command .................................................... 96
55 Deprecated parameters for the avmaint config command ............................................ 97
56 Command options for the avmaint conversion command ............................................ 98
57 Parameters for the avmaint crunch command.............................................................. 99
58 Command options for the avmaint crunch command ................................................... 99
59 Parameters for the avmaint decommission command................................................ 101
60 Parameters for the avmaint ducp command .............................................................. 102
61 Parameters for the avmaint findbadhashes command ............................................... 103
62 Command options for the avmaint garbagecollect command..................................... 104
63 Command options for the avmaint gcstatus command .............................................. 105
64 Command options for the avmaint gendata command............................................... 106
65 Command options for the avmaint getclientmsgs command...................................... 107
66 Parameters for the avmaint geterrors command ........................................................ 108
67 Command options for the avmaint geterrors command.............................................. 108
68 Parameters for the avmaint getrefby command.......................................................... 109
69 Command options for the avmaint hfscheck command.............................................. 110
70 Deprecated command options for the avmaint hfscheck command ........................... 112
71 Command options for the avmaint hfscheckstatus command .................................... 114
72 XML attributes for the avmaint hfscheckstatus command .......................................... 115
73 Command options for the avmaint hfscheckthrottle command .................................. 117
74 Deprecated command options for the avmaint hfscheckthrottle command ................ 118
75 Parameters for the avmaint infomessage command................................................... 119
76 Command options for the avmaint infomessage command........................................ 119
77 Parameters for the avmaint kill command.................................................................. 120
78 Command options for the avmaint kill command....................................................... 120
79 Parameters for the avmaint logscan command .......................................................... 121
80 Attributes for the logscanfilelist/logscanfile element................................................. 122
81 Attributes for the logscanfilelist/logscanfile/logscanpattern element........................ 123
82 Parameters for the avmaint lookup command ........................................................... 124
83 Command options for the avmaint lookup command................................................. 124
84 Parameters for the avmaint ls command.................................................................... 125
85 Command options for the avmaint ls command......................................................... 125
86 Command options for the avmaint lscp command ..................................................... 126
87 Deprecated command options for the avmaint lscp command................................... 126
88 XML attributes for the avmaint lscp command ........................................................... 127
89 Parameters for the avmaint networkconfig command ................................................ 129
90 Command options for the avmaint nodelist command............................................... 130
91 Status codes for the avmaint nodelist command ....................................................... 130
92 Individual bits in full server access mode fields......................................................... 131
93 Additional information returned by the avmaint nodelist command........................... 131
94 Commands for the avmaint perf command ................................................................ 132
95 Values for the perfhistory state element .................................................................... 135
96 Command options for the avmaint ping command..................................................... 136
97 Command options for the avmaint poolcheck command ........................................... 137
98 Parameters for the avmaint rebuildstripe command .................................................. 139
99 Command options for the avmaint rebuildstripe command........................................ 139
100 Parameters for the avmaint removebadhashes command.......................................... 140
101 Parameters for the avmaint rmcp command .............................................................. 141
102 Command options for the avmaint rmcp command.................................................... 141
103 Deprecated command options for the avmaint rmcp command ................................. 142
104 Parameters for the avmaint sched command ............................................................. 143
105 Window options for the avmaint sched window command......................................... 145

12 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
TaTables

106 Command options for the avmaint sched command .................................................. 146
107 Command options for the avmaint sessions command.............................................. 150
108 Command options for the avmaint stats command.................................................... 150
109 Parameters for the avmaint stripels command........................................................... 152
110 Command options for the avmaint stripels command................................................ 152
111 Command options for the avmaint suspend command .............................................. 153
112 Parameters for the avmaint test command ................................................................ 154
113 Command options for the avmaint test command...................................................... 154
114 Parameters for the avmaint testintegrity command.................................................... 155
115 Command options for the avmaint testintegrity command ......................................... 155
116 Command options for the avmaint timesync command ............................................. 156
117 Parameters for the avmaint timing command ............................................................ 157
118 Command options for the avmaint timing command.................................................. 157
119 Parameters for the avmaint tracehash command ....................................................... 158
120 Command options for the avmaint tracehash command ............................................ 158
121 Commands for the avmgr command .......................................................................... 159
122 Command options for the avmgr command ............................................................... 162
123 Avamar-only advanced commands for the avmgr command ...................................... 166
124 Avamar-only advanced command options for the avmgr command ........................... 166
125 Deprecated command options for the avmgr command ............................................. 167
126 Parameters for the avregister.bat command .............................................................. 170
127 Command options for the avscc command ................................................................ 171
128 Command options for the avsetup_connectemc.pl Perl script.................................... 173
129 Command options for the avsetup_ems command .................................................... 174
130 Command options for the avsetup_mccli command .................................................. 175
131 Command options for the avsetup_mcs command .................................................... 176
132 Command options for the avsetup_mds command.................................................... 179
133 Command options for the avsetup_snmp command.................................................. 180
134 Command options for the avsetup_wrapper command .............................................. 181
135 Commands for the avsetup_wrapper command......................................................... 181
136 Environment variables used by the avsetup_wrapper command ................................ 182
137 Command options for the avsysconfig command....................................................... 182
138 Command options for the avsysreport command....................................................... 183
139 Command entities for the avsysreport command....................................................... 183
140 Controller command attributes for the avsysreport command.................................... 184
141 Physical disk command attributes for the avsysreport command............................... 185
142 Virtual disk command attributes for the avsysreport command ................................. 187
143 Commands for the avtar command............................................................................ 193
144 File and directory list for the avtar command ............................................................. 194
145 Command options for the avtar command ................................................................. 194
146 Avamar-only advanced command options for the avtar command ............................. 204
147 Deprecated command options for the avtar command............................................... 211
148 Script subprocessing clauses for the avtar command ................................................ 214
149 Command options for the axion_install command ..................................................... 217
150 Environment variables used by the axion_install command....................................... 218
151 Command options for the axionfs command ............................................................. 219
152 Avamar-only advanced command options for the axionfs command.......................... 222
153 Command options for the backendreport command .................................................. 222
154 Command options for the backup_upgrade_files command ...................................... 224
155 Command options for the capacity.sh shell script...................................................... 227
156 Command options for the change-passwords command............................................ 228
157 Node type designators for the change_nodetype command....................................... 230
158 Command options for the change_nodetype command ............................................. 230
159 Command options for the check.dpn command......................................................... 231
160 Deprecated command options for the check.dpn command ...................................... 232

EMC Avamar 7.1 Technical Addendum 13

EMC CONFIDENTIAL
Tableses

161 Commands for the check.mcs command ................................................................... 234

162 Command options for the check.mcs command ........................................................ 234
163 Processing behavior for database tables ................................................................... 235
164 Command options for the clean_db.pl Perl script ...................................................... 236
165 Command options for the clean.dpn command ......................................................... 238
166 Command options for the convert-probe command ................................................... 239
167 Command options for the copy-ata-drive command................................................... 240
168 Command options for the copy-checkpoint command ............................................... 242
169 Command options for the cp_cron command ............................................................ 244
170 Deprecated command options for the cp_cron command .......................................... 244
171 Command options for the cplist command ................................................................ 245
172 Deprecated command options for the cplist command .............................................. 246
173 Attributes for cplist output ........................................................................................ 246
174 Command options for the cps command ................................................................... 248
175 Command options for the cron_env_wrapper command ............................................ 249
176 Command options for the dbcreate_mds command................................................... 250
177 Command options for the dbmaint.sh shell script ..................................................... 251
178 Script files for the dbmaint.sh shell script ................................................................. 251
179 Command options for the dbpurge.sh shell script ..................................................... 253
180 Command options for the decommission.node command ......................................... 254
181 Command options for the delete-snapups command................................................. 255
182 Command options for the disktest.pl Perl script ........................................................ 257
183 Commands for the dpnctl command.......................................................................... 258
184 Command options for the dpnctl command............................................................... 259
185 Deprecated command options for the dpnctl command............................................. 262
186 Environment variables used by the dpnctl command................................................. 263
187 Files used by the dpnctl command ............................................................................ 263
188 Valid programs that allow pass-through options ....................................................... 266
189 Commands for the dpnfsctl command ....................................................................... 268
190 Command options for the dpnfsctl command ............................................................ 268
191 Environment variables used by the dpnfsctl command .............................................. 268
192 Command options for the dpnnetutil command......................................................... 269
193 Environment variables used by the dpnnetutil command........................................... 269
194 Log files for the dpnnetutil command ........................................................................ 270
195 Files modified by the dpnnetutil command................................................................ 270
196 Troubleshooting information for the dpnnetutil command ......................................... 275
197 Command options for the dpnsummary command .................................................... 277
198 File attributes in the dpnsummary .csv file ................................................................ 278
199 KEY=VALUE pairs for the dpn-time-config command .................................................. 280
200 Command options for the dpn-time-config command ................................................ 281
201 Command options for the dt command ..................................................................... 282
202 Command options for the dump_accounts command ................................................ 284
203 Command options for the dumpmaintlogs command ................................................ 285
204 Commands for the emserver.sh shell script ............................................................... 286
205 Command options for the emserver.sh shell script .................................................... 287
206 Commands for the emwebapp.sh shell script ............................................................ 288
207 Command options for the expire-snapups command................................................. 291
208 Command options for the gathergsankeydata command ........................................... 293
209 Files used by the gathergsankeydata command......................................................... 293
210 Command options for the gcblitz command .............................................................. 294
211 Command options for the gc_cron command............................................................. 296
212 Deprecated command options for the gc_cron command .......................................... 297
213 Command options for the gc_report command .......................................................... 298
214 Command options for the gen-ssl-cert command....................................................... 299
215 Command options for the getlogs command ............................................................. 301

14 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
TaTables

216 Data collected by the getsnapupstats command ....................................................... 302

217 Command options for the getsnapupstats command................................................. 302
218 Command options for the health_check.pl Perl script ................................................ 304
219 Command options for the hfscheck_cron command .................................................. 306
220 Deprecated command options for the hfscheck_cron command ................................ 308
221 Command options for the hfscheck_kill command .................................................... 310
222 Command options for the initacnt command ............................................................. 313
223 Command options for the initialize_connectemc command....................................... 314
224 Commands for the java_update.sh shell script .......................................................... 315
225 Command options for the java_update.sh shell script ............................................... 315
226 Command options for the lm command..................................................................... 316
227 Command options for the load_accounts command .................................................. 318
228 Command options for the logmrg command .............................................................. 319
229 Command options for the mapall command .............................................................. 320
230 Deprecated command options for the mapall command............................................ 321
231 Options for the mcdbmaint.sh shell script ................................................................. 323
232 Options for the mcdbsql.sh shell script ..................................................................... 324
233 Commands for the mcddrsnmp shell script................................................................ 327
234 Command options for the mcddrsnmp shell script..................................................... 327
235 Command options for the mcfeature command ......................................................... 328
236 Command options for the mcflush.pl Perl script ........................................................ 329
237 Command options for the mcgui.bat DOS batch file................................................... 330
238 Command options for the mcgui.sh shell script ......................................................... 331
239 Command options for the mcgui_login.bat DOS batch file ......................................... 332
240 Return codes for the mcgui_login.bat DOS batch file ................................................. 332
241 Event codes for the mcgui_login.bat DOS batch file................................................... 333
242 Commands for the mcserver.sh shell script ............................................................... 334
243 Command options for the mcserver.sh shell script .................................................... 335
244 Commands for the mcsnmp command ...................................................................... 338
245 Command options for the mcsnmp command ........................................................... 338
246 Command options for the mds_ctl command ............................................................ 339
247 Command options for the mktime command ............................................................. 340
248 Deprecated command options for the mktime command........................................... 340
249 Commands for the modify-snapups command........................................................... 342
250 Command options for the modify-snapups command................................................ 342
251 Command options for mondo command.................................................................... 344
252 Command options for the monmcs command ........................................................... 344
253 Command options for monthly_cron_run command .................................................. 345
254 Command options for the msgbrokerctl.pl command ................................................ 346
255 Commands for the nodedb command........................................................................ 347
256 Global options for nodedb commands....................................................................... 348
257 Environment variables used by the nodedb command............................................... 348
258 Module and node reference notation......................................................................... 349
259 Examples of comma-delimited lists of nodes............................................................. 350
260 Command options for the nodedb add if command ................................................... 351
261 Command options for the nodedb add node command ............................................. 352
262 Command options for the nodedb create command .................................................. 355
263 Command options for the nodedb delete if command ............................................... 356
264 Command options for the nodedb delete module command...................................... 356
265 Command options for the nodedb delete nat command ............................................ 357
266 Command options for the nodedb delete node command ......................................... 357
267 Command options for the nodedb print command..................................................... 358
268 Modifiers for the --nodes=NODELIST option in the nodedb print command................ 358
269 Command options for the nodedb update if command .............................................. 360
270 Command options for the nodedb update module command .................................... 362

EMC Avamar 7.1 Technical Addendum 15

EMC CONFIDENTIAL
Tableses

271 Command options for the nodedb update node command ........................................ 363
272 Command options for the nodenumbers command ................................................... 364
273 Deprecated command options for the nodenumbers command................................. 365
274 Operational status messages .................................................................................... 366
275 Command options for the opstatus.dpn command .................................................... 366
276 Commands for the permctl command........................................................................ 367
277 Command options for permctl command................................................................... 367
278 Command options for the pingmcs command............................................................ 368
279 Command options for the probe command................................................................ 368
280 Command options for the probedump command....................................................... 370
281 Command options for the probesingle command ...................................................... 371
282 Command options for the propagate-gsan command ................................................ 372
283 Command options for the psregrep command ........................................................... 373
284 Command options for the pull-checkpoint command................................................. 374
285 Command options for the rebuild.node command..................................................... 375
286 Avamar-only advanced command options for the rebuild.node command ................. 377
287 Deprecated command options for the rebuild.node command................................... 377
288 Required values for the replicate command............................................................... 379
289 Commands for the replicate command ...................................................................... 380
290 Destination descriptors for the replicate command ................................................... 381
291 Command options for the replicate command ........................................................... 381
292 Avamar-only advanced command options for the replicate command........................ 384
293 Command options for the resite command ................................................................ 387
294 Command options for the restart.dpn command........................................................ 397
295 Avamar-only advanced command options for the restart.dpn command .................... 399
296 Deprecated command options for the restart.dpn command ..................................... 400
297 Command options for the rollback.dpn command ..................................................... 402
298 Deprecated command options for the rollback.dpn command ................................... 403
299 Command options for the sched.sh script ................................................................. 404
300 Command options for the scn command ................................................................... 406
301 Avamar-only advanced command options for the scn command................................ 407
302 Commands for the securedelete command................................................................ 409
303 Command options for the securedelete command..................................................... 409
304 Command options for the showperfhistory command................................................ 411
305 Output columns for the showperfhistory command ................................................... 412
306 Command options for the shutdown.dpn command .................................................. 413
307 Deprecated command options for the shutdown.dpn command ................................ 413
308 Command options for the ssn command ................................................................... 418
309 Deprecated command options for the ssn command ................................................. 420
310 Command options for the start.dpn command........................................................... 421
311 Avamar-only advanced command options for the start.dpn command ....................... 425
312 Deprecated command options for the start.dpn command ........................................ 426
313 Command options for the start.nodes command ....................................................... 428
314 Avamar-only advanced command options for the start.nodes command ................... 429
315 Deprecated command options for the start.nodes command..................................... 430
316 Command options for the status.dpn command ........................................................ 431
317 Status codes output by the status.dpn command...................................................... 431
318 Individual bits in full server access mode fields......................................................... 432
319 Additional information returned by the status.dpn command .................................... 432
320 Command options for the store-checkpoint command............................................... 433
321 Command options for the stunctl command .............................................................. 434
322 Commands for the stunctl command ......................................................................... 435
323 Environment variables used by the stunctl command ................................................ 435
324 Command options for the suspend_crons command ................................................. 436
325 Commands for the swraidctl command...................................................................... 437

16 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
TaTables

326 Command options for swraidctl command ................................................................ 437

327 Command options for the timedist command ............................................................ 438
328 Deprecated command options for the timedist command.......................................... 439
329 Troubleshooting information for the timedist command ............................................ 440
330 Commands for the timesyncmon command............................................................... 441
331 Command options for the timesyncmon command .................................................... 441
332 Modes for the timesyncmon command...................................................................... 442
333 Command options for the tomcatctl command .......................................................... 443
334 Commands for the tomcatctl command ..................................................................... 443
335 Environment variables used by the tomcatctl command ............................................ 443
336 Command options for transfer-key command ............................................................ 445
337 Command options for the ugcheck command ............................................................ 446
338 Command options for the ugcopy command.............................................................. 447
339 Command options for the ugprep command.............................................................. 448
340 Maintenance partition files migrated or updated by the ugprep command................. 449
341 Storage server files migrated or updated by the ugprep command............................. 450
342 MCS files migrated or updated by the ugprep command............................................ 450
343 NTP files migrated or updated by the ugprep command............................................. 450
344 Files not migrated or updated by the ugprep command ............................................. 451
345 Boot labels in grub.conf ............................................................................................ 452
346 Command options for the wait.crunch command....................................................... 453
347 Deprecated command options for the wait.crunch command..................................... 454
348 Command options for the wait.dpn command ........................................................... 455
349 Commands for the website command........................................................................ 456
350 Web services verification step by Avamar server type ................................................ 458
351 com.avamar.asn.module.datastore elements............................................................ 465
352 com.avamar.avi elements ......................................................................................... 465
353 com.avamar.avi.repo elements ................................................................................. 466
354 com.avamar.avigui elements..................................................................................... 466
355 com.avamar.mc.compatibility elements .................................................................... 466
356 com.avamar.mc.dpn elements .................................................................................. 466
357 com.avamar.mc.mcsvars elements............................................................................ 467
358 config_info file entries for multi-node servers............................................................ 469
359 config_info file entries for single-node servers .......................................................... 469
360 config_info file entries for Avamar NDMP Accelerator................................................. 470
361 config_info file entries for CAT servers ....................................................................... 470
362 config_info file entries for spare nodes...................................................................... 470
363 emclient.xml file entries ............................................................................................ 471
364 com.avamar.asn settings .......................................................................................... 472
365 com.avamar.asn.module.datastore settings.............................................................. 473
366 com.avamar.asn.module.mail settings...................................................................... 473
367 com.avamar.asn.service settings .............................................................................. 473
368 com.avamar.mc settings ........................................................................................... 474
369 com.avamar.mc.ca settings....................................................................................... 474
370 com.avamar.mc.compatibility settings ...................................................................... 476
371 com.avamar.mc.dashboard settings ......................................................................... 476
372 com.avamar.mc.dpn settings .................................................................................... 476
373 com.avamar.mc.event settings.................................................................................. 477
374 com.avamar.mc.mcvars settings ............................................................................... 477
375 lm utility configuration files....................................................................................... 481
376 com.avamar.mc.cli settings....................................................................................... 482
377 com.avamar.mc.gui settings ..................................................................................... 483
378 com.avamar.asn settings .......................................................................................... 487
379 com.avamar.asn.module.datastore settings.............................................................. 488
380 com.avamar.asn.module.mail settings...................................................................... 491

EMC Avamar 7.1 Technical Addendum 17

EMC CONFIDENTIAL
Tableses

381 com.avamar.asn.service settings .............................................................................. 492

382 com.avamar.mc settings ........................................................................................... 492
383 com.avamar.mc.burm settings .................................................................................. 493
384 com.avamar.mc.connectemc settings ....................................................................... 494
385 com.avamar.mc.cr settings ....................................................................................... 494
386 com.avamar.mc.datadomain settings........................................................................ 495
387 com.avamar.mc.dpn settings .................................................................................... 497
388 com.avamar.mc.dpn.users settings........................................................................... 500
389 com.avamar.mc.dtlt settings ..................................................................................... 500
390 com.avamar.mc.event settings.................................................................................. 501
391 com.avamar.mc.ldap settings ................................................................................... 502
392 com.avamar.mc.lm settings ...................................................................................... 502
393 com.avamar.mc.mcsdk settings ................................................................................ 503
394 com.avamar.mc.mcsm settings ................................................................................. 503
395 com.avamar.mc.mcsvars settings ............................................................................. 504
396 com.avamar.mc.mon settings ................................................................................... 505
397 com.avamar.mc.repl settings .................................................................................... 508
398 com.avamar.mc.rpt settings ...................................................................................... 508
399 com.avamar.mc.security settings .............................................................................. 509
400 com.avamar.mc.um settings ..................................................................................... 509
401 com.avamar.mc.vmware settings .............................................................................. 509
402 com.avamar.mc.wo settings...................................................................................... 510
403 Numbering schemes for utilities................................................................................ 515
404 Elements used by the probe.xml file.......................................................................... 517
405 Attributes for probe.xml elements ............................................................................. 518
406 usersettings.cfg file entries ....................................................................................... 522
407 Important directories on the utility node of a multi-node server ................................. 524
408 Important directories on the storage nodes of a multi-node server ............................ 524
409 Important directories on a single-node server............................................................ 524
410 Important client directories ....................................................................................... 525

18 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

PREFACE

As part of an effort to improve its product lines, EMC periodically releases revisions of its
software and hardware. Therefore, some functions described in this document might not
be supported by all versions of the software or hardware currently in use. The product
release notes provide the most up-to-date information on product features.
Contact your EMC technical support professional if a product does not function properly or
does not function as described in this document.

Note: This document was accurate at publication time. Go to EMC Online Support
(https://support.emc.com) to ensure that you are using the latest version of this
document.

Purpose
This guide is intended to support the EMC Avamar Administration Guide and other guides
by providing additional detailed technical information that was intentionally omitted from
these guides to promote the best overall usability by a wide range of audiences.

Audience
The information in this guide is primarily intended for advanced users, EMC Field
Engineers, contracted representatives, and business partners.

Revision history
The following table presents the revision history of this document.

Table 1 Revision history

Revision Date Description

01 June 2015 Initial release of Avamar 7.2.

Related documentation
The following EMC publications provide additional information:
◆ EMC Avamar Administration Guide
◆ EMC Avamar Operational Best Practices
◆ EMC Avamar Management Console Command Line Interface (MCCLI) Programmer
Guide
◆ EMC Avamar Product Security Guide
◆ EMC Avamar and Data Domain Integration Guide
◆ EMC Avamar client documentation
◆ EMC Avamar Release Notes

Preface 19
EMC CONFIDENTIAL
Preface

Conventions used in this document

EMC uses the following conventions for special notices:

Note: A note presents information that is important, but not hazard-related.

IMPORTANT
An important notice contains information essential to software or hardware operation.

Typographical conventions
EMC uses the following type style conventions in this document:
Bold Use for names of interface elements, such as names of windows, dialog
boxes, buttons, fields, tab names, key names, and menu paths (what the
user specifically selects or clicks)
Italic Use for full titles of publications referenced in text
Monospace Use for:
• System output, such as an error message or script
• System code
• Pathnames, filenames, prompts, and syntax
• Commands and options
Monospace italic Use for variables.
Monospace bold Use for user input.
[] Square brackets enclose optional values
| Vertical bar indicates alternate selections—the bar means “or”
{} Braces enclose content that the user must specify, such as x or y or z
... Ellipses indicate nonessential information omitted from the example

Where to get help

The Avamar support page provides access to licensing information, product
documentation, advisories, and downloads, as well as how-to and troubleshooting
information. This information may enable you to resolve a product issue before you
contact EMC Customer Support.
To access the Avamar support page:
1. Go to https://support.EMC.com/products.
2. Type a product name in the Find a Product box.
3. Select the product from the list that appears.
4. Click the arrow next to the Find a Product box.
5. (Optional) Add the product to the My Products list by clicking Add to my products in
the top right corner of the Support by Product page.

20 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Preface

Documentation
The Avamar product documentation provides a comprehensive set of feature overview,
operational task, and technical reference information. Review the following documents in
addition to product administration and user guides:
◆ Release notes provide an overview of new features and known limitations for a
release.
◆ Technical notes provide technical details about specific product features, including
step-by-step tasks, where necessary.
◆ White papers provide an in-depth technical perspective of a product or products as
applied to critical business issues or requirements.

Knowledgebase
The EMC Knowledgebase contains applicable solutions that you can search for either by
solution number (for example, esgxxxxxx) or by keyword.
To search the EMC Knowledgebase:
1. Click the Search link at the top of the page.
2. Type either the solution number or keywords in the search box.
3. (Optional) Limit the search to specific products by typing a product name in the Scope
by product box and then selecting the product from the list that appears.
4. Select Knowledgebase from the Scope by resource list.
5. (Optional) Specify advanced options by clicking Advanced options and specifying
values in the available fields.
6. Click the search button.

Online communities
Visit EMC Community Network (https://community.EMC.com) for peer contacts,
conversations, and content on product support and solutions. Interactively engage online
with customers, partners and certified professionals for all EMC products.

Live chat
To engage EMC Customer Support by using live interactive chat, click Join Live Chat on the
Service Center panel of the Avamar support page.

Service Requests
For in-depth help from EMC Customer Support, submit a service request by clicking Create
Service Requests on the Service Center panel of the Avamar support page.

Note: To open a service request, you must have a valid support agreement. Contact your
EMC sales representative for details about obtaining a valid support agreement or with
questions about your account.

To review an open service request, click the Service Center link on the Service Center
panel, and then click View and manage service requests.

21
EMC CONFIDENTIAL
Preface

Facilitating support
EMC recommends that you enable ConnectEMC and Email Home on all Avamar systems:
◆ ConnectEMC automatically generates service requests for high priority events.
◆ Email Home emails configuration, capacity, and general system information to EMC
Customer Support.

Your comments
Your suggestions help us to continue to improve the accuracy, organization, and overall
quality of the user publications. Send your opinions of this document to:
[email protected]

Please include the following information:

◆ Product name and version
◆ Document name, part number, and revision (for example, 01)
◆ Page numbers
◆ Other details that will help us address the documentation issue

22 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

CHAPTER 1
Advanced Technical Information

The following topics present advanced technical information that is not found in other
Avamar documentation:
◆ Checkpoints............................................................................................................ 24
◆ Checkpoint verification ........................................................................................... 24
◆ Event throttling ....................................................................................................... 35
◆ Retention types....................................................................................................... 36
◆ Server dynamic load balancing ............................................................................... 38
◆ Storage file types .................................................................................................... 39
◆ Timezone notes ...................................................................................................... 40

Advanced Technical Information 23

EMC CONFIDENTIAL
Advanced Technical Information

Checkpoints
A checkpoint is a saved copy of the server that can be used to roll back the system. A
checkpoint folder is created on each active disk of each node of the system and in which
are stored copies of the stripes on that disk as they were at the time the checkpoint was
taken.

Full checkpoints
A full checkpoint is one where a checkpoint folder is constructed on every disk of every
node on the system. There are no offline nodes when the checkpoint is taken.

Valid checkpoints
A valid checkpoint is one that can be used to roll back a system. A full checkpoint can
always be used even if the checkpoint verification (also known as HFS check) process
detects errors. Just as it is possible to continue running the server with one node missing,
the server can be rolled back to a checkpoint that has a node missing, either due to error
or because a node has gone offline since the checkpoint was created. The server comes
up in a usable but degraded state. In this state, the missing node must be rebuilt, or
decommissioned and a node added. In both of these cases, there is substantial overhead
waiting for the server to rebuild or migrate the missing stripes. It is therefore preferable to
use full checkpoints whenever possible.

Checkpoint verification
An Avamar Hash File System check (HFS check) is an internal operation that verifies the
integrity of a checkpoint. Once a checkpoint has passed an HFS check, it is determined to
be internally consistent as of the time of the check. Subsequent disk or other hardware
failures can obsolete this determination.
The process that performs HFS checks is hfscheck. It is similar to the UNIX fsck command.
Initiating an HFS check requires significant amounts of system resources. Additionally,
during this time, the server is placed in read-only mode. Once the check has been
initiated, normal server access is resumed. You can also optionally suspend command
dispatches during this time, although this is not typically done.
If HFS check detects errors in one or more stripes, it automatically attempts to repair them.

24 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

Important terms and concepts

The following table lists important terms and concepts related to checkpoint verification.

Table 2 Important checkpoint verification terms and concepts

Term Description

Full HFS check A full HFS check is one that performs all checks on all stripes. A successful
full HFS check is considered "full and valid" and can be confidently
asserted as a rollback target.

Rolling HFS check A rolling HFS check performs checks on all index stripes, modified data
stripes, and their associated parity stripes, some number (possibly zero) of
unmodified stripes and their associated parity stripes, and finally reference
checks. A successful rolling HFS check is considered "full and valid" and
can be confidently asserted as a rollback target.

Metadata HFS check A metadata HFS check is a partial check that checks only composite data
stripes in addition to performing a reference check. A successful metadata
HFS check is a partial HFS check and should not be considered as a
rollback target.

Reference HFS check A reference HFS check is a partial check that verifies that all composite
references are valid. A successful reference HFS check is a partial HFS
check and should not be considered as a rollback target.

Full valid HFS check A full and valid HFS check is such that the checkpoint can be confidently
asserted as a rollback target.

Partial HFS check A partial HFS check is any check that is not a full and valid check.

Reduced HFS check A reduced HFS check is a non-partial check that for one reason or another is
being performed on an incomplete number of nodes. This can occur in one
of three ways:
• A full checkpoint was taken on all N nodes, but one of the nodes has
failed and the HFS check is being performed on the remaining N-1
nodes.
• One of N nodes has failed and a checkpoint was taken on the remaining
N-1 nodes. The HFS check is performed on these N-1 nodes.
• One of N nodes has failed and a checkpoint was taken on the remaining
N-1 nodes. The failed node is restored and the HFS check is now
performed. Even though all N nodes are available, the HFS check is still
only performed on the N-1 nodes which host the checkpoint files.

The cgsan process The cgsan process is a program running on the server that performs HFS
checks. It is launched on every node by the core storage server program
(gsan) with which it communicates throughout its life.

Operational overview
This topic describes how to start, control (throttle), stop, and get status for an HFS check.

Starting an HFS check

HFS checks are typically scheduled by way of Avamar Administrator.
You can also manually initiate an HFS check by running avmaint hfscheck directly from a
command shell.

Checkpoint verification 25
EMC CONFIDENTIAL
Advanced Technical Information

For an hfscheck process to successfully start, there must be two or fewer currently running
backups per storage node. For example, in a base multi-node server (with 14 storage
nodes), there must be 28 or fewer (14 x 2 = 28) currently running backups in order for
hfscheck process to successfully start. In a single-node server, there must be two or fewer
(1 x 2 = 2) currently running backups in order for hfscheck process to successfully start.
It should also be noted that the MCS periodically flushes its database and this is in fact an
avtar backup to the data server (formerly known as the GSAN). These MCS flushes are
more likely to impact performance on single-node servers because the server comprises
only a single node. You can start backups minutes after the hfscheck has started because
the server is not in read-only mode for the hfscheck process.
An HFS check once started runs to completion with no further intervention required from
the operator. To determine the status of any currently-running HFS check, use avmaint
hfscheckstatus. An HFS check can be stopped at any time by way of hfscheck_kill.

Throttling
An HFS check consumes extensive amounts of server resources. You can throttle an HFS
check to reduce contention with normal server operation.

Stopping an HFS check

To stop a currently-running HFS check operation before it has completed, use
hfscheck_kill.

Getting HFS check status

To return status for a currently-running or the most recently completed HFS check, use
avmaint hfscheckstatus.

Common hfscheck error codes

An HFS check operation can report two kinds of errors:
◆ Actual defects in the Hash File System (HFS). These errors generate an hfscheckstatus
MSG_ERR_HFSCHECKERRORS error code. The total number of errors found and the
stripe IDs that reported errors are also shown. The actual log errors can be found from
using a command such as avmaint geterrors 0.2 --alternate.
◆ Procedural errors. It is also possible for hfscheck to fail for reasons other than actual
defects in the HFS. This condition is also indicated by a status of error. In this case,
the result is of the form, MSG_ERR_XXXX.

26 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

The following table lists common HFS check error codes.

Table 3 Common HFS check error codes

Error Description Action

MSG_ERR_CGSAN_FAILED cgsan did die. Determine cause, fix, and then

rerun HFS check. This error might
indicate a problem with cgsan itself.

MSG_ERR_CMD_FAIL Preparing and starting Verify arguments and rerun HFS

cgsan failed for some check.
unknown reason.

MSG_ERR_DDR_ERROR An error occurred during Review ddrmaint log and Avamar

data verification on Data Administrator for details of Data
Domain® systems. Domain-related errors. Resolve
issues and rerun HFS check.

MSG_ERR_FORK_FAILED Data server was unable to Reduce load on system, or restart

fork or exec the cgsan system, and then rerun. It might
process. also indicate serious disk
corruption.

MSG_ERR_HFSCHECKERRORS Actual defects in the HFS Test error stripe integrity. Rollback
have been detected. to last validated checkpoint.

MSG_ERR_INPROGRESS HFS check was already Wait until completes.

running.

MSG_ERR_IO_ERROR An I/O error occurred while This probably indicates that cgsan
trying to communicate is in serious difficulties. Determine
between gsan and cgsan. cause, fix, and then rerun HFS
check.

MSG_ERR_KILLED HFS check was stopped. Rerun HFS check.

MSG_ERR_MISC cgsan probably died, or is Determine cause, fix, and then

otherwise not responding. rerun. This might be due to system
overload.

MSG_ERR_NO_CHECKPOINT No checkpoint ID was Specify a checkpoint explicitly or

specified and no unchecked create a new checkpoint.
but valid checkpoint was
found.

MSG_ERR_NODE_DOWN A node (or the software Rerun HFS check on the reduced
within a node) died. nodes, or restart the node and then
rerun HFS check.

MSG_ERR_ROLLING_CHECK A requested rolling HFS The check is abandoned. Rolling

check was against a checks must follow earlier rolling or
checkpoint that was taken full checks.
earlier than the most recent
full or rolling checked
checkpoint.

MSG_ERR_TIMEOUT Some operation such as Determine cause, fix, and then

starting cgsan did not rerun HFS check. This might be due
complete within some fixed to system overload.
period.

Checkpoint verification 27
EMC CONFIDENTIAL
Advanced Technical Information

HFS check throttling

Throttling is a control mechanism that reduces the impact of an HFS check on normal
system operation by controlling and limiting HFS check’s use of computing resources. It
does so in a partially deterministic manner so that when selecting a throttling value, one
can be reasonably certain as to the overall impact on both system and the time taken to
complete a check.
Throttling is controlled by various command line options that can be specified when an
HFS check is initiated by way of avmaint hfscheck, and also to some degree (and with
some limitations) for a currently-running hfscheck by way of avmaint hfscheckthrottle.
Two kinds of throttling can be imposed:
◆ The first kind of throttling limits the amount of work that is performed concurrently
within a node (for example, the number of data stripes processed in parallel).
◆ The second kind of throttling attempts to expand the time taken to complete
processing by a deterministic amount so as to ensure that the overall time expands
linearly with the throttlelevel parameter.
The disadvantage of throttling is that an HFS check can take considerably more time to
complete.

Throttling command line options

The following table describes each HFS check throttling command line option.

Table 4 HFS check throttling command line options

Option Description

--concurrentdatastripes=NUM Specifies the maximum number of data stripes that are

simultaneously processed on a single node during an index
sweep. The higher the value, the more concurrent work is being
performed. The default setting is 0 (one per disk).

--concurrentindexstripes=NUM Specifies the maximum number of index stripes that are

simultaneously processed on a single node during an index
sweep. The higher the value, the more concurrent work is being
performed. The default setting is 2.

--concurrentparitystripes=NUM Specifies the maximum number of parity stripes that are

simultaneously processed on a single node during a parity
sweep. The higher the value, the more concurrent work is being
performed. The default setting is 0 (one per disk).

--gccount=NUM Specifies the maximum number of index stripes that are

simultaneously processed on a single node during the refcheck
phase. The default setting is 0 (system decides based upon
available memory).

--throttle | --nothrottle Enables or disables throttling.

28 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

Types of checks performed

The five checks in the following table are recognized.

Table 5 Types of HFS checks

Check Description

Full Full checks are those that perform all checks on all stripes.

Metadata Partial check that checks only composite data stripes in addition to performing a
reference check.

Reduced Reduced checks are full checks that have completed on a reduced set of nodes. This
occurs if a checkpoint on N nodes is checked on N-1 nodes.

Reference Partial check that verifies that all composite references are valid.

Rolling A rolling HFS check performs checks on all index stripes, modified data stripes and
their associated parity stripes, some number (possibly zero) of unmodified stripes
and their associated parity stripes, and finally reference checks.

The following table shows detailed information for each check type.

Table 6 Details for each HFS check type

Check Depth Full and valid? Importance Ordering CXOR set cache

Full 10 Yes 3 Any No

Reduced 9, 7, 4 Yes 3 - -

Rolling 5 Yes 3 Forward Yes

Metadata 3 No 1 Forward No

Reference 1 No 1 Any No

Check depth measures the fullness of each check. The ordering therefore established can
be used to determine the result of applying any two of the check types. Therefore, rolling
metadata results in a rolling check of depth 8, compared with a simple rolling check that
evaluates to 5. The check depth therefore provides an easy way to compare the amount of
checking performed on different checkpoints.
The check importance is a simple value associated with a check type that determines the
order in which checkpoints are auto-deleted. The more important, the more likely the
check is to survive deletion. The older of two equally important checks is deleted. Though
in this release hidden from the user, future releases might formally introduce this to
provide better control over automatic checkpoint deletion.
Check ordering refers to order in which checkpoints might be checked. Forward indicates
that successive checks must follow the order in which the checkpoints are taken (that is,
one cannot check an earlier checkpoint after a later one).
CXOR set cache refers to the use of the saved (or cached) CXOR sets during the course of
the check. Metadata checks escape this requirement since they check all composite
stripes and so the affected CXOR sets are regenerated for all composites. However, this
restricts metadata checks to forward ordered checkpoints.

Checkpoint verification 29
EMC CONFIDENTIAL
Advanced Technical Information

Reduced checks are full or rolling checks that are not checked on all nodes. Their check
depth is therefore lower (by 1) than the corresponding full or rolling check, and their
deletion grade is considered inferior to full or rolling checks, though superior to any partial
check. A reduced metadata check is still considered a metadata check and is therefore
partial.

Automatic stripe repair

HFS check occasionally fails due to data corruption in one or more stripes. If this occurs,
the automatic repair task, which runs during the maintenance window, automatically
attempts to repair the stripes with available parity data. Automatic repair only occurs in
the current version of the stripe, not the checkpointed version.
Automatic repair is equivalent to the avmaint testintegrity --repair command and follows
the rules in the following table:

Table 7 Rules for automatic repair in HFS check

Condition Result

Data is corrupted only in the current version of Automatic repair task attempts to repair the
the stripe (not the checkpoint stripe). stripe.

Data is corrupted only in the checkpoint stripe No repair is required.

(not the current version).



Recurring repairs, especially in the same stripe, might indicate a more serious problem.
Report this behavior to EMC Customer Support.

Automatic repair attempts to fix errors in all kinds of stripes (atomic data, composite data,
index and parity), including headers. It uses the errors reported in the hfscheckerrors
element of the hfscheck log as a guide for fixing corrupted stripes.
The avmaint config option, autorepairmax=NUM, controls the behavior of automatic
repair. A NUM value of 0 disables automatic repair; otherwise, NUM sets the maximum
number of stripes that HFS check attempts to automatically repair.

Hfscheck log results

The following is a sample segment of the hfscheck log when HFS check has detected no
errors:
<hfscheckstatus nodes-queried="6" nodes-replied="6" nodes-total="6"
generation-time="1186075937" checkpoint="cp.20130727130018"
start-time="1186075816" end-time="1186075925" elapsed-time="109"
check-start-time="1186075877" check-end-time="1186075887"
status="completed" result="OK" stripes-checking="180"
stripes-completed="180" type="full">
<hfscheckerrors/>
</hfscheckstatus>

The following is a sample segment of the hfscheck log when stripe errors are detected:
<hfscheckstatus nodes-queried="6" nodes-replied="6" nodes-total="6"
generation-time="1186061751" checkpoint="cp.20130727130018"
start-time="1186061631" end-time="1186061740" elapsed-time="109"
check-start-time="1186061691" check-end-time="1186061701"

30 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

status="error" result="MSG_ERR_HFSCHECKERRORS" stripes-checking="180"

stripes-completed="180" type="full">

<hfscheckerrors>
<error stripeid="0.0-4">
<detail kind="compareindex" tag="index"
hash="e9a8db5a18c60dd211381e50306f8b5e53f0a256">
<indexelem hash="0000000000000000000000000000000000000000"
datastripeid="(none)" chunkid="0"/>
</detail>
<detail kind="compareindex" tag="index"
hash="f74c4157351212413e686b63eb0fc6c213ac9920">
<indexelem hash="0000000000000000000000000000000000000000"
datastripeid="(none)" chunkid="0"/>
</detail>
</error>
<error stripeid="0.0-C">
<detail kind="comparechunk" tag="chunkdesc"
hash="e9a8db5a18c60dd211381e50306f8b5e53f0a256">
<indexelem hash="0000000000000000000000000000000000000000"
datastripeid="(none)" chunkid="0"/>
<chunkdesc offset="4275" size="2726" type="4"/>
</detail>
</error>
</hfscheckerrors>
</hfscheckstatus>

The hfscheckerrors element contains one error element for each corrupted stripe. An error
element contains one or more detail elements that provide additional information. The
following attributes are possible in the detail element.

Table 8 Detail elements for HFS check error elements

Attribute type Attribute Description

kind abort Stripe check aborted (see log files for additional information).

comparechunk Data stripe compare to index stripe data failed.

compareindex Index stripe data compare to data stripe failed.

refcheck Data stripe or index stripe is missing a chunk.

cxorcompare Parity stripe compare to column XOR sets failed.

badelem Index stripe element is invalid or has bad owner.

header Stripe header is invalid.

changelog Stripe change log file is invalid.

offline Stripe offline due to hard disk (media) error or missing file.

badhint Composite chunk hint is invalid.

ddr Issue related to Data Domain system.

tag stripeid Stripe ID.

chunkdesc Chunk descriptor.

index Index element.

abbrev Hash abbreviation.

Checkpoint verification 31
EMC CONFIDENTIAL
Advanced Technical Information

Other indications
If corrupted stripes are detected, then the following results occur, depending on the
command.

Table 9 Command results when corrupted stripes are detected

Command Indication

avmaint hfscheckstatus HFS check displays an error.

cplist Checkpoint displays a triple-dash (---) (the checkpoint was not fully
checked) rather than hfs.

To determine whether automatic repair of a stripe was successful, view the log using the
following command:
dumpmaintlogs --types=autorepair

Look for one of the following possible results:

◆ hfscheck reported error, but testintegrity disagrees stripeid=STRIPE-ID
◆ hfscheck reported error, but testintegrity cannot repair stripeid=STRIPE-ID
◆ completed automatic stripe repair stripeid=STRIPE-ID

Post automatic repair considerations

As stated previously, automatic repair only fixes the current version of a corrupted stripe;
the checkpointed version retains its original errors. As a result, consider the following
actions and results after automatic repair.

Table 10 Post automatic repair considerations

Action Results

If a validated checkpoint is required after Assuming all stripe errors were repaired and new
automatic repair, you must take a new errors have not been introduced, the new checkpoint
checkpoint and run HFS check again. should successfully validate.

If the original checkpoint is later used for a The system rollback reintroduces the original errors
system rollback, you must then run HFS into the current version of a stripe. The new HFS
check again. check repairs the corrupted data.

32 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

Rolling HFS checks

A rolling HFS check performs checks on all index stripes, modified data stripes and their
associated parity stripes, some number (possibly zero) of unmodified stripes and their
associated parity stripes, and finally reference checks.

Modified stripes
A modified stripe is any stripe that is modified for any reason. This definition includes
stripes that are changed by direct client action (for example, chunk stores, hash inserts or
removals, and so forth):
◆ garbage collected
◆ crunched
◆ created
◆ migrated
For systems with a high ingestion rate, this broad definition might produce too many
modified stripes and so it is for further study to determine if some reduction in checking is
possible. For example, immediately after garbage collection, only the chunk ID list on a
data stripe has been modified, the data portion of the stripe awaiting being crunched.
Under such circumstances, there is a significant saving if only the chunk ID list is
validated.
As a partial solution, we provide the --modified option, which can be used to control the
selection of stripes. It is used in conjunction with --checkdata=PERCENT option to define
how many data stripes are to be checked.

Table 11 --modified option values

--modified option value Description

--modified=0 Treats all modified data stripes as equal.

--modified=1 Distinguishes data stripes that have their data portion modified from
data stripes that are modified only in some other part of the stripe set.

--modified=2 Identifies data stripes that have only had their chunk ID list changed
and skips all further checks. This improves HFS check performance by
ignoring data chunks that have been marked for deletion by garbage
collection. This is the default setting.

--modified=nn Other values are for further study.

Let N0 be the number of stripes that have their data portion modified, N1 be the number of
all modified stripes, and N2 the number of data stripes (N0 is less than or equal to N1 is
less than or equal to N2). The following table shows the number of data stripes that are
checked. Let P' be the number of data stripes corresponding to a checkdata value of P (=
P*N2 / 100).

Table 12 Data stripe checking example

Modified value P' < N1 N1 ? P

modified=0 or 2 N1 P'

modified=1 N0 P'

Checkpoint verification 33
EMC CONFIDENTIAL
Advanced Technical Information

Note that stripes modified in other than the data portion are always selected ahead of
unmodified stripes if P' > N1 and --modified=1.

Marking stripes as modified

Internally, a last written indication is currently maintained per stripe. This is separated into
two time stamps: the first marking the last write to the stripe body, and the second
marking the last write to other parts of the stripe set. When taking a checkpoint, a list of all
data and data parity stripes that have been changed since the last full, reduced, or rolling
check, along with how they were modified, is written to the checkpoint. This list is read by
cgsan when determining what stripes to check.
If the system is shut down cleanly, the modified status of all stripes is preserved and then
reread when the nodes are restarted. Therefore, it is not necessary to perform a full check
immediately after restarting the system, provided that the last shutdown was orderly.
However, if restarting a single node on a multi-node system, be aware that if the node
being restarted did not shut down cleanly, the list of modified stripes generated for the
next checkpoint might or might not be accurate, in which case the next rolling HFS check
might not check all the stripes it ought to.
Also be aware that if rebuilding a node, all stripes on that node are synced and so the first
check after the rebuild completes, if rolling, seems like a full check since the check runs at
the speed of the slowest (that is, with the most checkable stripes) node.

Parity checking
For RAIN systems, whenever a stripe is checked, a set of files (the CXOR sets), are written
and then copied to the parity stripe so it can verify its own correctness.
In order for rolling checks to finish in some reasonable time, we cheat by making use of
the CXOR sets of unchecked stripes generated the last time they were checked. By doing
this, we avoid having to scan every unmodified member of a parity group whenever any
member of that group is modified.
To do this, we create a new volume level directory, /data0x/cxorset, into which the CXOR
sets on that volume are written and where they are preserved across checks. A missing
CXOR set automatically leads to processing of the corresponding stripe.
Because the time they were written corresponds to the last time the stripe was checked,
this also solves the issue of determining which stripes are the oldest unchecked stripes on
a volume.
Unfortunately, certain checkpoint manipulations can render these CXOR sets inconsistent
within the system. For example, rolling back to other than the oldest checked checkpoint
leaves many CXOR sets in the future when compared with the stripes suddenly active.
Creating such a checkpoint and checking it might generate a great many false errors.
Deleting checkpoints might also leave the CXOR sets inconsistent. Similarly, checking
checkpoints out of the normal temporal order can also result in inconsistencies.
The system partially resolves this by imposing that rolling or metadata checks might only
check forward and not backwards (that is, they are limited to checking checkpoints that
follow on chronologically from the last checked checkpoint). We also impose that full
checks remove all CXOR sets before the check starts, therefore enabling a full check of any
checkpoint. All other HFS checks where this is an issue validate the CXOR sets before
checking to ensure their consistency.

34 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

Event throttling
The MCS has the ability to keep track of events as they are published. If a designated
number of the same event code is published in a defined period of time, the MCS
suppresses the display of some of these to better show actual overall system activity. If
this “throttling” did not occur, one rapidly recurring event code would overrun the Avamar
Administrator event display and the system administrator would not be able to view other
events.
This throttling behavior is controlled by way of the following mcserver.xml settings:
<root type="system">
<node name="com">
<node name="avamar">
<node name="mc">
<node name="event">
<entry key="throttle_repeat_count" value="10" />
<entry key="throttle_trigger_duration" value="10" />
<entry key="throttle_duration" value="600" />

These values are the default values for all events.

The throttle_repeat_count setting sets the number of events that must occur before
throttling begins.
The throttle_trigger_duration setting sets the duration in seconds during which identical
events must occur before event throttling begins.
The throttle_duration setting sets the duration in seconds for the throttling.
These three values are also defined in the event catalog for each individual event. A value
of “DEFAULT” for any of these settings in the event catalog causes the event throttler to
use the default values defined in the preferences file.
When an event is throttled, a new event, 22906 EVENT_THROTTLE_START, is published
indicating that event code is throttled. No more events of that event code are published
until the throttle duration has ended. When the throttle duration ends a new event, 22907
EVENT_THROTTLE_END is published. The event data tells the event code of the throttled
event, how many events were throttled, the date/time of the first and last throttled event.

Event throttling 35
EMC CONFIDENTIAL
Advanced Technical Information

Retention types
Beginning with version 4.0, all scheduled backups stored on the server are automatically
and programmatically assigned one or more of the following retention types by the MCS:
◆ Daily
◆ Weekly
◆ Monthly
◆ Yearly
◆ None
This is done to support certain advanced features, such as replicating only weekly,
monthly or yearly backups, or locating certain types of backups in the Backup, Restore and
Manage window.
When a scheduled backup job is about to start for a particular group, client or plug-in, an
algorithm is invoked that calculates all applicable retention types for that backup. All
applicable retention types are then included as an additional parameter in the avtar work
order XML document so that the backup can be marked with the correct retention types.
On-demand backups are always assigned a retention type of “None.”
To discuss the algorithm used to assign retention types, consider the January and February
2006 calendar months, shown below.

This is a convenient example because January 1, the first day of the first month of the year,
also falls on the first day of the week, Sunday.
The following table shows which retention types are programmatically assigned to
backups performed during this month. Some backups are omitted for clarity.

Table 13 Sample retention schedule (page 1 of 2)

Day of the Date Daily Weekly Monthly Yearly

week retention retention retention retention

Sunday January 1 x x x x

Monday January 2 x

Tuesday January 3 x

Wednesday January 4 x

Thursday January 5 x

Friday January 6 x

36 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

Table 13 Sample retention schedule (page 2 of 2)

Day of the Date Daily Weekly Monthly Yearly

week retention retention retention retention

Saturday January 7 x

Sunday January 8 x x

Monday January 9 x

Tuesday January 10 x

Wednesday January 11 x

Thursday January 12 x

Friday January 13 x

Saturday January 14 x

Sunday January 15 x x

Monday January 16 x

Tuesday January 17 x

Wednesday January 18 x

Thursday January 19 x

Friday January 20 x

Saturday January 21 x

Sunday January 22 x x

Monday January 23 x

Tuesday January 24 x

Wednesday January 25 x

Thursday January 26 x

Friday January 27 x

Saturday January 28 x

Sunday January 29 x x

Monday January 30 x

Tuesday January 31 x

Wednesday February 1 x x

Thursday February 2 x

Friday February 3 x

Saturday February 4 x

Sunday February 5 x x

Note that all backups are dailies; Sunday backups are also weeklies and the first daily
backup of each month is a monthly.

Retention types 37
EMC CONFIDENTIAL
Advanced Technical Information

Therefore, an operation involving all monthly backups for this time period would operate
on backups taken on January 1 and February 1, 2006.
An operation involving weekly backups would operate on backups taken on January, 1, 8,
15, 22 and 29, 2006; as well as the backup taken on February 5.

Server dynamic load balancing

Dynamic load balancing is a feature that enables the server to dynamically move stripes to
adjust storage utilization among nodes.
This behavior is controlled by the avmaint config balancemin=NUM command:
◆ When this value is zero, no load balancing is performed.
◆ When this value is one, all stripes except for HFS atomic data stripes are balanced
based on the count of each type of stripe on each node.
◆ For values between 2 and 99, this is a threshold percentage that triggers load
balancing. For example, a setting of 2 triggers rebalancing of a storage node if it is
0.2% less dense than the average density of all other storage nodes; a setting of 34
triggers rebalancing of a storage node if it is 3.4% less dense than the average density
of all other storage nodes.
RAIN is required for this feature to work.
Load balancing does not occur when the server is in a read-only state.
Stripes are not relocated if backups are in progress. However, once a stripe has been
relocated, its data is migrated using the same mechanism as for decommission, which
means that backups proceed, but performance is impacted.

38 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

Storage file types

In an Avamar server, data is stored on storage nodes in “stripes.” Stripes are parity
protected files that are approximately 60 MB in size.
There are two kinds of stripes in an Avamar server:
◆ Index stripes
◆ Data stripes
Actual data is stored in data stripes in chunks; their indexes are stored in index stripes.
Index stripes store the locations of the data within the data stripes, the data stripe stripe
id and the data hash “key.” Index stripes are collections of index elements that are
composed of:
◆ hashcode chunkhash;
◆ tstripeid data_stripeid;
◆ univuns chunkoffset;
◆ univshort chunksize;
In the case of the persistent store and the user accounting database, the data is
referenced by the hash of its name. For backup data, the data is referenced by the hash of
its contents.
The stripe files have different extensions depending on their function.

Table 14 Data stripe file extensions

File type Description

*.cdt Hash file system composite or directory elements.

*.dat Hash file system data (with no hash references).

*.inx Hash file system index.

*.par Local parity stripes.

*.pps Parity of Parity stripes (parity of a far parity stripes).

*.rwc Persistent store composite or directory elements.

*.rwd Persistent store data (with no hash references).

*.rwi Persistent store index.

*.sps Far parity stripes.

*.tab Contains information about modules, nodes, tunnels and stripes.

*.usd User accounting data.

*.usi User accounting index.

*.wlg Write log file. Contains changes the have not yet been applied to a stripe.

stripeidA.stripeidB A change log file that specifies the data ranges that have been made for
StripeidA by Parity StripeidB.

Storage file types 39

EMC CONFIDENTIAL
Advanced Technical Information

Timezone notes
When you select a local timezone for an Avamar server consider this information.

Maintenance window compatibility

Use a timezone that is compatible with the maintenance window. The timezone used in
avmaint sched window --timezone must be valid.

Consult the local site administrator

When possible, obtain a timezone recommendation from the local site administrator. In
the United States a local administrator typically uses one of the following timezones:
◆ America/Los_Angeles
◆ America/Denver
◆ America/Chicago
◆ America/New_York

Daylight savings time considerations

Determine whether the timezone being considered observes DST. For example the
following timezones do not observe DST:
◆ Pacific/Honolulu
◆ America/Phoenix
To determine whether a server’s current timezone observes DST, run the following shell
command (shown here for the America/Phoenix timezone):
if /usr/sbin/zdump -v /usr/share/zoneinfo/America/Phoenix
| egrep -q " `/bin/date +'%Y'` [^ ]+ isdst=1" ; then
echo "observes DST" ; else echo "does not observe DST" ; fi

This command returns:

Does not observe DST.

Avoid local timezones that ignore local DST laws

As a general policy, do not select a local timezone that is tied to GMT and ignores local
DST rules. Since these time standards do not include adjustments for local DST rules, time
displayed in the UI may appear to be inaccurate.
In some rare cases UTC is the best choice. UTC is the best alternative when a location’s
local DST rules are not consistent on a yearly basis (for example, Brazil).

Do not use GMT as local timezone for England

When selecting a local timezone for England, select Europe/London, unless you know that
the site specifically uses a different timezone. Do not select GMT (Greenwich Mean Time),
even though England is home to GMT (0 offset during standard time). This is because GMT
does not take the DST rules for England into account. For the same reason, do not select
UTC (Coordinated Universal Time).

40 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Advanced Technical Information

Select capital city or nearest large city for small countries

For small countries, select the country's capital city if it makes sense to do so. Otherwise,
select the nearest large city that it is in the same timezone and observes the same DST
rules.

Additional timezone resources

Some additional timezone-related resources are:
◆ http://www.twinsun.com/tz/tz-link.htm
This site provides useful information about timezones in general, as well as links to
useful timezone related pages.
◆ http://www.linux.org/docs/ldp/howto/TimePrecision-HOWTO/tz.html
This site provides information about creating and compiling timezone information
files.
◆ zic(8)
This is the man page for the timezone information file compiler, zic.

Timezone notes 41
EMC CONFIDENTIAL
Advanced Technical Information

42 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

CHAPTER 2
Command Reference

The following topics document Avamar command line programs, scripts, and libraries:
◆ Run locations .......................................................................................................... 47
◆ Boolean option behavior and syntax ....................................................................... 47
◆ Wildcards................................................................................................................ 47
◆ Numeric plug-in descriptors .................................................................................... 48
◆ 5minute_cron_run .................................................................................................. 51
◆ 10minute_cron_run ................................................................................................ 52
◆ ascd........................................................................................................................ 53
◆ asktime................................................................................................................... 54
◆ avacl....................................................................................................................... 60
◆ avagent................................................................................................................... 61
◆ avidbmaint.pl ......................................................................................................... 67
◆ avinstaller.pl ........................................................................................................... 68
◆ avldap .................................................................................................................... 69
◆ avlockboxcfg........................................................................................................... 71
◆ avmaint .................................................................................................................. 73
◆ avmgr ................................................................................................................... 159
◆ avregister.............................................................................................................. 170
◆ avregister.bat........................................................................................................ 170
◆ avscc .................................................................................................................... 171
◆ avsetup_avamarbin .............................................................................................. 173
◆ avsetup_avi.pl ...................................................................................................... 173
◆ avsetup_connectemc.pl ........................................................................................ 173
◆ avsetup_ems ........................................................................................................ 174
◆ avsetup_mccli....................................................................................................... 175
◆ avsetup_mcs ........................................................................................................ 176
◆ avsetup_mds ........................................................................................................ 179
◆ avsetup_snmp ...................................................................................................... 180
◆ avsetup_webstart ................................................................................................. 181
◆ avsetup_wrapper .................................................................................................. 181
◆ avsysconfig........................................................................................................... 182
◆ avsysreport ........................................................................................................... 183
◆ avtar ..................................................................................................................... 192
◆ avtar.bin ............................................................................................................... 216
◆ axion_install ......................................................................................................... 216
◆ axionfs.................................................................................................................. 219
◆ backendreport ...................................................................................................... 222
◆ backup_upgrade_files........................................................................................... 224
◆ btfix ...................................................................................................................... 226
◆ capacity.sh ........................................................................................................... 227
◆ change-passwords ................................................................................................ 228
◆ change_nodetype ................................................................................................. 230
◆ check.dpn ............................................................................................................. 231
◆ check.mcs............................................................................................................. 234
◆ checklib.pm .......................................................................................................... 234

Command Reference 43
EMC CONFIDENTIAL
Command Reference

◆ clean_db.pl........................................................................................................... 235
◆ clean.dpn ............................................................................................................. 238
◆ convert-probe ....................................................................................................... 239
◆ copy-ata-drive ....................................................................................................... 240
◆ copy-checkpoint.................................................................................................... 242
◆ cp_cron................................................................................................................. 244
◆ cplist .................................................................................................................... 245
◆ cps ....................................................................................................................... 248
◆ create_newconfigs ................................................................................................ 249
◆ cron_env_wrapper ................................................................................................ 249
◆ dbcreate_mds....................................................................................................... 250
◆ dbload.sh ............................................................................................................. 250
◆ dbmaint.sh ........................................................................................................... 251
◆ dbpurge.sh ........................................................................................................... 252
◆ dbUpdateActivitiesExt.pl....................................................................................... 254
◆ decommission.node ............................................................................................. 254
◆ delete-snapups..................................................................................................... 255
◆ disktest.pl ............................................................................................................ 257
◆ dpn.pm................................................................................................................. 258
◆ dpncron.pm .......................................................................................................... 258
◆ dpnctl ................................................................................................................... 258
◆ dpnfsctl ................................................................................................................ 268
◆ dpnnetutil............................................................................................................. 269
◆ dpnsummary......................................................................................................... 277
◆ dpn-time-config .................................................................................................... 280
◆ dt and dtsh ........................................................................................................... 282
◆ dump_accounts .................................................................................................... 284
◆ dumpmaintlogs .................................................................................................... 285
◆ emserver.sh.......................................................................................................... 286
◆ emwebapp.sh ....................................................................................................... 288
◆ errchk ................................................................................................................... 289
◆ evening_cron_run ................................................................................................. 290
◆ expire-snapups ..................................................................................................... 291
◆ gathergsankeydata ............................................................................................... 293
◆ gcblitz................................................................................................................... 294
◆ gc_cron................................................................................................................. 296
◆ gc_report .............................................................................................................. 298
◆ gen-ssl-cert ........................................................................................................... 299
◆ gethostbyname ..................................................................................................... 300
◆ getlogs.................................................................................................................. 301
◆ getnodelogs.......................................................................................................... 301
◆ getsnapupstats ..................................................................................................... 302
◆ health_check.pl .................................................................................................... 304
◆ hfscheck_cron....................................................................................................... 306
◆ hfscheck_kill......................................................................................................... 310
◆ hfsclean................................................................................................................ 312
◆ hfssetup ............................................................................................................... 312
◆ initacnt ................................................................................................................. 313
◆ initialize_connectemc ........................................................................................... 314
◆ java_update.sh ..................................................................................................... 315
◆ java_update_avi.sh............................................................................................... 316

44 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

◆ lm ......................................................................................................................... 316
◆ load_accounts ...................................................................................................... 318
◆ logmrg .................................................................................................................. 319
◆ mapall .................................................................................................................. 320
◆ mcdbmaint.sh....................................................................................................... 323
◆ mcdbsql.sh........................................................................................................... 324
◆ mcconfigfirewall_snmp ......................................................................................... 325
◆ mcddrcopy_sshkey ............................................................................................... 325
◆ mcddrcreate_sshkey ............................................................................................. 325
◆ mcddrsetup_sshkey.............................................................................................. 326
◆ mcddrsnmp .......................................................................................................... 327
◆ mcfeature ............................................................................................................. 328
◆ mcflush.pl............................................................................................................. 329
◆ mcgui.bat ............................................................................................................. 330
◆ mcgui.sh............................................................................................................... 331
◆ mcgui_login.bat .................................................................................................... 332
◆ mcserver.sh .......................................................................................................... 334
◆ mcsmon_run......................................................................................................... 338
◆ mcsnmp................................................................................................................ 338
◆ mcsnmp_cron ....................................................................................................... 338
◆ mds_ctl................................................................................................................. 339
◆ metadata_cron...................................................................................................... 339
◆ mktime ................................................................................................................. 340
◆ modify-snapups.................................................................................................... 342
◆ mondo .................................................................................................................. 344
◆ monmcs................................................................................................................ 344
◆ monthly_cron_run................................................................................................. 345
◆ morning_cron_run................................................................................................. 345
◆ msgbrokerctl.pl..................................................................................................... 346
◆ nodedb................................................................................................................. 347
◆ nodenumbers ....................................................................................................... 364
◆ opstatus.dpn ........................................................................................................ 366
◆ permctl ................................................................................................................. 367
◆ pingmcs................................................................................................................ 368
◆ probe.................................................................................................................... 368
◆ probeaux .............................................................................................................. 369
◆ probedump........................................................................................................... 370
◆ probesingle........................................................................................................... 371
◆ propagate-gsan..................................................................................................... 372
◆ psregrep ............................................................................................................... 373
◆ pull-checkpoint ..................................................................................................... 374
◆ rebuild.node ......................................................................................................... 375
◆ repl_cron .............................................................................................................. 379
◆ replicate ............................................................................................................... 379
◆ resite .................................................................................................................... 387
◆ restart.dpn............................................................................................................ 397
◆ resume_crons ....................................................................................................... 401
◆ rollback.dpn.......................................................................................................... 402
◆ rununtil................................................................................................................. 403
◆ sched.sh............................................................................................................... 404
◆ scn ....................................................................................................................... 406

45
EMC CONFIDENTIAL
Command Reference

◆ securedelete ......................................................................................................... 409

◆ showperfhistory .................................................................................................... 411
◆ shutdown.dpn ...................................................................................................... 413
◆ site_inventory ....................................................................................................... 415
◆ ssn ....................................................................................................................... 418
◆ start.dpn............................................................................................................... 421
◆ start.nodes ........................................................................................................... 428
◆ stats.sh................................................................................................................. 430
◆ status.dpn ............................................................................................................ 431
◆ store-checkpoint ................................................................................................... 433
◆ stunctl .................................................................................................................. 434
◆ suspend_crons ..................................................................................................... 436
◆ swraidctl............................................................................................................... 437
◆ timedist ................................................................................................................ 438
◆ timerange ............................................................................................................. 440
◆ timesyncmon ........................................................................................................ 441
◆ tomcatctl .............................................................................................................. 443
◆ transfer-key........................................................................................................... 445
◆ truncate ................................................................................................................ 445
◆ ugcheck ................................................................................................................ 446
◆ ugcopy.................................................................................................................. 447
◆ ugprep .................................................................................................................. 448
◆ wait.crunch ........................................................................................................... 453
◆ wait.dpn ............................................................................................................... 455
◆ website................................................................................................................. 456
◆ zzdpn.................................................................................................................... 458

46 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Run locations
Except where otherwise noted, all executable files discussed in this chapter are located in
the utility node /usr/local/avamar/bin directory and should be run from that location.

Boolean option behavior and syntax

Most Avamar command line utilities treat Boolean options in the following manner:
◆ Booleans occur in pairs—The option that sets the false condition is always prefixed
with --no. For example, --debug (run in debug mode) and --nodebug (do not run in
debug mode) comprise a complementary pair of Boolean options.
◆ One of the Boolean conditions is the default—The default condition can be either true
or false. However, in most cases, the default condition is false. It is only when the
non-default Boolean option is explicitly supplied that behavior changes. For example,
debug mode is never the default operational mode for any Avamar command line
utility. Therefore, the following commands are functionally equivalent:
avtar
avtar --nodebug

Both commands invoke avtar in normal (non-debug) mode.

Conversely, the following command positively asserts the non-default Boolean
condition to run avtar in debug mode:
avtar --debug

Wildcards
Avamar command line utilities that accept PATTERN as a value, as well as the avtar files
and directory list can use the regular expression (regex) glob operators, also known as
wildcards, that are listed in the following table. Limitations are noted where applicable.

Table 15 Command wildcards (page 1 of 2)

Operator Description

Asterisk (*) Matches zero or more occurrences of any character until the first directory
delimiter character (for example, slash on UNIX platforms and backslash on
Windows platforms) is encountered. This effectively limits the pattern
matching to a single client directory.
For example, /usr/* matches the contents of /usr but not the contents of
/usr/bin or /usr/local.

Double asterisk (**) Matches zero or more occurrences of any character. This correlates to
conventional single asterisk regex behavior.
For example, /usr/** matches the entire /usr directory structure, no matter
how many subdirectory levels are encountered.

Question mark (?) Matches one occurrence of any character. Conventional regex behavior.

Plus sign (+) Unlike regex, the plus sign is not processed as a glob operator; the plus sign
only matches a single occurrence of the plus sign.

Run locations 47
EMC CONFIDENTIAL
Command Reference

Table 15 Command wildcards (page 2 of 2)

Operator Description

Forward slash (/) Patterns beginning with forward slash (/) are assumed to be absolute path
designations for a single directory. Recursive processing of subdirectories is
disabled, and that directory name is not matched anywhere else.

[range of values] Characters enclosed in square brackets and separated by a single hyphen
(-) are interpreted as a range of values. This is conventional regex behavior.
For example:
• [0-9] matches any single numeric character
• [a-z] matches any single lowercase alpha character

Pound sign (#) In most cases, you can define multiple matching patterns in a text file and
pass that file to the utility. This is generally easier than specifying multiple
matches directly on the command line.
However, when using a text file to pass in pattern matches, the pound sign
(#) is interpreted as a comment if it appears at the beginning of a matching
pattern. This causes that entire pattern matching statement to be ignored.

Wildcard case sensitivity varies according to the computing platform for the backup.
Wildcards specified for Windows platforms are not case-sensitive, but wildcards specified
for most other platforms are case-sensitive.

Numeric plug-in descriptors

Some command options require one or more numeric plug-in descriptors as values. Valid
numeric plug-in descriptors are listed in the following table:

Table 16 Numeric plug-in descriptors (page 1 of 3)

Descriptor Description

1000 Linux avagent

1001 Linux avtar

1002 Linux Oracle RMAN

1003 Linux NDMP

1009 Linux DB2

1014 Linux Lotus

1016 Linux VMware image

1019 Linux VMware File Level Restore (FLR)

1024 Linux extended retention

1025 Linux extended retention restore

1029 Linux Sybase

1030 Linux SAP

1034 Linux extended retention import

1035 Linux VDR Migration

1038 Linux VMware image restore

48 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 16 Numeric plug-in descriptors (page 2 of 3)

Descriptor Description

1039 Linux vApp image

2000 Oracle Solaris avagent

2001 Oracle Solaris avtar

2002 Oracle Solaris RMAN

2009 Oracle Solaris DB2

2014 Oracle Solaris Lotus

2029 Oracle Solaris Sybase

2030 Oracle Solaris SAP

3000 Windows avagent

3001 Windows avtar

3002 Windows Oracle RMAN

3004 Windows Exchange message

3005 Windows Exchange database

3006 Windows SQL

3009 Windows DB2

3011 Windows Exchange 2007 database

3012 Windows Exchange 2007 web

3014 Windows Lotus

3015 Windows VSS

3016 Windows VMware image

3017 Windows MOSS

3018 Windows Exchange VSS

3019 Windows VMware File Level Restore (FLR)

3026 Windows MOSS VSS

3027 Windows Exchange Granular Level Restore (GLR)

3028 Windows MOSS Granular Level Restore (GLR)

3029 Windows Sybase

3030 Windows SAP

3032 Windows Hyper-V VSS

3033 Windows Hyper-V Granular Level Restore (GLR)

3036 Windows cluster file system

3041 Windows VMware Granular Level Restore (GLR)

4000 HP-UX avagent

Numeric plug-in descriptors 49

EMC CONFIDENTIAL
Command Reference

Table 16 Numeric plug-in descriptors (page 3 of 3)

Descriptor Description

4001 HP-UX avtar

4002 HP-UX Oracle RMAN

4009 HP-UX DB2

4029 HP-UX Sybase

4030 HP-UX SAP

5000 IBM AIX avagent

5001 IBM AIX avtar

5002 IBM AIX Oracle RMAN

5009 IBM AIX DB2

5014 IBM AIX Lotus

5029 IBM AIX Sybase

5030 IBM AIX SAP

6000 Mac OSX avagent

6001 Mac OSX avtar

7003 NetApp NDMP

8003 EMC Celerra NDMP

10000 Novell NetWare avagent

10001 Novell NetWare avtar

10003 Novell NetWare NDMP

11000 FreeBSD avagent

11001 FreeBSD avtar

12000 SCO OpenServer avagent

12001 SCO OpenServer avtar

13000 SCO UnixWare avagent

13001 SCO UnixWare avtar

14003 EMC Isilon NDMP

50 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

5minute_cron_run
The 5minute_cron_run command is intended to be run as a cron job at five-minute
intervals. The primary purpose is to run pingmcs to verify and report on the health of the
MCS.



Beginning with version 5.0, this command has been deprecated.

Synopsis
5minute_cron_run [--debug] [--help]

Options
The following options are available for the 5minute_cron_run command.

Table 17 Command options for the5minute_cron_run command

Option Description

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits.

Notes
Consider the following notes for the 5minute_cron_run command:
◆ This command reads a default operating system user ID from the SYSPROBEUSER
environment variable. If SYSPROBEUSER is not set, then remote commands are run as
user admin.
◆ You must load either the dpnid or admin OpenSSH key before running this command.

5minute_cron_run 51
EMC CONFIDENTIAL
Command Reference

10minute_cron_run
The 10minute_cron_run command is primarily intended to be run as a cron job at
ten-minute intervals. The primary purpose is to run mcsmon_run to verify and report on
the health of the MCS.



Beginning with version 5.0, this command has been deprecated.

Synopsis
10minute_cron_run [--debug] [--help]

Options
The following options are available for the 10minute_cron_run command.

Table 18 Command options for the10minute_cron_run command

Option Description

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits.

Notes
Consider the following notes for the 10minute_cron_run command:
◆ This command reads a default operating system user ID from the SYSPROBEUSER
environment variable. If SYSPROBEUSER is not set, then remote commands are run as
user admin.
◆ You must load either the dpnid or admin OpenSSH key before running this command.

52 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

ascd
The Avamar Server Communications Daemon (ASCD) facilitates communication between
the storage server (also known as GSAN) and clients. Note that some services (for
example, avmgr) that run on the Avamar server are actually clients with respect to the
storage server.
The ascd command is not intended to be run directly from the command line. It is typically
invoked by other programs, such as restart.dpn or start.dpn.

Synopsis
ascd [--autorestart] [--basedir=PATH] [--clean] [--forcestatus]
[--hfsport=PORT] [--keyfile=PATH] [--logfile=PATH] [--nodedb=PATH]
[--scanfile=PATH] [--sslport=PORT] [--verbose]

Options
The following options are available for the ascd command.

Table 19 Command options for the ascd command

Option Description

--autorestart Enables the automatic node restart feature.

This option added in version 4.1.

--basedir=PATH Specifies the full PATH of the ascd top-level (root) directory. The default
setting is /usr/local/avamar.

--clean If supplied, a new ascd log file is started.

--forcestatus Forces the perceived status of all storage server (also known as GSAN) nodes
to be up (fully operational). This is not the default.
This option added in version 4.1.

--hfsport=PORT Sets the Avamar server PORT number. The default setting is 27000.

--keyfile=PATH Specifies the full PATH and filename of the license file. The default setting is
/usr/local/avamar/etc/license.xml.

--logfile=PATH Specifies the name of the ascd logfile. If not specified, the default is
/usr/local/avamar/var/ascd.log.

--nodedb=PATH Specifies the full PATH and filename of the probe.xml file node resource
database file.

--scanfile=PATH Specifies the full PATH and filename of the enhanced server log scanning
parameters information file, which is created using the avmaint logscan
command.

--sslport=PORT Specifies the SSL data PORT. The default setting is 29000.

--verbose Provides maximum information.

ascd 53
EMC CONFIDENTIAL
Command Reference

asktime
The asktime command interactively configures Network Time Protocol (NTP) for an Avamar
server.

Synopsis
asktime [--debug] [--help] [--nodedb=FILE] [--verbose]

Options
The following options are available for the asktime command.

Table 20 Command options for the asktime command

Option Description

--debug Shows example session information but does not perform the specified
actions.

--help Shows help, then exits.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--verbose Provides maximum information.

Deprecated options
Beginning with the noted release, use of the following options is officially discouraged.
Support for these options might be discontinued entirely at any time.

Table 21 Deprecated command options for the asktime command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Notes
Consider the following notes for the asktime command:
◆ This command must be run as user dpn. This program attempts to load the dpnid
OpenSSH key from the dpn user .ssh directory. This command fails if it is run as a
different user.
◆ If asktime is run as user admin (despite being warned to quit and to run asktime as
user dpn instead), then permissions problems might occur that could prevent time
configuration files from being properly distributed. This only happens if asktime was
previously run as user dpn and then asktime is later run as user admin. The solution is
to apply chmod -R ug+rw /usr/local/avamar/var/time-config-files before running
asktime as user admin.
◆ Before making any changes to server NTP settings, shut down the server using the
dpnctl stop command.
◆ On multi-node servers, asktime must be run from the utility node.

54 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations to

IP addresses. The SYSPROBEDIR environment variable typically stores the path to a
directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the default
probe.xml location (/usr/local/avamar/var/) is used. You can also override this
location with the --nodedb=FILE option.

Environment variables
The asktime command uses the following environment variables.

Table 22 Environment variables used by the asktime command

Environment variable Description

$PATH Executable locations.

$SYSPROBEDIR Parent directory for probe.xml file and output directory.

Files produced
The asktime command produces the following files.

Table 23 Files produced by the asktime command

File Description

mktime.custom Customized script to produce a localized ntpd config file

asktime.answers File containing user responses

asktime.log Log file

The asktime command offers external servers automatically only if DNS IN A resource
records exist for the name ntp in the DNS zone of the utility node.
The following log files are of interest on the utility node, or on single-node Avamar servers:
◆ /usr/local/avamar/var/asktime.log
◆ /usr/local/avamar/var/timedist.log
◆ /usr/local/avamar/var/timesyncmon.log
◆ /usr/local/avamar/var/cron/ntpd_keepalive_cron.log
The following log files are of interest on the storage nodes in multi-node Avamar servers:
◆ /usr/local/avamar/var/timesyncmon.log
◆ /usr/local/avamar/var/ntpd_keepalive_cron.log
This application automatically rotates its log file whenever it runs and when the log file
exceeds 1 MB in size. As many as eight log files are retained.
In a multi-node Avamar system with no external time servers, two nodes are used as time
servers internal to the Avamar system: 0.s and 0.0. Isolated from external time servers,
node 0.s uses its local system clock, and all other nodes depend on that isolated system
time. This isolated system time might therefore drift from real time, but all nodes should
nevertheless synchronize to the time on the utility node.
External time servers must offer NTP (network time protocol) as described in RFC 1305.
This TCP/IP network service uses port 123/udp.

asktime 55
EMC CONFIDENTIAL
Command Reference

Processing flow
1. Ask about external time servers.
a. Can asktime programmatically find any previously specified external time servers?
No: Go to step 1(b).
Yes: Use these previously specified external time servers?
Yes: Go to step 2.
No: Go to step 1(b).
b. Can asktime programmatically determine if 'ntp' resolves in DNS?
No: Go to step 1(c).
Yes: Use these NTP servers?
Yes: Go to step 2.
No: Go to step 1(c).
c. Do you wish to use U.S. public Internet time servers?
No: Go to step 1(d).
Yes: Please enter the name of a U.S. time zone
Set $public_server for use in step 3(b).
Go to step 1(d).
d. Are there other external time servers that you would like to use?
No: Go to step 2.
Yes: Please enter the IP addresses of the external time servers
Go to step 2.
2. Ask about module addresses.
asktime must determine some important network configuration information before
proceeding any further.
In a multi-node system, asktime grants use of the internal time servers (0.s and 0.0)
only to other Avamar nodes. In a dedicated subnet, the entire subnet can be
configured to have access to the internal time servers. In a non-dedicated subnet,
permission must be granted to each node individually. In the latter case, ntpd
configuration must be updated each time a node is added.
a. Can asktime programmatically determine if this is a single-node server?
Yes: Go to step 3.
No: Do you have a dedicated Avamar subnet configuration?
No: Go to step 3.
Yes: Go to step 2(b).

56 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

b. Can asktime programmatically find any previously specified subnets?

No: Go to step 2(c).
Yes: Use these previously specified module subnets?
No: Go to step 2(c).
Yes: Go to step 3.
c. This host, <host-name>, is a member of subnet X.Y.Z.N/W. Use this subnet?
Yes: Go to step 3.
No: Please enter the subnet addresses of the other modules. Go to step 3.
3. Ask about local timezone.
a. Can asktime programmatically determine a previously specified local timezone?
No: Go to step 3(b).
Yes: Use this previously specified local time zone?
Yes: Go to step 4.
No: Go to step 3(b).
b. Is $public_server set from step 1(c)?
Yes: Go to step 4.
No: Go to step 3(c).
c. You will need to choose a local time zone... browse?
No: Go to step 3(d).
Yes: Was a valid local timezone selected?
No: Go to step 3(d).
Yes: Go to step 4.
d. Please enter the name of the local time zone.
Go to step 4.
4. Ask about nodes to configure.
Do you wish to configure the default set of nodes?
Yes: Go to step 5.
No: Please enter the list of nodes to be configured.
Go to step 5.
5. Ask whether to proceed with installation of configuration files.
Do you wish to proceed with installation?
Yes: Go to step 6.
No: Procedure complete; asktime exits.

asktime 57
EMC CONFIDENTIAL
Command Reference

6. Ask about current time.

We need an approximately current initial date and time... Is this approximately
correct?
Yes: Go to step 7.
No: Enter current time. Go to step 7.
7. Ask whether to wait and watch for time synchronization.
a. Do you wish to wait and watch for time synchronization?
Yes: Go to step 7(b).
No: Procedure complete; asktime exits.
b. We appear to have time synchronization... Do you wish to see the results?
No: Procedure complete; asktime exits.
Yes: Show time synchronization results.
Procedure complete; asktime exits.

Troubleshooting information
The following table describes how to recover from common problems encountered when
running asktime.

Table 24 Troubleshooting information for the asktime command (page 1 of 2)

Error or symptom Description or resolution

Any error involving finding or Verify that you are using the proper probe command by typing:
reading the probe.xml file which probe

The following should be returned:

/usr/local/avamar/var/probe

Verify that $SYSPROBEDIR is either not set or is set to the default

probe.xml location, /usr/local/avamar/var/), by typing:
echo $SYSPROBEDIR

Rerun probe and asktime by typing:

probe AVAMARSERVER
asktime

where AVAMARSERVER is the Avamar server hostname as

defined in corporate DNS.

58 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 24 Troubleshooting information for the asktime command (page 2 of 2)

Error or symptom Description or resolution

Any error involving a missing Ensure that the PATH variable includes /usr/local/avamar/bin/.
program

Your response, ..., was invalid This error is in response to a user entry that appears to be
incorrect. Common reasons for these errors are:
• If typing a subnet, ensure that you type a full “dotted quad”
(for example, 10.0.50.0) and not just the first few octets.
• If typing a subnet, ensure that you type a width specifier (for
example, /24, as in 10.0.50.0/24) and that the width
specified is reasonable and correct. Reasonable values range
from /24 to /29; anything outside that range is suspicious,
although asktime accepts anything from /1 to /31.
• If typing a timezone specifier, ensure that you type the
case-sensitive name of a file that exists in
/usr/share/zoneinfo/. To determine which files are available,
type ls -CRF /usr/share/zoneinfo in another command shell.

Frequently asked questions

◆ Will asktime fail gracefully if there is no NTP server?
On a single-node system, asktime does not require an NTP server, but asktime must
still be run to configure local time. The asktime command should succeed even if no
external time server is specified.
On a multi-node system, asktime uses internal nodes as NTP servers, specifically 0.s
and 0.0, when there is no external NTP server. Time synchronization among nodes,
even if isochronous, is a requirement of a multi-node Avamar server configuration. The
asktime command should therefore succeed even if no external time servers are
specified.
◆ Will the server software set the time on a single-node server for local time or GMT?
A single-node server always uses local time. It is possible to set local time to be GMT
or UTC. However, those timezones do not take UK daylight savings time rules into
account.
It should be noted that asktime sets the BIOS clock to UTC; only the system time
references a local timezone.
◆ How do you manually set the time?
One method is to run the following shell commands as root:
/bin/date --set=TIME-STRING
/sbin/hwclock --systohc --utc

where TIME-STRING is any time string that is acceptable to GNU date. For example:
• 14:40
• ‘Mon, Nov 28 2013 14:40 PST’
• ‘2 minutes ago’
The asktime command does this for you by offering an opportunity to specify the
correct time if you indicate that the time is not accurate.

asktime 59
EMC CONFIDENTIAL
Command Reference

avacl
The avacl command locates the .avamarmetafile file and restores encapsulated file
system metadata to restored files and directories. The metadata content varies by file
system. It can include Access Control Lists (ACLs), alternate data streams, and
system-defined or user-defined extended attributes.
Avamar File System (AvFS) contains avamarbin directories at the root directory of each
client name. Each avamarbin directory contain platform-specific subdirectories (for
example, aix5, hpux11, macosx, rh7.1, rh9, rhel3, rhel3-64, sol6, sol8, win32, and so
forth) that contain platform-specific avacl binaries.
You should save the client avamarbin directory to tape any time that you archive an
Avamar backup. Similarly, you must use the correct avacl binary for the platform when
restoring file system metadata.
The avacl command can only restore “like ACLs.” For example, if you archived Sun Solaris
backups to tape, you can only restore Sun Solaris ACLs. The avacl command cannot
translate those ACLs to equivalent ACLs on another computing platform.

Synopsis
avacl [--delete] [--noacls] [--norecurse] [--quiet] [--rootdir=PATH]
[--version]

Options
The following options are available for the avacl command.

Table 25 Command options for the avacl command

Option Description

--delete Deletes .avamarmetafile files after applying all of the ACLs.

--noacls Suppresses the application of ACLs. This is not the default setting.

--norecurse Does not recursively process subdirectories (processing is limited to the root
directory). This is not the default setting.

--quiet Runs quietly (suppresses status messages).

--rootdir=PATH Specifies the root directory to start processing. The default setting is the
current working directory.

--version Shows version, then exits.

Notes
Consider the following notes for the avacl command:
◆ Beginning with version 4.1, file system metadata is stored in a single .avamarmetafile
file instead of many .avamarmetadata subdirectories. For backward compatibility,
avacl is can still process .avamarmetadata subdirectories if they are found. If both
.avamarmetafile files and .avamarmetadata subdirectories are present, then
.avamarmetafile is used.
◆ The avacl command can only run on clients running version 4.1 or later Avamar
software.

60 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avagent
The avagent command is the client background process that passes backup and restore
requests to the Avamar server.
On Linux and UNIX platforms, the file name is avagent.bin.
On Microsoft Windows platforms, the file name is avagent.exe and must run as a
non-interactive service. Therefore, command line interaction with avagent.exe is not
supported on Microsoft Windows platforms.

Synopsis
avagent [--cachelifetime=DAYS] [--daemon] [--disablegui]
[--dpnacl=USER@AUTH] [--dpndomain=PATH] [--flagfile=FILE] [--help]
[--hfsaddr=AVAMARSERVER] [--hostname=NAME] [--informationals]
[{--init | --initialize}] [--ipupdateinterval=MIN]
[{--log=FILE | --logfile=FILE}] [--loglifetime=DAYS]
[--logminlifetime=DAYS] [--logsizecap=MB] [--mcsaddr=IP-ADDR]
[--netbind=HOSTNAME] [--nostdout] [--notryagain] [--nowarnings]
[--progressinterval=MIN] [--quiet] [--register]
[--reregisterinterval=MIN] [--reregisterintervalmodulo=MIN]
[--roguescaninterval=MIN] [--server=AVAMARSERVER] [--service]
[{--uninit | --uninitialize | --unregister}] [--usage]
[{--verbose | -v}] [--version]

Options
The following options are available for the avagent command.

Table 26 Command options for the avagent command (page 1 of 3)

Option Description

--cachelifetime=DAYS Specifies the length of time to keep a cache file after its
last modification. The default setting is 180 days.

--daemon On UNIX platforms, runs avagent as a UNIX daemon. The

default setting is TRUE.

--disablegui Inhibits graphical Simple Client Console (SCC) application

from running in Windows system tray or Mac dock.

--dpnacl=USER@AUTH Specifies the Avamar user ID (account name) during client

registration.
USER is the Avamar username, and AUTH is the
authentication system used by that user.
The default internal authentication domain is “avamar.”
For example: jdoe@avamar.

--dpndomain=DOMAIN Specifies the client home DOMAIN in the Avamar server

during client registration.

--flagfile=FILE Specifies a FILE containing a list of options and values

that are processed by avagent as if they were included on
the command line. The default setting is
/usr/local/avamar/etc/usersettings.cfg.

--help Shows full online help (commands, options and full

descriptions), then exits.

--hfsaddr=AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified

hostname (as defined in DNS).
Same as --server.

avagent 61
EMC CONFIDENTIAL
Command Reference

Table 26 Command options for the avagent command (page 2 of 3)

Option Description

--hostname=NAME Specifies the client machine NAME.

--informationals Enables all status messages.

--init | --initialize Registers this client with the Avamar server.

This only needs to be performed once. Subsequent calls
are ignored.

Note: This command requires Avamar superuser

privileges

Same as --register.

--ipupdateinterval=MIN Specifies the number of minutes (MIN) between soonest

IP address update notification to MCS (after IP address
changes). The default setting is 5 minutes.

--log=FILE | --logfile=FILE Enables information logging to this FILE. If no FILE value is

supplied, default log file (avagent.log) is used.

--loglifetime=DAYS Specifies the number of DAYS of log and maintenance

files to retain. The default setting is 14 days.

--logminlifetime=DAYS Specifies a log and maintenance file retention period in

DAYS. The default setting is 14 days.

--logsizecap=MB Specifies the maximum number of megabytes (MB) that

log and maintenance files can consume in each client
directory. Default setting is 512 MB.

--mcsaddr=IP-ADDR Specifies the MCS IP address (IP-ADDR).

--netbind=HOSTNAME Forces association with this HOSTNAME.

--nostdout Disables output to stdout.

However, if --logfile=FILE is supplied, output still goes to
log file.

--notryagain Does not force the client to wait when the server tells the
client to try again later.

--nowarnings Disables warning messages.

--progressinterval=MIN Specifies the number of minutes (MIN) between progress

messages to the MCS. The default setting is 1 minute.

--quiet Disables both warnings and status messages. Equivalent

to --noinformationals plus --nowarnings.

--register Registers this client with the Avamar server.

This only needs to be performed once. Subsequent calls
are ignored.

Note: This command requires Avamar superuser

privileges.

Same as --init and --initialize.

--reregisterinterval=MIN Specifies the number of minutes (MIN) between reregister

requests to the MCS. The default setting is 23 hours
(1380 minutes).

62 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 26 Command options for the avagent command (page 3 of 3)

Option Description

--reregisterintervalmodulo=MIN Specifies the number of minutes (MIN) to be used in

random number modulo calculation, which is added to
the --reregisterinterval value. The default setting is 60
minutes.

--roguescaninterval=MIN On Windows clients, specifies the number of minutes

(MIN) between rogue plug-in process scans. The default
setting is 1 minute.

--server=AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified

hostname (as defined in DNS).
Same as --hfsaddr.

--service On Windows platforms, runs avagent as a Windows

service. The default setting is TRUE.

--uninit | --uninitialize | Un-registers this client with the Avamar server.

--unregister

--usage Shows abbreviated online help (commands and options

only, no descriptions), then exits.

--verbose | -v Supplying either --verbose or -v enables all messages

(status and warnings).

--version Shows version, then exits.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 27 Avamar-only advanced command options for the avagent command (page 1 of 4)

Option Description

--acport=PORT Specifies the client agent data port number. The

default setting is 28002.
Same as --listenport=PORT.

--agent_updatedelay=MIN Specifies the number of minutes (MIN) before

agent_update class starts processing. The default
setting is 2.

--avamaronly Enables Avamar-only commands and options.

--balance-connections Forces active connection load balancing. The

default setting is TRUE.

--bindir=PATH Specifies the directory containing Avamar binary

files. The default setting is /home/root.

--browse-nfs Enables browsing of network mounted filesystems.

By default, avagent does not traverse network
mounted filesystems when browsing for files and
directories.

avagent 63
EMC CONFIDENTIAL
Command Reference

Table 27 Avamar-only advanced command options for the avagent command (page 2 of 4)

Option Description

--cachedir=DIR Sets the local cache directory. This directory is

specified during Avamar client installation. The
default setting is /root/.avamardata. Same as
--vardir=DIR.

--conntimeout=SEC Specifies the socket connect timeout in seconds

(SEC). The default setting is 5 seconds.

--ctlcallip=IP-ADDR Specifies the IP address (IP-ADDR) for CTL interface

call backs.

--ctlcallport=PORT Specifies the data port for plug-in to call backs to

parent. The default setting is port 28002.

--ctlinterface=NAME Specifies the CTL interface to use with plug-ins.

--debug Enables debugging messages.

--disable_nonlocal_listenport | Disables non-local listen port.

--disable-nonlocal-listenport

--dpnpath=PATH Specifies the location (PATH) of client machine in

server accounting system.

--encodings=ENCODING Specifies character ENCODING.

--encrypt-strength={cleartext | Sets encryption strength to one of the following:

medium | high}
• cleartext—Corresponds to the NULL-SHA cipher.
• high—Corresponds to the AES256-SHA cipher.
This is the default setting.
• medium—Corresponds to the AES128-SHA
cipher.
Supplying any other value defaults to high setting.

--encrypt=METHOD Sets the encryption METHOD. Valid settings are:

• proprietary—No encryption.
• ssl:AES128-SHA—128-bit Advanced Encryption
Standard.
• ssl:AES256-SHA—256-bit Advanced Encryption
Standard.
• ssl—A special mode in which the program
negotiates and uses the strongest encryption
setting that the session can support.
The default setting is proprietary.

--forceaddr Forces use of HFSADDR:HFSPORT.

--forcefs=FSTYPE Forces traversal of this file system type (FSTYPE).

--helpx Shows help including extended flags, then exits.

--helpxml Shows full online help (all options and full

descriptions) in XML format, then exits.

--hfsport=PORT Sets the Avamar server port number (HFSPORT).

The default setting is port 27000.

--hunt-connections Provided for backward-compatibility. Makes

avagent hunt for a server storage node.

--ignore-workorder-section=STRING | Do not parse the specified work order sections.

--ignore_workorder_section=STRING

64 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 27 Avamar-only advanced command options for the avagent command (page 3 of 4)

Option Description

--ignoreconfig Does not read any configurations files while

parsing flags. Same as --noconfig.

--ignorefs=FSTYPE Forces this file system type (FSTYPE) to be ignored

during backups.

--incpartials Includes partial backups in accounting system

queries.

--listenport=PORT Specifies the data PORT that avagent uses to listen

for MCS pages.
Same as --acport.

--logcheckinterval=MIN Specifies the number of minutes (MIN) between

checks for log file maintenance. The default setting
is 1 day (1440 minutes).

--mcsport=PORT Specifies the data PORT that avagent uses to

communicate with the MCS. The default setting is
port 28001.

--memman=MODE Sets memory debugging MODE.

--memmantrigger=MODE Sets extra memory debugging MODE.

--nagle Enables nagling.

--nat Sets whether the server is using NATing modules.

--newplugin Registers this new plug-in with the MCS.

--noconfig Does not read any configurations files while

parsing flags. Same as --ignoreconfig.

--nouserinfo Suppresses getting UID and GID mapping.

--one-file-system | -l Used with --create to only back up files on the same

local file system as the target directory.
Either --one-file-system or -l can be used.

--overrideversion=VER Overrides build version (VER) in XML.

--pizza Enables debugging messages. Same as --debug.

--rotatelogcount=NUM Specifies the rotation count (NUM) of avagent log

files. The default setting is 10 log files.

--rotatelogsize=MB Specifies the maximum size of the avagent log file

in MB.

--servbufsize=NUM Specifies the server TCP socket buffer size.

--showtimestamp Displays date/time stamp with STDERR messages.

--singleconn Makes a single connection.

--sockbufsize=NUM Specifies the client TCP socket buffer size.

--sysdir=PATH Specifies the directory containing Avamar server

files.

--syslog Sends log messages to the server. The default

setting is TRUE.

avagent 65
EMC CONFIDENTIAL
Command Reference

Table 27 Avamar-only advanced command options for the avagent command (page 4 of 4)

Option Description

--testmode Enables agent test mode.

--threadstacksize=SIZE Explicitly sets the default stack SIZE. The default

setting is zero (0), which specifies that the
operating system default stack size should be
used.

--uflagsdebug Sets debug parsing. If set, shows each option as it

is processed and each configuration file as it is
parsed.

--vardir=DIR Sets the local cache directory. This directory is

specified during Avamar client installation. The
default setting is /root/.avamardata. Same as
--cachedir=DIR.

--work_request_delay=SEC Specifies the number of seconds (SEC) to delay

requesting work after startup or hibernation. The
default setting is 180 seconds.

--workpriority=N Specifies the default workorder priority. One of the

following:
• 0—Background.
• 1—Normal.
• 2—High.

--worktickethash=HASH Specifies the session ticket HASH.

--xdrctl Uses an XDR format CTL connection.

Deprecated options
Beginning with the noted release, use of the following options is officially discouraged.
Support for these options might be discontinued entirely at any time.

Table 28 Deprecated command options for the avagent command

Option Description

--avtarflags=FLAG-LIST Deprecated in version 7.0.

Specifies a list of flags to pass into the spawned avtar
process.

--cid=CID | --clientid=CID Deprecated in version 6.0.

Specifies the client ID (CID).

--sessionid=SID | --sid=SID Deprecated in version 6.0.

Specifies the session ID (SID).

--wid=WID | --workorderid=WID Deprecated in version 6.0.

Specifies the work order ID (WID)

66 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avidbmaint.pl
The avidbmaint.pl Perl script is used to perform database-related functions for the
AvInstaller database, avidb. This script is normally not run directly, instead it is called from
other scripts.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
avidbmaint.pl [--help] [--flush] [--init] [--install] [--restore
[--restoretype=NEWSYSTEM] [--labelnum=N] [--id=UID] [--ap=PASSWORD]
[--hfsaddr=ADDRESS] [--hfsport=PORT]] [--script=FILE] [--startdb]
[--stopdb] [--test] [--testconfigured] [--update] [--version]

Options
The following options are available for the avidbmaint.pl Perl script.

Table 29 Options for the avidbmaint.pl Perl script

Option Description

--help Displays help.

--flush Flushes avidb data to the Avamar server.

--init Initializes avidb.

--install On new install calls init. On existing install calls update.

--restore Restores flushed avidb data from the Avamar server. Can be used with one
or more restore options.

--script=FILE Runs FILE as a script. If FILE ends with ".sql" then processes it as a database
script. Otherwise, FILE is processed as a shell script.

--startdb Starts avidb.

--stopdb Stops avidb.

--test Tests and displays the status of avidb.

--testconfigured Determines if avidb is configured.

--update Updates the avidb and relevant preferences after a software upgrade.

--version Displays version information.

Restore options
The following options can be used with the --restore command.

Table 30 Options for the avidbmaint.pl --restore command (page 1 of 2)

Option Description

--restoretype=NEWSYSTEM Restore to NEWSYSTEM.

--labelnum=N Restores data associated with the flush sequence number N.

--id=UID Runs restore using the user ID specified by UID.

--ap=PASSWORD Uses the password PASSWORD to run the restore.

avidbmaint.pl 67
EMC CONFIDENTIAL
Command Reference

Table 30 Options for the avidbmaint.pl --restore command (page 2 of 2)

Option Description

--hfsaddr=ADDRESS Restores from the Avamar server at the address specified by

ADDRESS.

--hfsport=PORT Restores from the Avamar server at the port specified by PORT.

avinstaller.pl
The avinstaller.pl Perl script is used to start and stop the Tomcat server. The script is
installed with the avinstaller bootstrap. It should only be used before a new install or
upgrade from 4.x or 5.x to 6.0 or newer. After an install or upgrade, use the shell script
emwebapp.sh to stop and start Tomcat.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
avinstaller.pl [--help] [--start] [--stop] [--test] [--testconfigured]
[--upgrade] [--version]

Options
The following options are available for the avinstaller.pl Perl script.

Table 31 Options for the avinstaller.pl Perl script

Option Description

--help Displays help.

--start Starts avidb and Tomcat.

--stop Stops avidb and Tomcat.

--test Tests and displays the status of avidb.

--testconfigured Determines if AvInstaller is configured.

--upgrade Updates avidb and hot-deploys the avi.war file.

--version Displays version information.

68 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avldap
The avldap Perl script is used to configure LDAP access for Avamar Client Manager and to
configure user authentication mechanisms for Avamar clients using the desktop and
laptop enhancements. LDAP configuration is shared by both features.



Beginning with version 7.0, this command has been deprecated.

The user authentication mechanisms that can be configured are listed in the following
table.

Table 32 User authentication mechanisms

Authentication Description
mechanism

LDAP Uses a domain’s LDAP-compliant directory service. Can be configured to use

either Kerberos (SASL Bind) or plaintext (Simple Bind). Kerberos is the default.

Avamar Uses traditional Avamar account authentication.

Mixed Uses both LDAP and Avamar authentication mechanisms.

NIS Uses NIS authentication for AIX, FreeBSD, HP-UX, Linux, SCO, and Solaris clients.
Can be used with any of the other authentication methods.

This script must be run as root. Also, this script relies on Java classes in aam.war, the web
archive file for Avamar Client Manager which is part of a normal Avamar installation.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
avldap {--test [--verbose] | --show | --configdomain [--verbose] |
--configauth | --help [--test | --show | --configdomain |
--configauth] }

Commands
The following commands are available for the avldap Perl script.

Table 33 Commands for the avldap Perl script (page 1 of 2)

Command Description

--test Parses /usr/local/avamar/etc/ldap.properties and verifies:

• LDAP configuration, either Kerberos or plain-text
• NIS authentication
Tests the default server’s information, or uses a FQDN, username, and
password you provide to test a non-default server.

avldap 69
EMC CONFIDENTIAL
Command Reference

Table 33 Commands for the avldap Perl script (page 2 of 2)

Command Description

--show Displays information about the current LDAP access configuration for Avamar
Client Manager and the user authentication mechanisms for Avamar clients
using the desktop and laptop enhancements. Only the information related to
LDAP configuration applies to Avamar Client Manager.
Displays:
• LDAP type: Kerberos or plaintext
• Encryption types set in /usr/local/avamar/etc/krb5.conf
• FQDN of default server
• Each server that is configured in krb5.conf, including FQDN and URL
• Errors in ldap.properties
• Login screen state
• NIS authentication details

--configdomain Configures Avamar with the server information required to allow user
authentication on Avamar clients through an LDAP-compliant directory
service, and to allow Avamar Client Manager to obtain information from an
LDAP-compliant directory service.
Configures Avamar with the server information required to allow user
authentication through NIS for Avamar clients running on AIX, FreeBSD,
HP-UX, Linux, SCO, or Solaris.

--configauth Specifies the authentication mechanism to use and makes changes in

ldap.properties to support the selected mechanism. Restarts services to apply
the configuration changes.
Offers the following authentication choices:
• Kerberos—LDAP using SASL Bind
• Non-Kerberos—LDAP using Simple Bind
• Avamar—Traditional Avamar account authentication
• Mix—Uses both LDAP using SASL Bind, and Avamar authentication
Additionally provides the ability to enable or disable:
• Pass-through authentication
• NIS

--help Displays help. Use an option to display help about a specific command.

Options
The following options are available for the avldap Perl script.

Table 34 Options for the avldap Perl script

Option Description

--verbose Use with either of the following commands:

• --test
• --configdomain
Displays trace output for LDAP queries, Kerberos authentication information,
and Java exceptions.

--test Use with --help to display help information about the --test command.

--show Use with --help to display help information about the --show command.

--configdomain Use with --help to display help information about the --configdomain
command.

--configauth Use with --help to display help information about the--configauth command.

70 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avlockboxcfg
The avlockboxcfg command is used to configure and manage the Avamar RSA Lockbox.



Beginning with version 6.0, this command has been deprecated.

Synopsis
avlockboxcfg {changepassphrase | create | rekey | setcredentials |
setthreshold} [--avamarpassword=PASSWORD] [--avamaruser=USERNAME]
[--flagfilepath=PATH] [--lblibpath=PATH]
[--newpassphrase=PASSPHRASE] [--passphrase=PASSPHRASE]
[--path=PATH] [--threshold=NUM]

Commands
All avlockboxcfg commands require that the user log in to the Avamar server using the
operating system root password and supply the current Lockbox password (passphrase)
using the --passphrase=PASSPHRASE option. Supply one and only one of the following
commands on each command line.

Table 35 Commands for the avlockboxcfg command

Command Description

changepassphrase Changes the passphrase for the specified lockbox.

create Creates a lockbox at the given path. Requires --newpassphrase.

rekey Regenerates the internal encryption key for the specified lockbox.

setcredentials Stores the credentials for the default Avamar user on the utility node in the
lockbox. Optionally uses --flagfilepath to specify the path to the
usersettings.cfg file. If --flagfilepath is not specified, then
/usr/local/avamar/etc/usersettings.cfg is used.

setthreshold Sets the system stable values threshold for the specified lockbox.

Options
The following options are available for the avlockboxcfg command.

Table 36 Command options for the avlockboxcfg command (page 1 of 2)

Option Description

--avamarpassword=PASSWORD PASSWORD for the default utility node Avamar username.

--avamaruser=USERNAME The default utility node Avamar USERNAME.

--flagfilepath=PATH Specifies the path to the usersettings.cfg file. If --flagfilepath is

not specified, then /usr/local/avamar/etc/usersettings.cfg is
used.

--lblibpath=PATH EMC internal use only.

Specifies the path to the Avamar shared encryption libraries.
The default path is /usr/local/avamar/lib.

avlockboxcfg 71
EMC CONFIDENTIAL
Command Reference

Table 36 Command options for the avlockboxcfg command (page 2 of 2)

Option Description

--newpassphrase=PASSPHRASE Specifies a new PASSPHRASE for the specified Avamar

lockbox.
The new passphrase must meet the following complexity
requirements:
• Contains 8 or more characters
• Contains at least one numeric character
• Contains at least one uppercase and one lowercase
character
• Contains at least one non-alphanumeric character (for
example, !@#$%, and so forth).

--passphrase=PASSPHRASE Existing PASSPHRASE for the specified Avamar Lockbox. The

default passphrase is the factory default Avamar root
password.
This option is required for all avlockboxcfg administrative
operations.

--path=PATH Specifies the path and filename of the lockbox. Either relative
or absolute paths are acceptable. The default path and
filename are /usr/local/avamar/var/avlockbox.clb.
If not explicitly supplied, the program recursively searches for
a lockbox file beginning in the default location.

--threshold=NUM Specifies the number (NUM) of system stable values that must
exactly match in order verify the identity of the machine
attempting to access it. The default setting is 5 system stable
values.

Notes
Consider the following notes for the avlockboxcfg command:
◆ All avlockboxcfg administrative operations require that the user log in to the Avamar
server using the operating system root password and know the current lockbox
password (passphrase).
◆ This command added in version 5.0.

72 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint
The avmaint command is a command line maintenance and statistics gathering program
for the Avamar server.
The avmaint command is highly complex, with many powerful commands. Therefore, for
the sake of clarity, many avmaint commands are documented as if they were entirely
separate utilities. Furthermore, only options that are truly global in nature (that can be
supplied with any avmaint command) are documented in this topic. Options that are
specific to one or more commands are documented with those commands.

Synopsis
avmaint {autorestart | cat ATOMIC | convstatus | cpstatus |
datacenterlist | ducp CP-ID | gcstatus | getclientmsgs |
geterrors NODE-ID | hfscheckstatus | kill SESSION-ID |
lockcp [--lock | --unlock] CP-ID | ls LOCATION | lscp | nodelist |
perf {reset | status} | ping | resume | rm PATH | sessions | stat
OBJECT | stats | stripels STRIPELIST | suspend | tunnellist}

[{--account=LOCATION | --acnt=LOCATION}] [--ap=PASSWORD]

[--flushDB] [--forceaddr] [--help] [--helpxml]
[--hfsaddr=AVAMARSERVER] [--hfsport=PORT] [--id=USER@AUTH]
[--informationals=N | --noinformationals] [--log] [--logfile=FILE]
[--maxlines=NUM] [--path=LOCATION] [--pswd=PASSWORD] [--quiet]
[--tryagain] [--usage] [{--verbose | -v}] [--version]
[--xmlperline=NUM]

Commands
Supply one and only one of the following commands on each command line.

Table 37 Commands for the avmaint command (page 1 of 2)

Command Description

autorestart Controls the Avamar automatic node restart feature.

This command added in version 4.1.

cat ATOMIC Lists the contents of persistent ATOMIC.

convstatus Returns the cumulative status of server stripe conversion operations.

You should include the --xmlperline=NUM global option to control
the number of XML attributes per line.

cpstatus Returns the status of currently running or most recently run

checkpoint.
You should include the --xmlperline=NUM global option to control
the number of XML attributes per line.

datacenterlist Lists Avamar modules (datacenters).

You should include the --xmlperline=NUM global option to control
the number of XML attributes per line.

ducp CP-ID Lists the hard drive space consumed by a specific checkpoint (CP-ID).

gcstatus Returns the status for an ongoing or the most recently completed
garbage collection process.

getclientmsgs Returns the contents of the client message store.

avmaint 73
EMC CONFIDENTIAL
Command Reference

Table 37 Commands for the avmaint command (page 2 of 2)

Command Description

geterrors NODE-ID Return errors from the specified NODE-ID, which can be obtained
using the nodelist command.

hfscheckstatus Returns the status of a currently running HFS check operation.

kill SESSION-ID Stops this client SESSION-ID.

lockcp Locks a checkpoint (CP-ID) to prevent it from being automatically

[--lock | --unlock] validated by HFS checked or deleted. If --unlock is supplied, the
CP-ID
checkpoint is unlocked so that it can be automatically validated or
deleted. --lock is the default.

ls LOCATION Lists all objects in this LOCATION and below.

You should include the --xmlperline=NUM global option to control
the number of XML attributes per line.

lscp Lists available checkpoints.

nodelist Returns the status of all nodes.

perf {reset | status} avmaint perf status returns the operational status for the entire
server or specified nodes.
avmaint perf reset resets the performance monitoring statistics.

ping Returns stripe status.

resume Restarts suspended Avamar client sessions.

In certain circumstances (primarily, if multiple avmaint suspend
commands were issued), avmaint resume might need to be issued
multiple times to fully resume all suspended operations.

rm PATH Removes the specified persistent store map element, where PATH is
the location of a persistent store map element on the server.

sessions Returns information on the current active client sessions. Output

displays in XML format.

stat OBJECT Returns the status of persistent OBJECT.

stats Returns the status of all stripes by sending a message to each stripe
and receiving back some information about each stripe that
responds.

stripels STRIPELIST Displays file data for specified list of stripes (STRIPELIST).

suspend Temporarily halts client activities and denies new client requests.

tunnellist Lists the tunnels.

You should include the --xmlperline=NUM global option to control
the number of XML attributes per line.
This command does not output plain text. Output is strictly XML.

74 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Global options
The following global options are available for the avmaint command.

Table 38 Global options for the avmaint command (page 1 of 2)

Option Description

--account=LOCATION | Supplying either --account=LOCATION or --acnt=LOCATION

--acnt=LOCATION specifies a hierarchical LOCATION on the Avamar server. This
option is relative to the current home location, unless a slash (/) is
used as a prefix to the path designation, in which case an absolute
path is assumed.
Same as --path=LOCATION.

--ap=PASSWORD PASSWORD for the --id=USER@AUTH account.

Same as --pswd=PASSWORD.

--flushDB Flushes debug output after every message.

--forceaddr Forces use of values specified by the --hfsaddr and --hfsport

options.

--help Shows full online help (commands, options and full descriptions),
then exits.

--helpxml Shows full online help (commands, options and full descriptions)
in XML format, then exits.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS).
This value is typically recorded in a configuration file. It can also be
set by way of an environment variable or on the command line with
each transaction. The default address is localhost (127.0.0.1).
Same as --server=AVAMARSERVER.

--hfsport=PORT Sets the Avamar server PORT number. The default setting is 27000.

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication
domain is “avamar.”
For example: jdoe@avamar.

--informationals=N | Supplying --informationals=N sets information level. For example,

--noinformationals --informationals=3.
Supplying --noinformationals disables all status messages.

--log Redirects and appends output to an alternative log file specified by

the --logfile=FILE option.

--logfile=FILE Used with the --log option to specify the full path and filename of
the alternative log file.

--maxlines=NUM Specifies the maximum number (NUM) of lines to write to the log
file or number of log entries to return.
The default setting is zero (i.e, return all lines or entries).

--path=LOCATION Specifies a hierarchical LOCATION on the Avamar server. This

option is relative to the current home location, unless a slash (/) is
used as a prefix to the path designation, in which case an absolute
path is assumed.
Same as --acnt=LOCATION.

avmaint 75
EMC CONFIDENTIAL
Command Reference

Table 38 Global options for the avmaint command (page 2 of 2)

Option Description

--pswd=PASSWORD Specifies PASSWORD for the --id=USER@AUTH account.

Same as --ap=PASSWORD.

--quiet Suppresses all debugging messages.

--tryagain If server is idle, try completing this operation later. This is the
default setting.

--usage Displays a list of available options, then exits.

--verbose | -v Supplying either --verbose or -v enables all messages (status and

warnings).

--version Shows version, then exits.

--xmlperline=NUM Controls number (NUM) of XML attributes per line.

Avamar-only commands
Avamar-only commands access advanced functionality that is normally reserved for use by
EMC personnel only. These commands require that you include the --avamaronly option to
emphasize this point.
Misuse of these advanced commands can cause loss of data. If you are unsure about any
aspect of these commands, contact EMC Customer Support for additional information
before using them..

Table 39 Avamar-only advanced commands for the avmaint command (page 1 of 3)

Command Description

access MODE Sets the server access MODE to one of the following:
• admin
• normal
• readmigrate
• readonly
• sync

cancelremovebadhashes Cancels a pending find/delete bad hash operation and

returns the server to a fully operation state.
This command added in version 4.1.

avmaint checklogs Controls retention and deletion of entries in the checklogs

cache.
This command added in version 6.0.

checkpoint Starts a checkpoint process.

config Configures internal characteristics of the server.

If avmaint config is run without parameters, it returns a
current list of server configuration settings.

conversion Converts older format data stripes to latest version.

76 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 39 Avamar-only advanced commands for the avmaint command (page 2 of 3)

Command Description

crunch ACTION Performs one of the following ACTIONs:

• limit
• status
• reset
• rollover
• resetandrollover
• factoryreset

decommission Decommissions a storage node or an individual disk within a

storage node.

findbadhashes Returns a list of hashes and backups that are suspected to be

bad, as well as a verification token, which must be supplied
to removebadhashes to remove bad hashes from the server.
This command added in version 4.1.

garbagecollect Starts a garbage collection process.

gckill Stops a garbage collection process.

gendata Generates data chunks for testing purposes.

getrefby TYPE HASH Returns all hashes of a specified TYPE that reference this
HASH.

hfscheck Initiates an HFS check operation.

If avmaint hfscheck is run without options, an HFS check is
performed on the most recent unvalidated checkpoint file.

hfscheckstop Terminates a currently running HFS check operation.

This command does not output plain text. Output is strictly
XML. You should include the --xmlperline=NUM global option
to control the number of XML attributes per line.

hfscheckthrottle Overrides throttle values for an in-process HFS check

operation.

infomessage TEXT Writes this TEXT message to the server log.

init {admin | fullaccess} Sets the server run level to one of the following:
• admin—Administration-only mode (only root and aroot
users can access the server).
• fullaccess—Full access by all users.

license LICENSEFILE Creates a new Avamar server license from LICENSEFILE, where
LICENSEFILE is the full path to a valid Avamar server license
file.
/usr/local/avamar/etc/license.xml is the default license
filename and location.
You must include the --avamaronly option to use this
command.

logscan [FILE] Enables enhanced server log scanning, which detects and
reports certain kinds of hardware failures.

lookup [H | P | U] HASH Looks up the supplied HASH and returns information about
the associated index and data stripes.

avmaint 77
EMC CONFIDENTIAL
Command Reference

Table 39 Avamar-only advanced commands for the avmaint command (page 3 of 3)

Command Description

networkconfig FILE Displays or modifies server network configuration.

You must include the --avamaronly option to use this
command.
This command added in version 5.0.

nodestate NODE-ID=STATE Sets this NODE-ID to this STATE.

poolcheck Validates the integrity of the server free file pool.

This command added in version 5.0.

rebuildstripe Rebuilds offline stripes. This command accepts either a

{STRIPE-ID | --full} STRIPE-ID or the --full option.

removebadhashes Removes a set of hashes that are tied to a specific verification

token.
This command added in version 4.1.

rmcp {CP-ID | --full} Removes one or more checkpoints.

rmhash [H]HASH ... Removes one or more unreferenced hashes, where HASH is a
20-byte SHA-1 hash. Multiple hashes are separated by white
space.
You must include the --avamaronly option to use this
command.

sched Configures and manages server maintenance windows and

maintenance operations.
This command added in version 5.0.

shutdown {--force | --now} Shuts down the Avamar server. Two modes are available:
• --force—Causes all processes to stop immediately without
sending any special information to the current client
sessions. This interrupts current users of the system.
• --now—Gracefully stops the Avamar server. Connected
clients receive a SERVER_EXITING error immediately before
the server closes the connection socket. This is the default
mode if no options are supplied.

stripestate STRIPE-ID=STATE Sets this STRIPE-ID to this STATE.

test Simulates internal server hardware faults for testing

purposes.

testintegrity STRIPE-ID Tests the integrity of STRIPE-ID and its parity group. Status for
each of the stripes in the parity group is returned; returned
status codes are good, corrupt, or unknown.

timesync Synchronizes server times with client.

timing OPERATION Times server OPERATIONs:

• addhashdata
• gethashdata
• ispresent
• ping
• refcheck

tracehash HASH Traces the specified HASH.

78 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 40 Avamar-only advanced command options for the avmaint command (page 1 of 2)

Option Description

--acport=PORT Specifies the client agent data port number. The default setting is
28002.
Same as --listenport=PORT.

--avamaronly Enables Avamar-only commands and options.

--balance-connections Forces active connection load balancing. The default setting is

TRUE.

--cachedir=DIR Sets the local cache directory. The default setting is

/usr/local/avamar/var.
Same as --vardir=DIR.

--ctlcallport=PORT Specifies the data port plug-ins for communication with parent. The
default setting is 28002.

--ctlinterface=NAME If not empty, use this control interface NAME specified in plug-ins.

--encodings=NAME Specifies character encodings.

--encrypt=METHOD Sets the encryption METHOD. Valid settings are:

• proprietary—No encryption
• ssl:AES128-SHA—128-bit Advanced Encryption Standard
• ssl:AES256-SHA—256-bit Advanced Encryption Standard
• ssl—A special mode in which the program negotiates and uses
the strongest encryption setting that the session can support.
The default setting is proprietary.

--expires= Specifies backup expiration as number of days from today

{NUM-DAYS | TIMESTAMP} (NUM-DAYS) or an absolute TIMESTAMP.

--flagfile=FILE Specifies a FILE containing a list of options and values that are
processed by avmaint as if they were included on the command
line. The default setting is /usr/local/avamar/etc/usersettings.cfg.

--follow Follow output data as atomic grows.

--hunt-connections Hunt for a server storage node.

--incpartials Include partial backups in accounting system queries.

--listenport=PORT Specifies the client agent data port number. The default setting is
28002.
Same as --acport=PORT.

--mcsport=PORT Specifies the data PORT that avmaint uses to communicate with the
MCS. The default setting is port 28001.

--node=NODE-ID Sets the NODE-ID for hard drive shutdowns.

--nostdout Disables output to STDOUT.

However, if --logfile=FILE is supplied, output still goes to log file.

--nowarnings Disables warning messages.

avmaint 79
EMC CONFIDENTIAL
Command Reference

Table 40 Avamar-only advanced command options for the avmaint command (page 2 of 2)

Option Description

--overrideversion=VER Overrides build version (VER) in XML.

--rotatelogcount=NUM Specifies the rotation count (NUM) of avmaint log file. The default
setting is 10.

--rotatelogsize=MB Specifies the maximum size of avmaint log file in MB.

--servbufsize=NUM Specifies the server TCP socket buffer size.

--showtimestamp Displays date/time stamp with STDERR messages.

--sockbufsize=NUM Specifies the client TCP socket buffer size.

--threadstacksize=KB Explicitly sets the default stack size in kilobytes (KB). The default
setting is zero (0), which specifies that the operating system default
stack size should be used.

--vardir=DIR Sets the local cache directory. The default setting is

/usr/local/avamar/var.
Same as --cachedir=DIR.

Deprecated commands
Beginning with the noted release, use of these commands is officially discouraged in favor
of the alternative. These commands might not work in subsequent releases.

Table 41 Deprecated commands for the avmaint command

Command Description

perfstatus [NODE-ID] Deprecated in version 4.1 in favor of the avmaint perf command.
Returns detailed operational data for all server nodes or specified
nodes. If one or more NODE-IDs are supplied, then detailed
operational data is returned for those nodes only; otherwise, data for
all nodes is returned.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 42 Deprecated command options for the avmaint command

Option Description

--checkserverversion={TRUE | FALSE} Deprecated in version 4.0.

Verifies avmaint build version against server build
version to avoid possible incompatibilities. The
default setting is true.

Notes
If the Avamar username and password are present in the .avamar file then
--id=USER@AUTH and --password=PASSWORD are not required on the command line.

Output
Output goes to STDOUT, except for errors, which go to STDERR.

80 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint access
The avmaint access command sets server access mode.
The avmaint access command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint access commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint access {admin | normal | readmigrate | readonly | sync access}
[--preconditions={available | nobackups | online} --avamaronly
GLOBAL-OPTIONS

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint access command.

Table 43 Parameters for the avmaint access command

Parameter Description

admin Writing by server and root user only.

normal Writing by everyone.

readmigrate Writing by server only.

readonly No writing allowed.

sync Writing by server only.

Command options
The following command option is available for the avmaint access command.

Table 44 Command options for the avmaint access command

Option Description

--preconditions= {available | Specifies pre-conditions for setting server access mode.

nobackups | online} One of the following:
• available—Only set server access mode if all stripe
groups are available.
• nobackups—Only set server access mode if no backups
are in progress.
• online—Only set server access mode if all stripes are
online (none are restarting, migrating, offline); media
errors are allowed.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

avmaint 81
EMC CONFIDENTIAL
Command Reference

avmaint atrestencryption
The avmaint atrestencryption command is used to add a new at-rest encryption key. This
is done by specifying a user-defined character string (salt), which is used to create a new
secure encryption key.
Key management is completely automatic:
◆ Old encryption keys are automatically stored in a secure manner so that data stripes
encrypted with previous keys can always be decrypted and read.
◆ Over time, during server maintenance, crunched stripes are converted to use the most
current key.
The avmaint atrestencryption command is considered an advanced command for expert
users. You must include the --avamaronly option with all avmaint atrestencryption
commands. If you are unsure about any aspect of this command, contact EMC Customer
Support for additional information before using it.

Synopsis
avmaint atrestencryption {--restpassword=’PASSWORD’ |
--restsalt=’ENCRYPTIONKEYSALT’}--avamaronly GLOBAL-OPTIONS

Command options
One and only one of the following options must be supplied for each avmaint
atrestencryption command.

Table 45 Command options for the avmaint atrestencryption command

Option Description

--restpassword=’PASSWORD’ Specifies a new at-rest encryption PASSWORD, which is

used by the system to access the salt table in the
persistent store. PASSWORD can contain any character
(ASCII as well as multi-byte character sets are supported)
and should be enclosed in single quotes. Empty strings
are not allowed.

--restsalt=’ENCRYPTIONKEYSALT’ Specifies a new ENCRYPTIONKEYSALT character string

that will be used to create a new at-rest encryption key.
ENCRYPTIONKEYSALT can contain any character (ASCII as
well as multibyte character sets are supported) and
should be enclosed in single quotes. Empty strings are
not allowed.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command added in version 6.1.
You must include the --avamaronly option.

82 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Enabling at-rest encryption from the command line

Typically, at-rest encryption is enabled during the installation workflow. You can also
enable at-rest encryption from the command line.



Do not enable at-rest encryption during the maintenance window or when backups are
running. For best results, perform this task during the backup window with the scheduler
disabled.

1. Open a command shell and log in as admin.

2. Type the following commands in this order:
avmaint atrestencryption --restpassword='PASSWORD' --avamaronly
avmaint atrestencryption --restsalt='ENCRYPTIONKEYSALTPHRASE'
--avamaronly

where:
• PASSWORD is a new at-rest encryption password.
• ENCRYPTIONKEYSALTPHRASE is a user-defined character string (salt), which is used
to create a new secure encryption key.
3. Wait for these commands to complete.
4. Verify that at-rest encryption has been successfully enabled by typing:
avmaint nodelist --xmlperline=9999 | grep atrestencryption

Information similar to the following appears in the command shell:

<atrestencryption-status enabled="true" nr-salts="1"/>

where:
• enabled="true" nr-salts="1" indicates that at-rest encryption is enabled.
• enabled="false" nr-salts="0" indicates that at-rest encryption is not enabled.

avmaint 83
EMC CONFIDENTIAL
Command Reference

avmaint autorestart
The avmaint autorestart command controls the automatic node restart feature. If enabled,
the Avamar automatic node restart feature detects certain kinds of storage server (also
known as GSAN) node failures and automatically restarts a single affected node if it is
determined that it is safe to do so.
Various checks are performed to ensure that the storage server (also known as GSAN) is
not restarted under circumstances that could compromise system integrity:
1. All nodes must agree on the failure of a node before it is deemed to have failed.
2. Multiple node failures for any reason inhibit the automatic node restart feature from
restarting any node.
3. If the gsan process is found still to be running on an apparently failed node (this might
occur if network communications are less than optimal), then no action is taken.
4. A restarted gsan process is not restarted if it immediately fails. This restriction is
removed as soon as the server reaches fullaccess mode with all stripes online.
5. If ~admin/autorestart is not present, then the node is assumed to be eligible for
automatic restart.

Synopsis
avmaint autorestart [--disable | --enable]
[--forcestatus={up | down}[@IP-ADDR]] [--restart=IP-ADDR] [--sync]
GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint autorestart command.

Table 46 Command options for the avmaint autorestart command

Option Description

--disable Disables the automatic node restart feature.

--enable Enables the automatic node restart feature.

If the automatic node restart feature was previously disabled, and a
node is in a condition such that it can be restarted, then enabling the
automatic node restart feature restarts that node.

--forcestatus={up | Forces perceived status of all storage server (also known as GSAN)
down}[@IP-ADDR] nodes to be either up (fully operational) or down (non-functioning).
Supplying the optional IP address (IP-ADDR) restricts this command to
that storage node.

--restart=IP-ADDR Forces a restart of the storage node.

--sync Resynchronizes ascd to correct a situation in which the probe.xml file

might be changed while the server is running, which occurs if a node
is decommissioned and replaced during service.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

84 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Files
The following file is associated with the avmaint autorestart command.

Table 47 Files for the avmaint autorestart command

File Description

~admin/autorest On multi-node systems, if ~admin/autorestart is present on a storage node,

art it contains information related to the last unexpected shutdown of that
node. This information is used to determine if that node is eligible to be
automatically restarted.
If ~admin/autorestart is not present, the node is assumed to be eligible for
an automatic restart.

Example
avmaint autorestart --xmlperline=99
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<autorestart enabled="true" state="monitor">
<gsan ipaddr="10.6.252.90" nodeid="0.0" state="up"/>
<gsan ipaddr="10.6.252.91" nodeid="0.1" state="up"/>
<gsan ipaddr="10.6.252.92" nodeid="0.2" state="up"/>
<gsan ipaddr="10.6.252.93" nodeid="0.3" state="up"/>
<gsan ipaddr="10.6.252.94" nodeid="0.4" state="up"/>
<gsan ipaddr="10.6.252.95" nodeid="0.5" state="up"/>
<gsan ipaddr="10.6.252.96" nodeid="0.6" state="up"/>
<gsan ipaddr="10.6.252.97" nodeid="0.7" state="up"/>
</autorestart>

Notes
This command added in version 4.1.

avmaint 85
EMC CONFIDENTIAL
Command Reference

avmaint cancelremovebadhashes
The avmaint cancelremovebadhashes command cancels a pending find/delete bad hash
operation and returns the server to a fully operation state.
The avmaint cancelremovebadhashes command is considered an advanced command
that is normally intended for use by expert users only. You must include the --avamaronly
option with all avmaint cancelremovebadhashes commands. If you are unsure about any
aspect of this command, contact EMC Customer Support for additional information before
using it.

Synopsis
avmaint cancelremovebadhashes --avamaronly GLOBAL-OPTIONS

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command added in version 4.1.

avmaint cat
The avmaint cat command lists contents of a persistent ATOMIC.

Synopsis
avmaint cat ATOMIC [--follow] [--maxbytes=LENGTH] GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint cat command.

Table 48 Parameters for the avmaint cat command

Parameter Description

ATOMIC Specifies which ATOMIC’s contents to list.

Command options
The following command options are available for the avmaint cat command.

Table 49 Command options for the avmaint cat command

Option Description

--follow Forces following object tail until interrupted.

--maxbytes=LENGTH Specifies the maximum byte LENGTH.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

86 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint checklogs
The avmaint checklogs command controls retention and deletion of entries in the
checklogs cache.
The avmaint checklogs command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint checklogs commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint checklogs [{cp.nnnn |--full}] [{--delete |--keep}]
--avamaronly --xmlperline=NUM GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint checklogs command.

Table 50 Command options for the avmaint checklogs command

Option Description

cp.nnnn The ID of the selected checklogs cache entry on which to act.

--full Specifies that the action should be performed on all checklogs cache
entries.

--delete Deletes the specified checklogs cache entries.

--keep Forces the specified checklogs cache entries to be kept until they expire,
and resets the expiration date to the checkpoint creation date plus the
current value of the checklogsexpire configuration value.

--avamaronly Enables Avamar-only commands and options.

--xmlperline=NUM Controls the number (NUM) of XML attributes per line.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint checklogs command:
◆ If you specify --delete or --keep, then you must specify either cp.nnnn or --full.
◆ If you do not specify either the --delete or --keep options, then the saved info entry is
displayed for the specified checklogs cache entry, or for all entries, if none is
specified.
◆ This command added in version 6.0.

avmaint 87
EMC CONFIDENTIAL
Command Reference

avmaint checkpoint
The avmaint checkpoint command starts a checkpoint operation.
The avmaint checkpoint command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint checkpoint commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint checkpoint [--wait] [--waittime=SEC] --avamaronly
GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint checkpoint command.

Table 51 Command options for the avmaint checkpoint command

Option Description

--wait Forces return of a new checkpoint ID only after successful checkpoint

completion.

--waittime=SEC Specifies the number of seconds (SEC) to wait before initiating the checkpoint
to enable clients to terminate gracefully. The default setting is 300; minimum
allowable setting is 30 seconds.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 52 Deprecated command options for the avmaint checkpoint command

Option Description

--keepmin This option added in version 4.0 and deprecated in version 5.0.
Enables the keep minimal checkpoints feature for this session.

Notes
Consider the following notes for the avmaint checkpoint command:
◆ You must include the --avamaronly option.
◆ This command does not output plain-text. Output is strictly XML.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.
◆ This command immediately returns a new checkpoint ID (before the checkpoint
completes).

88 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint config
The avmaint config command configures internal characteristics of the server. If you run
avmaint config without parameters, it returns a current list of server configuration
settings.
The avmaint config command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint config commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint config {asynccrunching=BOOL | autorepairmax=NUM |
balancemin=NUM | balancenodes=NUM | cacheupdateinterval=SEC |
checklogsexpire=NUM | chunkhashcheck=BOOL | commtimeout=NUM |
compressed | cpdaily=NUM | cphfschecked=NUM | cpmostrecent=NUM |
disknocp=PERCENT | disknocreate=PERCENT | disknoflush=PERCENT |
disknogc=PERCENT | diskreadonly=PERCENT | diskwarning=PERCENT |
failrefcheck=BOOL | gcadjustminpasses=NUM | gcadjustminutes=NUM |
gcadjustmaxminutes=NUM | hfsport=PORT | hintcachemax=NUM |
indexcacheallowed=NUM | indexcachepercentage=NUM |
indexelements=NUM | indexsplitcount=PERCENT |
indexsplitspread=NUM | iolimitpercent=PERCENT | lmaddr=IP-ADDR |
lmport=PORT | masterdc=NUM | maxcompdatastripe=SIZE | maxconn=NUM |
maxconninactive=SEC | maxdatastripe=SIZE | maxlogfiles=NUM |
maxlogsize=MB | maxrequests=NUM | maxrwatomdatastripe=SIZE |
maxrwcompdatastripe=SIZE | minstripestowrite=NUM |
paritygroups=Nx,Fy | perfbufsize=NUM | perfhistory=DAYS |
perfinterval=SEC | refcheck=BOOL | schedstartdelay=MIN |
sslbufsize=SIZE | sslport=PORT | tcpbufsize=SIZE | vmstatdelay=NUM |
vmstatprofile{PROFILE-NAME | NUM} --avamaronly GLOBAL-OPTIONS
[--cfgfilter={all | temp | perm}] [--comment=STRING]
[--duration={permanent name1=value1 [...] | remove name1 [...] |
NNNU name1=value1 [...]}]

Parameters
Supply one and only one of the following parameters on each command line for
avmaint config.

Table 53 Parameters for the avmaint config command (page 1 of 8)

Parameter Description

asynccrunching=BOOL Enables or disables asynchronous stripe crunching:

• To enable this feature, set BOOL to “true” (case-insensitive)
or one (1).
• To disable this feature, set BOOL to “false” (case-insensitive)
or zero (0).
Asynchronous stripe crunching is always enabled following a
restart.

autorepairmax=NUM Specifies the maximum number (NUM) of stripes with errors that
are fixed by hfscheck. The default setting is 8. The maximum
value is 1024. If the value is 0, no automatic repair is performed.
If there are more stripes with errors than the current
autorepairmax setting, then no repairs are performed (errors are
generated for all stripes).

avmaint 89
EMC CONFIDENTIAL
Command Reference

Table 53 Parameters for the avmaint config command (page 2 of 8)

Parameter Description

balancemin=NUM Configures server load balancing.

When this value is zero, no balancing is performed.
When this value is one, all stripes except HFS atomic data
stripes are balanced based on the count of each type of stripe
on each node.
For values between 2 and 99, this is a threshold percentage
that triggers load balancing.

balancenodes=NUM When rebalancing, specifies the number (NUM) of nodes to be

considered for selecting stripes when balancing. The default
setting is zero, which means use the ((number of online
nodes-1)/2)+1.
If the specified value is greater than (number of online nodes-1),
it is treated as though it were (number of online nodes-1).
This parameter added in version 5.0.

cacheupdateinterval=SEC Control the frequency of the cachebeat notifications, which

notifies the system that stripes have changed so that the
writelog header can be updated. The default setting is 300
seconds (5 minutes). Allowable values are 30 to 65535
seconds. Specifying a zero value disables the cachebeat.

checklogsexpire=NUM Number of days until the HFS check logs for a checkpoint expire
and can be deleted. The value must be between 0 and 255. The
default value is 8.
In most circumstances, only the logs corresponding to an error
are preserved until the expiration date. Logs for successful
checks are deleted along with the checkpoint. To keep these
logs longer, type the following command on a single line:
avmaint checklogs -keep cp.nnnn --avamaronly.

chunkhashcheck=BOOL Enables or disables additional hash validation in datastripe

getchunk:
• To enable this feature, set BOOL to “true” (case-insensitive)
or one (1).
• To disable this feature, set BOOL to “false” (case-insensitive)
or zero (0).
The default setting is true.

commtimeout=NUM Specifies the number (NUM) of seconds used for internal server
communication timeouts. The default setting is 30.

compressed Enables or disables backup compression. The default setting is

true (compress backups).

cpdaily=NUM Specifies the number (NUM) of checkpoints to perform each day.

The default setting is 2.
This parameter added in version 5.0.

cphfschecked=NUM Specifies the minimum number (NUM) of validated

(HFS-checked) checkpoints that must be retained in the system
at all times. The default setting is 1.

cpmostrecent=NUM Specifies the minimum number (NUM) of most recent

checkpoints that must be retained in the system at all times. The
default setting is 2.

disknocp=PERCENT Does not create new checkpoints after this percentage

(PERCENT) of full server storage capacity is reached.

90 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 53 Parameters for the avmaint config command (page 3 of 8)

Parameter Description

disknocreate=PERCENT Does not create new stripes if more than this percentage
(PERCENT) of full server storage capacity is reached.

disknoflush=PERCENT Does not flush writelogs to stripes if more than this percentage
(PERCENT) of full server storage capacity is reached.

disknogc=PERCENT Does not perform garbage collection after this percentage

(PERCENT) of full server storage capacity is reached.

diskreadonly=PERCENT Sets the percentage (PERCENT) of full server storage capacity

that triggers conversion of the server from a fully writable
condition to read-only. The default setting is 65%.

diskwarning=PERCENT Sets the percentage (PERCENT) of full server storage capacity

that triggers a warning to the server administrator that the server
is becoming full. The default setting is 55%.

failrefcheck=BOOL If refcheck is set true, then failrefcheck controls whether a

refcheck error causes the add_hash_data to fail. When
debugging, it is sometimes useful to enable the operation to
succeed so that you can see where the hash occurred in the
backup.
• To enable this feature, set BOOL to “true” (case-insensitive)
or one (1). This is the default setting.
• To disable this feature, set BOOL to “false” (case-insensitive)
or zero (0).

gcadjustminpasses=NUM Specifies the minimum number of garbage collection passes

that should be completed. If the specified number of passes
does not complete before the garbage collection maxtime is
exceeded, then the number of minutes specified in the
gcadjustminutes option is added to the garbage collection
maxtime. Note that no adjustment is performed when an ad hoc
garbage collection is performed using the avmaint
garbagecollection command.
The range of this value is 0 to 255. Default is 2; if set to 0 then
no automatic extension is performed.

gcadjustminutes=NUM Specifies the number of minutes to add to the garbage

collection maxtime when the gcadjustminpasses option is set to
a non-zero value.
The range of this value is 1 to 255. Default is 15.

gcadjustmaxminutes=NUM Specifies the maximum number of minutes for garbage

collection to complete, even if the total number specified in the
gcadjustminutes exceeds this value. No adjustment will cause
garbage collection maxtime to exceed this value.
The range for this value is 1 to 960. The default setting is 420.

hfsport=PORT Specifies the port ID (PORT) for client communications using

Avamar proprietary encryption. The default setting is 27000.

Note: Changing this port assignment causes the Avamar server

to become inaccessible to any Avamar clients that have not
similarly changed to the new port ID.

hintcachemax=NUM Specifies the number of entries in the hint cache.

If set to zero, no hint caching is performed. Otherwise, this value
specifies the maximum number (NUM) of entries in the hint
cache; allowed non-zero values are 1024 to 524,288.

avmaint 91
EMC CONFIDENTIAL
Command Reference

Table 53 Parameters for the avmaint config command (page 4 of 8)

Parameter Description

indexcacheallowed=NUM Controls index cache behavior, where NUM is one of the

following:
• 0—Disables index caching.
• 1—Server sets index caching mode.
• 2—Forces loading of index cache.

indexcachepercentage=NUM Sets the percentage of CPU memory that can be used as index
stripe cache. Allowed values are 5% to 75%. The default setting
is 60%.
This parameter added in version 6.0.

indexelements=NUM Sets the index stripe size to this number (NUM) of elements.

indexsplitcount=PERCENT Sets the maximum percentage (PERCENT) of index elements that

can exist in an index stripe before it is programmatically split.
The default setting is 85%.

indexsplitspread=NUM Sets the variation in indexsplitcount across stripes.

iolimitpercent=PERCENT Controls the number of simultaneous I/O requests issued by the

data server (also known as GSAN) to each disk in the system.
This parameter interacts with the operating system nr_requests
threshold as follows:
limit = nr_requests * (iolimitpercent / 100)

This parameter added in version 4.0.

lmaddr=IP-ADDR Specifies the IP address (IP-ADDR) of external authentication

manager or zero (do not use an external authentication
manager). The default setting is zero.

Note: Changing this setting can cause external authentication to

fail if the assigned port is not correct.

lmport=PORT Specifies the port ID (PORT) of external authentication manager.

The default setting is 700.

Note: Changing this port assignment can cause external

authentication to fail if the assigned port is not correct.

masterdc=NUM Sets the master module to N. The default setting is 0.

maxcompdatastripe=SIZE Sets the maximum composite data stripe SIZE to this number of
elements.

maxconn=NUM Sets the maximum number (NUM) of concurrent client

connections for each node.

maxconninactive=SEC Sets the client connection timeout period in seconds (SEC). This
is the maximum amount of time that the server waits for a client
to resume communication after network connectivity is lost. If
client communication is not resumed within this period of time,
the server terminates the client connection.

maxdatastripe=SIZE Sets the maximum atom data stripe SIZE to this number of
elements.

92 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 53 Parameters for the avmaint config command (page 5 of 8)

Parameter Description

maxlogfiles=NUM Sets the maximum number of gsan.log files to retain. The default
setting is 100 files.
In multi-node servers, this setting applies equally to all storage
nodes on the server (you cannot configure gsan.log file size on a
node-by-node basis).

maxlogsize=MB Sets the maximum gsan.log file size in MB. The default setting is
25 MB.
In multi-node servers, this setting applies equally to all storage
nodes on the server (you cannot configure gsan.log file size on a
node-by-node basis).

maxrequests=NUM Sets the maximum number (NUM) of concurrent client requests

per node. The default setting is 150.

maxrwatomdatastripe=SIZE Sets the maximum read-write (rw) atomic data stripe SIZE to this
number of elements.

maxrwcompdatastripe=SIZE Sets the maximum rw composite data stripe SIZE to this number
of elements.

minstripestowrite=NUM Sets the minimum number (NUM) of stripes per family that must
be online before writing occurs.

paritygroups=Nx,Fy Sets the parity description by specifying the sizes of near and far
parity groups, where Nx is the maximum size of near parity
groups and Fy is the maximum size of the first far parity group.
Larger parity groups improve storage efficiency at the expense of
reconstruction efficiency. In other words, large parity groups use
disk space more efficiently, but take more time and more disk
seeks to backup or restore data when a node or module is down.
In multi-node servers, the maximum near parity setting is always
the number of storage nodes in a module. Far parity groups
never grow larger than the number of modules minus one.
The default setting is N8,F4.

perfbufsize=NUM Specifies the read performance buffer size according to the

following formula:
128KB * 2NUM
NUM can be any whole integer between 0-4, which results in the
following buffer sizes:
• 0—128 KB buffer
• 1—512 KB buffer
• 2—1024 KB buffer
• 3—2048 KB buffer
• 4—4096 KB buffer
The default setting is 3 (2048 KB buffer).
This parameter added in version 4.0.

perfcoldinterval=SEC Specifies the number of seconds (SEC) between cold disk read
performance checks. Valid setting is from 1 to 3600 seconds.
The default setting is 30 seconds.
This parameter added in version 5.0.

perfcoldtriallimit=NUM Specifies the number of disk performance tests that should be

run after the server has reached a "cold" state. Valid setting is
from 1 to 16 checks. The default setting is 4 checks.
This parameter added in version 5.0.

avmaint 93
EMC CONFIDENTIAL
Command Reference

Table 53 Parameters for the avmaint config command (page 6 of 8)

Parameter Description

perfhistory=DAYS Specifies the number of DAYS of read performance history to

retain. Valid values are 2 thru 255. The default setting is 10
days.
This parameter added in version 4.0.

perfinterval=SEC Specifies the number of seconds (SEC) between hot disk read
performance checks. The default setting is 300 seconds. A
setting of zero disables this feature.
This parameter added in version 4.0.

perftriallimit=NUM Specifies the number of disk performance tests that should be

run while the server is in a normally active or "hot" state. Valid
setting is from 1 to 255 checks; a setting of zero disables this
feature. The default setting is 3 checks.
This parameter added in version 5.0.

refcheck=BOOL Enables or disables check composite/directory references on

add hash data.
To enable this feature, set BOOL to true (case-insensitive) or one
(1). This is the default setting.
To disable this feature, set BOOL to “false” (case-insensitive) or
zero (0).

schedstartdelay=MIN Specifies the number of minutes (MIN) to wait before restarting

the maintenance scheduler each time the server is restarted.
The default setting is 60 minutes.
This parameter added in version 5.0.

sslbufsize=SIZE Specifies the SSL buffer SIZE in kilobytes that will be used for
encrypted client/server communication. Valid values are whole
integers between 1024 and 8388608. The default size is 128
KB. Specifying a value of zero uses the default operating system
default buffer size, which is typically too small to be practical.

sslport=PORT Specifies the port ID (PORT) for client communications by way of

SSL. The default setting is 29000.
Changing this port assignment causes the Avamar server to
become inaccessible to any Avamar clients that have not
similarly changed to the new port ID.

tcpbufsize=SIZE Specifies the TCP buffer SIZE in kilobytes that will be used for
unencrypted client/server communication. Valid values are
whole integers between 1024 and 8388608. The default size is
128 KB. Specifying a value of zero uses the default operating
system default buffer size, which is typically too small to be
practical.

vmstatdelay=NUM Specifies the number (NUM) of seconds between vmstat log file
write operations. The default setting is 60 seconds.

vmstatprofile= Controls selection of kernel information written to the log file.

{PROFILE-NAME | NUM) This mechanism is similar to the UNIX vmstat command, where
PROFILE-NAME is a profile string name or NUM is the numerical
sum of all data profiles that are to be used.
Valid values are one or more of the following string or numeric
profile values.
Multiple string profile names can be supplied if separated by
commas (for example, vmstatprofile=chunk,stripecount).
Multiple numeric profiles can be specified as a single exclusive
OR’d numeric value (for example, vmstatprofile=0x00002100 is
equivalent to vmstatprofile=chunk,stripecount).

94 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 53 Parameters for the avmaint config command (page 7 of 8)

Parameter Description

vmstatprofile= • {active | 0x00000400}—Active profile. Tracks number of

{PROFILE-NAME | NUM) datastripes and composite datastripes that are currently
(continued) active (ready to be written to).

vmstatprofile= • {chunk | 0x00000100}—Chunk profile. Tracks number of

{PROFILE-NAME | NUM) chunks and bytes that have been added, queued for deletion
(continued) by garbage collection or deleted. It also provides rates of
change for these statistics.

vmstatprofile= • {client | 0x00000200}—Client profile. Tracks number of client

{PROFILE-NAME | NUM) backups and restores in progress and causes special
(continued) clientdone messages to be written to the server logs following
a successful client operation to provide data transfer
statistics.

vmstatprofile= • {disk | 0x00000008}—Disk usage profile. Tracks disk usage

{PROFILE-NAME | NUM) and I/O. If the stripe profile is also enabled, stripe
(continued) information per disk is integrated in to the results.

vmstatprofile= • {diskiostat | 0x00010000}—Provides disk read and write

{PROFILE-NAME | NUM) statistics, as if running the iostat utility with extended disk
(continued) statistics.

vmstatprofile= • {event | 0x00000800}—Event profile. Tracks number of

{PROFILE-NAME | NUM) checkpoint, stripe creation, datastripe crunch, garbage
(continued) collection, indexstripe split and stripe sync operations in
progress. It also tracks total number of these operations that
have occurred and whether an hfscheck is in progress.

vmstatprofile= • {flush | 0x00001000}—Flush profile. Tracks stripe flush

{PROFILE-NAME | NUM) activity (the number of stripes flushed, the total number of
(continued) seconds spent flushing and the average number of seconds
per flush).

vmstatprofile= • {load | 0x00000020}—Load average profile. Provides current

{PROFILE-NAME | NUM) node load averages as returned by Linux.
(continued)

vmstatprofile= • {net | 0x00000002}—Network profile. Tracks network packet

{PROFILE-NAME | NUM) I/O for TCP and UDP.
(continued)

vmstatprofile= • {node | 0x00000040}—Node state profile. Provides current

{PROFILE-NAME | NUM) state of a node (online status, access mode, run level, stripe
(continued) count, freezing status, connectivity stability, command
dispatcher and scheduler suspension states).

vmstatprofile= • {pool | 0x00000080}—Memory pool profile. Tracks state of

{PROFILE-NAME | NUM) primary memory pool.
(continued)

vmstatprofile= • {rawnet | 0x00000004}—Raw network profile. Tracks raw

{PROFILE-NAME | NUM) network I/O data including bytes in and out, packets in and
(continued) out, and errors.

vmstatprofile= • {std | 0x00000001}—Standard profile. Displays the same

{PROFILE-NAME | NUM) information as the Linux vmstat command.
(continued)

vmstatprofile= • {stripe | 0x00000010}—Stripe info profile. Provides merged

{PROFILE-NAME | NUM) run-time stripe info (opens, closes, I/O operations
(continued) summaries, and so forth).

avmaint 95
EMC CONFIDENTIAL
Command Reference

Table 53 Parameters for the avmaint config command (page 8 of 8)

Parameter Description

vmstatprofile= • {stripecount | 0x00002000}—Stripe count profile. Tracks

{PROFILE-NAME | NUM) number of stripes of each kind and parity existence on each
(continued) node.

vmstatprofile= • {uniform | 0x00004000}—Uniform profile. This is a

{PROFILE-NAME | NUM) special-purpose formatting argument, that when specified,
(continued) formats vmstat log messages (produced by other profiles) in
a manner that can be more easily processed by a script.
Each uniform log message begins with the profile name and
is followed by one or more NAME=VALUE pairs.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Command options
The following command options are available for the avmaint config command.

Table 54 Command options for the avmaint config command (page 1 of 2)

Option Description

--cfgfilter={all | temp | Optionally used with any operation (mutable or not) to control
perm} the content of the generated output as follows:
• all—Shows all (that is, both temporary and permanent)
settings.
• temp—Shows only temporary settings.
• perm—Shows only permanent settings.

--comment=STRING Optionally used with any operation that sets one or more
temporary values, such as --duration=NNNU.
The specified comment STRING is applied to all parameters
being set by the single invocation to which it is applied. If
--comment is not specified, STRING defaults to an empty string.
The maximum STRING length is 256 ASCII characters.

96 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 54 Command options for the avmaint config command (page 2 of 2)

Option Description

--duration={ The --duration option is required during every operation that

permanent name1=value1 alters the state of any existing configuration values. --duration
[...] |
remove name1 [...] | cannot be used with any display-only operation.
NNNU name1=value1 [...]} The --duration option accepts three sets of values:
• =permanent name1=value1 [...]—Used with a
space-delimited list of one or more name/value pairs to
permanently set the configuration value of each named
parameter. If any named parameter exists with temporary
duration, that temporary value is removed.
• =remove name1—Used with a space-delimited list of one or
more parameter names (values must be omitted) to remove
the temporary value of each named parameter, which reveals
the corresponding, underlying permanent value, as it existed
before the temporary value was established. Each named
parameter must exist with a temporary duration, otherwise
an error message warns of an attempt to remove a
nonexistent temporary configuration parameter.
• =NNNU name1=value1—Used with a space-delimited list of
one or more name/value pairs to set the value of each
named parameter for a finite duration, The duration is
specified as NNNU, where NNN expresses a positive integer,
and U specifies days (NNNd), hours (NNNh), or minutes
(NNNm). The maximum duration allowed is 30 days.

Deprecated parameters
Beginning with the noted release, use of these parameters is officially discouraged.
Support for these options might be discontinued entirely at any time.

Table 55 Deprecated parameters for the avmaint config command

Parameter Description

cpkeepmin=BOOL This parameter added in version 4.0 and deprecated in version

5.0.
Persistently enables or disables the keep minimal checkpoints
feature for this session.
• To enable this feature, set BOOL to “true” (case-insensitive) or
one (1). This is the default setting.
• To disable this feature, set BOOL to “false” (case-insensitive)
or zero (0).

indexcachedelaytime=SEC This parameter added in version 5.0 and deprecated in version

6.0 in favor of the indexcachepercentage parameter.
Specifies the number of seconds (SEC) to wait after crossing the
indexcachethreshold. The default setting is 2 minutes (120
seconds).

indexcachememorylimit=GB This parameter added in version 5.0 and deprecated in version

6.0 in favor of the indexcachepercentage parameter.
Specifies the total amount of memory (in GB) to leave free. The
default setting is 8 GB. A setting of zero (0) disables this feature.

indexcachethreshold=NUM This parameter added in version 5.0 and deprecated in version

6.0 in favor of the indexcachepercentage parameter.
Specifies the number (NUM) of backup connections that trigger
cache loading/unloading. The default setting is 4 backup
connections. A setting of zero (0) disables cache loading during
backups.

avmaint 97
EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the avmaint config command:
◆ You must include the --avamaronly option.
◆ This command does not output plain text. Output is strictly XML. You should include
the --xmlperline=NUM global option to control the number of XML attributes per line.

avmaint conversion
The avmaint conversion command converts older format data stripes to the latest version.
The avmaint conversion command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint conversion commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint conversion [--count=NUM] [--maxtime=SEC] --avamaronly
GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint conversion command.

Table 56 Command options for the avmaint conversion command

Option Description

--count=NUM Specifies the maximum number (NUM) of stripes that are converted on each
node. The default setting is 50 stripes per node. A setting of zero specifies that
an unlimited number of stripes be converted (convert all stripes now).

Note: This is an absolute maximum setting. The actual number of stripes

converted might be less, especially if the --maxtime setting is a very short
duration.

--maxtime=SEC Specifies the maximum amount of time that avmaint conversion is allowed to
run. The default setting is 900 seconds (15 minutes). A setting of zero specifies
an unlimited amount of time (run until all stripes are converted).

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint conversion command:
◆ You must include the --avamaronly option.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.

98 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint crunch
The avmaint crunch command controls stripe crunching.
The avmaint crunch command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint crunch commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint crunch {limit | status | reset | rollover | resetandrollover |
factoryreset} [--restricted | unrestricted] --limitadjust=LIMIT |
--avamaronly GLOBAL-OPTIONS

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint crunch command.

Table 57 Parameters for the avmaint crunch command

Parameter Description

limit LIMIT Used with the --limitadjust=LIMIT option to change the daily amount of
asynchronous crunching in accordance withe the LIMIT value supplied via
--limitadjust=LIMIT.

status Returns crunching status only; no changes made.

reset Sets counters to 0.

rollover Rolls over day timer to current time.

resetandrollover Equivalent to performing reset, then rollover actions.

restricted Restricts crunching to only be based on historical statistics.

unrestricted Allows crunching without regard to historical statistics.

factoryreset Sets the day timer to factory default (midnight GMT).

Command options
The following command option is available for the avmaint crunch command.

Table 58 Command options for the avmaint crunch command (page 1 of 2)

Option Description

--limitadjust=LIMIT Required option when the limit parameter is used. LIMIT is an integer
representing some change in the percentage of daily asynchronous
crunching that should take place.
If the value is positive, then the new goal is G + (G * LIMIT%). If the
value is negative, then the new goal is G - (G * LIMIT%), but never less
than zero. The goal adjustment is only used until the crunch day rolls
over, which occurs at midnight on the storage node, when an avmaint
crunch rollover or avmaint crunch resetandrollover command is
received, or when the server is restarted.

avmaint 99
EMC CONFIDENTIAL
Command Reference

Table 58 Command options for the avmaint crunch command (page 2 of 2)

Option Description

--avamaronly Enables commands and options that are normally intended for use by
expert users only. Contact EMC Customer Support for additional
information.
You must supply --avamaronly for this command to work.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint crunch command:
◆ You must include the --avamaronly option.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.

100 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint decommission
The avmaint decommission command decommissions a storage node or an individual
disk within a storage node.
The avmaint decommission command is considered an advanced command that is
normally intended for use by expert users only. You must include the --avamaronly option
with all avmaint decommission commands. If you are unsure about any aspect of this
command, contact EMC Customer Support for additional information before using it.

Synopsis
avmaint decommission {NODE-ID | --disknum=DISK} --avamaronly

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint decommission command.

Table 59 Parameters for the avmaint decommission command

Parameter Description

NODE-ID If a NODE-ID (for example, 0.1, 0.2) is supplied, that node is decommissioned.

--disknum=DISK If --disknum=DISK is supplied, that DISK is decommissioned.

Notes
Consider the following notes for the avmaint decommission command:
◆ You must include the --avamaronly option.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.

avmaint 101
EMC CONFIDENTIAL
Command Reference

avmaint ducp
The avmaint ducp command lists hard drive space consumed by a specific checkpoint.

Synopsis
avmaint ducp CP-ID GLOBAL-OPTIONS

Parameters
Supply the following parameter on each command line for the avmaint ducp command.

Table 60 Parameters for the avmaint ducp command

Parameter Description

CP-ID Specifies the checkpoint to list.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command does not output plain text. Output is strictly XML. You should include the
--xmlperline=NUM global option to control the number of XML attributes per line.

avmaint findbadhashes
The avmaint findbadhashes command returns a list of hashes and backups that are
suspected to be bad, as well as a verification token, which must be supplied to
removebadhashes to remove bad hashes from the server.
The avmaint findbadhashes command is considered an advanced command that is
normally intended for use by expert users only. You must include the --avamaronly option
with all avmaint findbadhashes commands. If you are unsure about any aspect of this
command, contact EMC Customer Support for additional information before using it.
To ensure data integrity, avmaint findbadhashes places the server in read-migrate mode,
which terminates any running backups and prevents any new backup, restore or
replication operations from taking place until such time as avmaint removebadhashes
completes.
If you must revert to fully operational server state before running avmaint
removebadhashes, use avmaint cancelremovebadhashes to undo this entire find/delete
bad hash operation.

Synopsis
avmaint findbadhashes [H] HASH --avamaronly GLOBAL-OPTIONS

102 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Parameters
The following parameters are available for the avmaint findbadhashes command.

Table 61 Parameters for the avmaint findbadhashes command

Parameter Description

H HFS check hash.

HASH 40-character hex HASH value, which is typically obtained from avmaint hfscheck error
messages.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Output
Output is XML in the following format:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<findbadhasheslist
passcount="15"
created="1213311581"
verification-token="VTOKENc7dc5d6765824785f3607803e3b130fefd8b432">
<hashlist>
<hash value="H253f32a5dd143d424bccd352ded54ef311100b38">
<backup
client="clients/MyClient.example.com"
labelnum="1"
created="1208471840">
<dirpath path="C:/Temp/File-1.txt"/>
</backup>
</hash>
<hash value="Hda140b39bc2f89eec0fe076fffc468064c21cba0">
<backup
client="none"
labelnum=""
created="">
<dirpath path="/data02/File-2.txt"/>
<dirpath path="/data02/File-3.txt"/>
<dirpath path="/data02/File-4.txt"/>
</backup>
</hash>
</hashlist>
</findbadhasheslist>

Notes
This command added in version 4.1.

avmaint 103
EMC CONFIDENTIAL
Command Reference

avmaint garbagecollect
The avmaint garbagecollect command starts a garbage collection operation.
The avmaint garbagecollect command is considered an advanced command that is
normally intended for use by expert users only. You must include the --avamaronly option
with all avmaint garbagecollect commands. If you are unsure about any aspect of this
command, contact EMC Customer Support for additional information before using it.

Synopsis
avmaint garbagecollect [--gccount=NUM] [--limitadjust={+ | -}LIMIT]
[--maxpass=NUM] [--maxtime=SEC] [--refcheck]
[--throttlelevel=PERCENT] [--usehistory] --avamaronly
GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint garbagecollect command

Table 62 Command options for the avmaint garbagecollect command

Option Description

--gccount=NUM Specifies the number (NUM) of index stripes per node to

garbage collection. The default setting is 16.

--limitadjust= {+ | -}LIMIT Used with --usehistory to increase or decrease computed

garbage collection quota by LIMIT percent. The default setting
is zero (0).
For example, if history computes that NN GB should be
garbage collected, then using --limitadjust=+50 increases
that amount to NN + (NN*50%) GB. Alternatively, supplying
--limitadjust=-25 decreases that amount to
NN - (NN*25%) GB.
This option added in version 4.1.

--maxpass=NUM Specifies the maximum number (NUM) of garbage collection

passes. The default setting is 100 passes.

--maxtime=SEC Specifies the maximum number of seconds (SEC) garbage

collection process is allowed to run. The default setting is
3600 seconds (1 hour).

--refcheck Forces check of composite references during garbage

collection or HFS check, respectively.

--throttlelevel=PERCENT Specifies the throttling percentage (PERCENT). This value

reduces the garbage collection operation’s system resource
(CPU, disk, bandwidth, and so forth) usage by this
percentage. The default setting is zero (that is, no throttling),
which means that the garbage collection operation’s system
resource usage is potentially 100%).
This option added in version 4.0.

--usehistory Enables or disables garbage collection history feature, which

limits the amount of garbage collection performed to an
amount that frees up at least as much space as has been
used by the daily average of all backups over the last several
days. The default setting is false.
This option added in version 4.1.

104 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint garbagecollect command:
◆ You must include the --avamaronly option.
◆ This command does not output plain text. Output is strictly XML. You should include
the --xmlperline=NUM global option to control the number of XML attributes per line.

avmaint gcstatus
The avmaint gcstatus command returns status for an ongoing or the most recently
completed garbage collection process.

Synopsis
avmaint gcstatus [--full] GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint gcstatus command.

Table 63 Command options for the avmaint gcstatus command

Option Description

--full Returns full listings (that is, information on each node as well as the global summary).

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command does not output plain text. Output is strictly XML. You should include the
--xmlperline=NUM global option to control the number of XML attributes per line.

avmaint 105
EMC CONFIDENTIAL
Command Reference

avmaint gendata
The avmaint gendata command generates data chunks for testing purposes.
The avmaint gendata command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint gendata commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint gendata [--localindex] [--pending=NUM] [--starttime=NUM]
[--totalmb=MB] --avamaronly GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint gendata command.

Table 64 Command options for the avmaint gendata command

Option Description

--localindex Add to local index stripes.

--pending=NUM Specifies the number (NUM) of simultaneous write requests. The default
setting is 10.

--starttime=NUM Specifies the time to start the test.

--totalmb=MB Total MB of data to write. The default setting is 1.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

106 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint getclientmsgs
The avmaint getclientmsgs command returns contents of the client message store.
Messages provide session information about all avtar sessions that have run or are being
run on the Avamar server.

Synopsis
avmaint getclientmsgs [--startoffset=NUM] GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint getclientmsgs command.

Table 65 Command options for the avmaint getclientmsgs command

Option Description

--startoffset=NUM Specifies the starting offset. The default setting is 0.

To view all of the messages, you might need to repeatedly invoke this
command until the return EOF is 1.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Support for non-XML output is likely to be discontinued in a future release.

avmaint 107
EMC CONFIDENTIAL
Command Reference

avmaint geterrors
The avmaint geterrors command returns errors from a specified NODE-ID.

Synopsis
avmaint geterrors NODE-ID [--alternate] [--duptime=SEC]
[--errfilter={ERROR | INFO | WARN}] [--startoffset=NUM]
GLOBAL-OPTIONS

Parameters
The following parameter is used with the avmaint geterrors command.

Table 66 Parameters for the avmaint geterrors command

Parameter Description

NODE-ID Return errors from the specified NODE-ID, which can be obtained by using the
nodelist command.

Command options
The following command options are available for the avmaint geterrors command.

Table 67 Command options for the avmaint geterrors command

Option Description

--alternate Specifies that errors be recovered from the hfscheck log file rather
than the server log.

--duptime=SEC Returns errors within the specified period of time (in seconds) since
the server was started or restarted. The default setting is 60
seconds.

--errfilter= Specifies which types of errors (ERROR, INFO or WARN) to return.

{ERROR | INFO | WARN}
You can specify more than one error type, but multiple error types
must be separated by commas. For example, supplying
--errfilter=ERROR,WARN returns errors and warnings.

--startoffset=NUM Defines a starting range (line number) inside the log file. The default
setting is zero.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command does not output plain text. Output is strictly XML. You should include the
--xmlperline=NUM global option to control the number of XML attributes per line.

108 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint getrefby
The avmaint getrefby command returns all hashes of a certain type that reference this
HASH.
The avmaint getrefby command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint getrefby commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint getrefby {H | R | U} HASH --avamaronly GLOBAL-OPTIONS

Parameters
The following parameters are available for the avmaint getrefby command.

Table 68 Parameters for the avmaint getrefby command

Parameter Description

H HFS check hash

R Persistent store hash.

U User account hash.

HASH 40-character hex HASH value

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

avmaint 109
EMC CONFIDENTIAL
Command Reference

avmaint hfscheck
The avmaint hfscheck command initiates an HFS check operation. It returns control to the
user immediately after the HFS check process (cgsan) has initiated the check.
The avmaint hfscheck command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint hfscheck commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint hfscheck [--checkdata=PERCENT] [--checkpoint=CP-ID]
[--concurrentdatastripes=NUM] [--concurrentindexstripes=NUM]
[--concurrentparitystripes=NUM] [--cxorsets=NUM] [--full]
[--gccount] [--keep] [--metadata] [--modified=NUM] [--refcheck]
[--resetpredictor] [--rolling] [--suspend] [--throttle]
--avamaronly GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint hfscheck command.

Table 69 Command options for the avmaint hfscheck command (page 1 of 2)

Option Description

--checkdata=PERCENT If a rolling HFS check is specified, this percentage

(PERCENT) of data stripes is checked.
If the number of modified stripes is less than this value,
the oldest unchecked stripes are selected up to this limit.
If more than this number of modified stripes is checked, no
unmodified stripes are selected.
Therefore, the default value of 0 only checks modified
stripes.
A value of 100 converts the check into a full check.
The default setting is zero (0).
This option added in version 5.0.

--checkpoint=CP-ID Specifies which checkpoint (CP-ID) should be processed. If

not supplied, HFS check is performed on the most recent
unvalidated checkpoint file.

--concurrentdatastripes=NUM Specifies the maximum number of data stripes that are

simultaneously processed on a single node during an
index sweep. The higher the value, the more concurrent
work is being performed. The default setting is 0 (one per
disk).

--concurrentindexstripes=NUM Specifies the maximum number of index stripes that are

simultaneously processed on a single node during an
index sweep. The higher the value, the more concurrent
work is being performed. The default setting is 2.

--concurrentparitystripes=NUM Specifies the maximum number of parity stripes that are

simultaneously processed on a single node during a parity
sweep. The higher the value, the more concurrent work is
being performed. The default setting is 0 (one per disk).

--cxorsets=NUM Specifies the number of column XORs sets to use for parity
checking during an HFS check. The default setting is 0 (use
the data server default, which is currently 3).

110 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 69 Command options for the avmaint hfscheck command (page 2 of 2)

Option Description

--full Performs a full HFS check.

This option added in version 5.0.

--gccount Specifies the maximum number of index stripes that are

simultaneously processed on a single node during the
refcheck phase.

--keep Specifies that temporary working directories and files

should be retained (kept) after HFS check completes. The
default setting is to delete all temporary working files.

--metadata Performs a metadata-only HFS check.

This option added in version 4.0.

--modified=NUM Used with --checkdata=PERCENT to specify the number of

data stripes that are checked. NUM must be one of the
following:
• 0—Any modification causes a stripe to be marked as
modified.
• 1—Only modified stripe data portions causes a stripe to
be marked as modified.
• 2—Identifies data stripes that have only had their chunk
ID list changed and skips all further checks. This
improves HFS check performance by ignoring data
chunks that have been marked for deletion by garbage
collection.
This is the default setting.
This setting added in version 5.0.4.
• nn—Two-digit integer.
This option added in version 5.0.

--refcheck Performs a refcheck-only HFS check.

This option was deprecated for versions 3.5 through 4.0 in
favor of --checks. Beginning with version 4.0, it is again
valid.

--resetpredictor Forces a re-initialization of predictor logic.

--rolling Performs a rolling HFS check.

This option added in version 5.0.

--suspend Specifies that dispatchers should be suspended during

HFS check start up (at the same time that server access
mode is set to read-only).

throttle If supplied, throttling is used to conserve resources during

the specified HFS check. This is the default setting.
This option added in version 5.0.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

avmaint 111
EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 70 Deprecated command options for the avmaint hfscheck command

Option Description

--autorepair This option added in version 5.0 and deprecated in version 6.0.
Enables auto-repair if errors detected. This is the default setting,
but occasionally it might be of use to suppress the evaluation
phase of a rolling HFS check, particularly when testing.

--checks=DESCRIPTOR Deprecated in version 5.0. Supplying this option in a version 5.0 or

later context returns an error.
DESCRIPTOR must be a valid enabling descriptor string that
describes which checks are to be performed on which specific
stripe classes.
Stripe classes can be any or all of the following:
• h—HFS stripes
• p—Persistent stripes
• u—Accounting stripes
Checks can be any or all of the following:
• a—Atomic data sweeps
• c—Composite data sweeps
• p—Parity checks
• r—Reference checking
For example, the descriptor hpu+acpr is equivalent to the default
behavior (perform all checks on all stripe classes).
You can also constrain an HFS check to only process a percentage
of the total stripes by prefixing a desired processing percentage
(as an integer between 1 and 99). For example:
50:hpu

The default setting is 0 (process 100% of eligible stripes).

--checknode=MODULE.NODE Deprecated in version 5.0. Supplying this option in a version 5.0 or

later context returns an error.
Enables single-node HFS check on this MODULE.NODE.

--deadline=MIN Deprecated in version 5.0. Supplying this option in a version 5.0 or

later context returns an error.
Specifies the HFS check deadline in minutes (MIN). The default
setting is zero (no deadline).

--keepmin This option added in version 4.0 and deprecated in version 5.0.
Enables the keep minimal checkpoints feature for this session.

--throttlelevel=NUM Deprecated in version 5.0 in favor of --throttle.

Specifies the amount of throttled resources (measured as a
percentage of CPU capacity) that can be allocated to other tasks.
For example, a setting of 20 begins throttling once CPU usage
exceeds 80%. Values in excess of 100 are treated as 100%
(maximum throttling); a value of zero specifies that no throttling is
to be performed.
If a deadline is specified, the throttle level indicates a maximum
allowable throttle level, and the throttle level starts at half this
value.
The default setting is 20 if no deadline is specified; 40 if deadline
is specified.

112 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the avmaint hfscheck command:
◆ You must include the --avamaronly option.
◆ The command returns immediately after the hfscheck process has started. This can
take several minutes. However, the actual HFS check operation can take several
hours. Any throttling applied to the HFS check operation increases the amount of time
it takes to complete.
◆ An HFS check consumes extensive amounts of server resources. You can throttle an
HFS check to reduce contention with normal server operation.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.
◆ If avmaint hfscheck is run without options, an HFS check is performed on the most
recent unvalidated checkpoint file.
◆ To return status for a currently running or the most recently completed HFS check, use
avmaint hfscheckstatus.
◆ To stop a currently running HFS check, use avmaint hfscheckstop or hfscheck_kill.

Output
The following information is output in XML format indicating a successful initiation of the
HFS check:
<?xml version ="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE hfscheck>
<hfscheck
checkpoint="cp.20131215003909"
status="hfscheck"
start-time="1134607161"
end-time="0"
elapsed-time="246"
check-start-time="1134607407"/>

avmaint 113
EMC CONFIDENTIAL
Command Reference

avmaint hfscheckstatus
The avmaint hfscheckstatus command returns the status of any currently running HFS
check or the last completed HFS check.
Completed information is retained until the data server is restarted, at which point a new
HFS check is required to update this information.

Synopsis
avmaint hfscheckstatus [CP-ID] GLOBAL-OPTIONS

Command options
The following command option is available for the avmaint hfscheckstatus command.

Table 71 Command options for the avmaint hfscheckstatus command

Option Description

CP-ID If checkpoint ID (CP-ID) is supplied, avmaint hfscheckstatus returns status for that HFS
check. If checkpoint ID (CP-ID) is not supplied, avmaint hfscheckstatus returns status for
the most recently completed HFS check.
This option added in version 4.0.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command does not output plain text. Output is strictly XML. You should include the
--xmlperline=NUM global option to control the number of XML attributes per line.

Output
Status is output in XML in the following format:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hfscheckstatus
nodes-queried="1"
nodes-replied="1"
nodes-total="1"
generation-time="1227572657"
checkpoint="cp.20131125001344"
start-time="1227572266"
end-time="1227572567"
elapsed-time="301"
check-start-time="1227572341"
check-end-time="1227572536"
status="completed"
result="OK"
stripes-checking="228"
stripes-completed="228"
type="partial"
checks="100:hpu+cpr">
<hfscheckerrors/>
</hfscheckstatus>

114 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

The following table describes each avmaint hfscheckstatus XML attribute:

Table 72 XML attributes for the avmaint hfscheckstatus command (page 1 of 2)

Attribute Description

nodes-queried Number of nodes that were sent a status request.

nodes-replied Number of nodes that responded to status request.

nodes-total Total number of server nodes.

generation-time Time, expressed as seconds of epoch, that the avmaint hfscheckstatus

command was issued.

checkpoint Unique ID of checkpoint that was checked.

start-time Time, expressed as seconds of epoch, that the initiate HFS check
command was issued.

end-time Time, expressed as seconds of epoch, that the HFS check operation
ended.

elapsed-time If status is for a completed HFS check operation, this is the total elapsed
time in seconds that the HFS check operation consumed.
If status is for a currently running HFS check operation, this is the current
amount time in seconds that has elapsed.

check-start-time Time, expressed as seconds of epoch, that the HFS check starts
processing on the newly created HFS check process (cgsan).

check-end-time Time, expressed as seconds of epoch, that the HFS check ended.

status One of the following status codes:

• commit—Performing commit operation to generate HFS check work
directory.
• completed—HFS check has successfully completed without errors.
• error—HFS check has completed but with an error. This generally
indicates a procedural error rather than an actual defect in the HFS.
• hfscheck—HFS check operation has started on cgsan but not yet
completed.
• idle—No HFS check has been performed since the last data server
start or restart.
• rollback—Performing rollback operation on checkpoint directory.
• startcgsan—Forking and executing cgsan.
• terminating—HFS check has completed but final cleanup is occurring.
• waitcgsan—Awaiting cgsan startup. This occurs once cgsan reaches
full access mode.

result OK if HFS check successfully completed. Otherwise, an error code is

provided.

stripes-checking Estimated number of stripes that remain to be checked.

stripes-completed Number of stripes that were checked. It might be less than that estimated
if certain operations (parity checking, for example) are not performed.
While an HFS check is currently running, this gives the current checked
figure.

avmaint 115
EMC CONFIDENTIAL
Command Reference

Table 72 XML attributes for the avmaint hfscheckstatus command (page 2 of 2)

Attribute Description

type Check type. One of the following:

• full—All checks are performed on all stripes.
• partial—All other kinds of checks.
• reduced—Checkpoint was taken on N nodes but checked on N-1
nodes.
• rolling—Rolling HFS check. This type added in version 5.0.

checks One of the following:

• full—All checks were performed on all stripes.
• metadata—Partial check that checks only composite data stripes in
addition to performing a reference check.
• refcheck—Partial check that verifies that all composite references are
valid.
• rolling—A rolling HFS check was performed. The syntax for a rolling
HFS check is rolling:PERCENT:MODIFIED, where PERCENT is the
checkdata value for the rolling HFS check, and MODIFIED is the
associated modified value.
• rolling+metadata—First a rolling, then metadata checks were
performed.

percent-complete Approximate progress indicator, measured as a percentage of the total

work completed. This is based on the completion time estimates (not on
the stripe counts). A value of 0 indicates the check has not yet started; a
value of 100 indicates the check has completed.
If error correction is invoked, (state evaluating), the check is considered
complete even if the full HFS check has not yet completed. It is difficult to
determine how long error correction will last.

phase The element is only present if status=hfscheck. One of the following:

• datasweep
• indexsweep
• paritysweep
• refcheck

minutes-to-completion The element is only present if status=hfscheck.

Provides and estimated number of minutes to completion of currently
running HFS check.

errors Number of checking errors that have been detected.

The actual errors generated can be obtained with the avmaint geterrors --alternate
command.

116 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint hfscheckthrottle
The avmaint hfscheckthrottle command dynamically modifies existing throttling values for
a currently running HFS check operation.
The avmaint hfscheckthrottle command is considered an advanced command that is
normally intended for use by expert users only. You must include the --avamaronly option
with all avmaint hfscheckthrottle commands. If you are unsure about any aspect of this
command, contact EMC Customer Support for additional information before using it.
Some important limitations apply to modifying HFS check throttling values once the
operation has started. For example, once the index sweep pass has terminated, the
corresponding concurrency parameter is no longer used and therefore changing the
concurrent index stripes setting has no effect.
However, the lengthy passes such as the parity or data sweeps can be changed during
their course though this might take a few seconds or minutes to become operative.

Synopsis
avmaint hfscheckthrottle [--concurrentdatastripes=NUM]
[--concurrentindexstripes=NUM] [--concurrentparitystripes=NUM]
[--gccount] [--throttle] --avamaronly GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint hfscheckthrottle command.

Table 73 Command options for the avmaint hfscheckthrottle command

Option Description

--concurrentdatastripes=NUM Specifies the maximum number of data stripes that are

simultaneously processed on a single node during a index
sweep. The higher the value, the more concurrent work is
being performed. The default setting is 0 (one per disk).

--concurrentindexstripes=NUM Specifies the maximum number of index stripes that are

simultaneously processed on a single node during an
index sweep. The higher the value, the more concurrent
work is being performed. The default setting is 2.

--concurrentparitystripes=NUM Specifies the maximum number of parity stripes that are

simultaneously processed on a single node during a parity
sweep. The higher the value, the more concurrent work is
being performed. The default setting is 0 (one per disk).

--gccount Specifies the maximum number of index stripes that are

simultaneously processed on a single node during the
refcheck phase.

--throttle If supplied, throttling is used to conserve resources during

the specified HFS check. This is the default setting.
This option added in version 5.0.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

avmaint 117
EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 74 Deprecated command options for the avmaint hfscheckthrottle command

Option Description

--throttlelevel=NUM Deprecated in version 5.0 in favor of --throttle.

Specifies the amount of throttled resources (measured as a percentage
of CPU capacity) that can be allocated to other tasks.
For example, a setting of 20 begins throttling once CPU usage exceeds
80%. Values in excess of 100 are treated as 100% (maximum
throttling); a value of zero specifies that no throttling is to be
performed.
If a deadline is specified, the throttle level indicates a maximum
allowable throttle level, and the throttle level starts at half this value.
The default setting is 20 if no deadline is specified; 40 if deadline is
specified.

Notes
Consider the following notes for the avmaint hfscheckthrottle command:
◆ You must include the --avamaronly option.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.

118 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint infomessage
The avmaint infomessage command writes an informational text message to the server
log.
The avmaint infomessage command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint infomessage commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint infomessage TEXT [--errcode=NUM]
[--errkind={error | info | warning}] --avamaronly GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint infomessage command.

Table 75 Parameters for the avmaint infomessage command

Parameter Description

TEXT Informational TEXT message that is written to the server log.

Command options
The following command options are available for the avmaint infomessage command.

Table 76 Command options for the avmaint infomessage command

Option Description

--errcode=NUM Specifies an error code number (NUM) for this message.

--errkind= Specifies the type of error message. One of the following:

{error | info | warning}
• error—Designate this message as an error message.
• info—Designate this message as an informational message.
• warning—Designate this message as a warning message.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

avmaint 119
EMC CONFIDENTIAL
Command Reference

avmaint kill
The avmaint kill command stops this client SESSION-ID.

Synopsis
avmaint kill SESSION-ID [--waittime=SEC] GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint kill command.

Table 77 Parameters for the avmaint kill command

Parameter Description

SESSION-ID Specifies which client SESSION-ID to stop.

Command options
The following command option is available for the avmaint kill command.

Table 78 Command options for the avmaint kill command

Option Description

--waittime=SEC Specifies the number of seconds (SEC) to wait before terminating client
sessions to enable clients to terminate gracefully. The default setting is 600
seconds.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

120 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint logscan
The avmaint logscan command enables enhanced server log scanning, which detects and
reports certain kinds of hardware failures in addition to Avamar software errors.
The avmaint logscan command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint logscan commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.
The avmaint logscan command uses an input file (LOGSCANFILE), which contains a list of
log file descriptors (that is, log files to scan) and matching patterns for each log file to
evaluate.
Each log file descriptor must include at least one pattern used to match lines in the
corresponding log file. Each pattern is given a chance to evaluate each new entry in the log
file.
Patterns are tested in the order specified by the optional order attribute, or in some
undefined order if no order attributes are provided. Once a pattern is matched, no further
testing is performed. All patterns without the optional order attribute are tested after any
patterns that specify an order attribute.
An optional Boolean enabled attribute indicates whether the pattern should be used. If
the enabled attribute is not present, then the pattern is tested.

Synopsis
avmaint logscan {local | server } [LOGSCANFILE] --avamaronly
GLOBAL-OPTIONS

Parameters
The following parameters are available for the avmaint logscan command.

Table 79 Parameters for the avmaint logscan command

Parameter Description

LOGSCANFILE If supplied, Specifies the new enhanced server log scanning parameters
information and returns old information.
If not supplied, the current logscan input file is returned.

local | server If local is supplied, user-defined local LOGSCANFILE is used.

If server is supplied, default LOGSCANFILE is used. This is the default.
These parameters added in version 6.1.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

avmaint 121
EMC CONFIDENTIAL
Command Reference

Input file
An avmaint logscan input file (LOGSCANFILE) must conform to the following format:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<logscanfilelist>
<logscanfile
pathname="/var/log/messages"
index="0">
<logscanpattern
order="0"
severity="error"
time="%b %d %T"
pattern="^([a-zA-Z]{3} [0-9 ][0-9]
([0-9]{2}:){2}[0-9]{2}).*error"
prefix="kernel error: ">
<exclude
pattern="&lt;Code&gt;.+&lt;Type&gt;.+&lt;Severity&gt;.+&lt;Category&gt
;.+&lt;HwSource&gt;.+&lt;Summary&gt;"/>
</logscanpattern>
<logscanpattern
order="1"
severity="info"
time="%b %d %T"
pattern="^([a-zA-Z]{3} [0-9 ][0-9]
([0-9]{2}:){2}[0-9]{2}).*kernel:"
prefix="kernel info: ">
<exclude
pattern="&lt;Code&gt;.+&lt;Type&gt;.+&lt;Severity&gt;.+&lt;Category&gt
;.+&lt;HwSource&gt;.+&lt;Summary&gt;"/>
</logscanpattern>

The following sections describe the avmaint logscan input file XML elements and
attributes.

The logscanfilelist element

This element contains one or more log file descriptors (that is, logscanfile sub-elements)
that describe which hardware log files to scan, which entries in those log files are of
interest and how to format and output entries of interest as Avamar event codes.
The logscanfilelist element is limited to a maximum of eight log file descriptors.

Attributes for the logscanfilelist/logscanfile element

The following table lists the attributes associated with the logscanfilelist/logscanfile
element.

Table 80 Attributes for the logscanfilelist/logscanfile element

Attribute Description

pathname Full path and filename of a log file to scan.

index This index attribute provides an internal identifier for saving log file state. Valid
values are whole integers 0 through 7.
/var/log/messages should be index 0 for compatibility with previous server
versions.

prefix Optional text string that is prefixed to each Avamar event generated from a detected
pattern in the scanned log file.

enabled If true or not present, this log file is scanned.

If false, log file is not scanned.

122 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Attributes for the logscanfilelist/logscanfile/logscanpattern element

The following table lists the attributes associated with the
logscanfilelist/logscanfile/logscanpattern element:

Table 81 Attributes for the logscanfilelist/logscanfile/logscanpattern element

Attribute Description

severity Format this entry of interest as one of the following Avamar event types:
• error—Error
• info—Informational
• msg—Message
• warning—Warning

time Optional time stamp before which the server ignores entries in scanned log files.
This allows the server to avoid generating events for entries that occurred before the
server started or restarted.
If not included, an Avamar event is generated for all matching log file entries.
The time attribute should provide a descriptor to interpret the entry time. The time
subexpression must be the first subexpression in the pattern.

pattern A POSIX 1003.2 regular expression that is evaluated to determine log file entries of
interest.
All pattern matches use the “modern” extended regular expressions and ignore case.
The regular expression should include a subexpression that identifies the time of the
entry, and the time attribute should provide a descriptor to interpret the entry time.
The time subexpression must be the first subexpression in the pattern. The time
allows the server to avoid generating messages for events that occurred before the
server started or restarted.
If no time information is provided, a message is generated for all matching log file
entries

prefix Optional text string that is prefixed to each log file entry detected by this pattern.

enabled If true or not present, this pattern is matched.

If false, pattern is not matched.

order Optional attribute that specifies the processing order for each matching pattern in a
log file descriptor. Valid values are unsigned integers.
Patterns are tested in the order specified by the optional order attribute, or in some
undefined order if no order attributes are provided. Once a pattern is matched, no
further testing is performed. All patterns without the optional order attribute are
tested after any patterns that specify an order attribute. This attribute is unused in
Avamar 7.0 and later.

Attributes for the logscanfilelist/logscanfile/logscanpattern/exclude element

The logscanfilelist/logscanfile/logscanpattern/exclude element is an optional element
that takes as attributes a list of POSIX 1003.2 regular expressions that are excluded (i.e.,
that are ignored).

avmaint 123
EMC CONFIDENTIAL
Command Reference

avmaint lookup
The avmaint lookup command looks up the supplied HASH and returns information about
the associated index and data stripes.
The avmaint lookup command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint lookup commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint lookup HASH [H | P | U] --avamaronly GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint lookup command.

Table 82 Parameters for the avmaint lookup command

Parameter Description

HASH HASH is a 40-character hex hash value.

Command options
The following command option is available for the avmaint lookup command.

Table 83 Command options for the avmaint lookup command

Option Description

H | P | U One of the following hash types can also be supplied, which restricts the lookup
operation to specific areas of the server:
• H—Hash File System (HFS)
• P—Persistent store hash
• U—User account hash

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.
You also should include the --xmlperline=NUM global option to control the number of XML
attributes per line.

124 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint ls
The avmaint ls command list all objects in a specified location and below.

Synopsis
avmaint ls LOCATION [--columns=NAMES] [--long] [--noheaders] [--xml]
GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint ls command.

Table 84 Parameters for the avmaint ls command

Parameter Description

LOCATION List all objects in this LOCATION and below.

Command options
The following command options are available for the avmaint ls command.

Table 85 Command options for the avmaint ls command

Option Description

--columns=NAMES If supplied, show only these column NAMES.

This option added in version 5.0.

--long Displays details in a columnar format.

--noheaders If supplied with --long, column headers are not shown.

This option added in version 5.0.

--xml Formats the output of avmaint ls in XML.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
If output is XML, you should include the --xmlperline=NUM global option to control the
number of XML attributes per line.

avmaint 125
EMC CONFIDENTIAL
Command Reference

avmaint lscp
The avmaint lscp command lists available checkpoints.

Synopsis
avmaint lscp [--full] GLOBAL-OPTIONS

Command options
The following command option is available for the avmaint lscp command.

Table 86 Command options for the avmaint lscp command

Option Description

--full Lists all checkpoints in the system (including invalid checkpoints).

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 87 Deprecated command options for the avmaint lscp command

Option Description

--keepmin Deprecated in version 5.0.

Enables the keep minimal checkpoints feature for this session.
This option added in version 4.0.

Notes
This command does not output plain text. Output is strictly XML. You should include the
--xmlperline=NUM global option to control the number of XML attributes per line.

126 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Output
Status is output in XML in the following format:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<checkpointlist nodecount="8">
<checkpoint
tag="cp.20131029223027"
isvalid="true"
refcount="8"
cpctime="1193697027"
nodestotal="8"
stripestotal="4461"
hfsctime="1190066259"
dirstotal="4"
deletable="false">
<hfscheck
starttime="1193697089"
nodestarttime="1193697525"
nodefinishedtime="1193701649"
validcheck="true"
errors="0"
type="full"
stripes-checking="4451"
stripes-completed="4451">
<hfscheckerrors/>
</hfscheck>
<nodeidlist count="8">
<nodeidrange
dcno="0"
lseqno="0"
useqno="0"/>
<nodeidrange
dcno="0"
lseqno="2"
useqno="3"/>
<nodeidrange
dcno="0"
lseqno="5"
useqno="9"/>
</nodeidlist>
</checkpoint>
</checkpointlist>

The following table describes each avmaint lscp XML attribute.

Table 88 XML attributes for the avmaint lscp command (page 1 of 2)

Attribute Description

nodecount Number of nodes in system checkpoint.

tag Name of checkpoint.

isvalid If TRUE, this is a usable checkpoint (that is, one that can be HFS checked
and if it passes, can be used as a reliable system rollback point).

refcount Number of nodes participating in checkpoint.

cpctime Time at which checkpoint was taken.

nodestotal Number of nodes in system.

stripestotal Total number of stripes stored in checkpoint.

hfsctime Time at which HFS was initialized.

avmaint 127
EMC CONFIDENTIAL
Command Reference

Table 88 XML attributes for the avmaint lscp command (page 2 of 2)

Attribute Description

dirstotal Number of directories on each node participating in checkpoint.

These generally correspond to the number of disk partitions.

deletable Indicates if checkpoint can be automatically deleted.

starttime Time at which hfscheck was initiated.

nodestarttime Earliest time at which check proper started on a node.

nodefinishedtime Latest time at which check completed on a node.

validchecks If TRUE, this HFS check was successful; If FALSE, this HFS check failed.

errors Number of detected errors.

This value does not reflect any automatic data stripe repair that took place
after the HFS check completed.

type Check type. One of the following:

• full—All checks are performed on all stripes.
• reduced—Checkpoint was taken on N nodes but checked on N-1 nodes.
• partial—All other kinds of checks.

stripes-checking Total number of stripes being checked.

This is always less than the number of stripes contained in the checkpoint
because management stripes are never checked and not counted.

stripes-completed Total number of stripes checked.

This value simply records the number of stripes that checked and does not
include any information on how they were checked.

hfscheckerrors Reported errors.

nodeidlist nodeidrange is a subrange of nodes included in this checkpoint.

• dc—Datacenter ID
• lseqno—Lowest logical node number covered by this range
• useqno—Highest logical node number covered by this range

128 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint networkconfig
The avmaint networkconfig command displays or modifies server network configuration.
The avmaint networkconfig command is considered an advanced command that is
normally intended for use by expert users only. You must include the --avamaronly option
with all avmaint networkconfig commands. If you are unsure about any aspect of this
command, contact EMC Customer Support for additional information before using it.

Synopsis
avmaint networkconfig [INPUT-FILE] GLOBAL-OPTIONS --avamaronly

Parameters
The following parameter is available for the avmaint networkconfig command.

Table 89 Parameters for the avmaint networkconfig command

Parameter Description

INPUT-FILE If INPUT-FILE is supplied, contents of /usr/local/avamar/var/probe.xml is

displayed, then modified with information contained in INPUT-FILE.
If INPUT-FILE is not supplied, contents of /usr/local/avamar/var/probe.xml is
displayed.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint networkconfig command:
◆ You must include the --avamaronly option to use this command.
◆ INPUT-FILE must be an XML file and conform to the format specified for probe.xml.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.
◆ This command added in version 5.0.

Example
The following command modifies /usr/local/avamar/var/probe.xml with content from
newprobe.xml:
avmaint networkconfig ./newprobe.xml --avamaronly

avmaint 129
EMC CONFIDENTIAL
Command Reference

avmaint nodelist
The avmaint nodelist command returns status of all nodes.

Synopsis
avmaint nodelist [--short] [--utilitynode] GLOBAL-OPTIONS

Command options
The following command option is available for the avmaint nodelist command.

Table 90 Command options for the avmaint nodelist command

Option Description

--short If supplied, returns an abbreviated report that does not contain configuration,
checkpoint, garbage collection, or HFS check information.

--utilitynode If supplied, only utility node information is returned.

This option added in version 7.0.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command does not output plain text. Output is strictly XML. You should include the
--xmlperline=NUM global option to control the number of XML attributes per line.

Output
The avmaint nodelist command returns the following status codes.

Table 91 Status codes for the avmaint nodelist command

Status code Description

Online Node is functioning properly.

Offline Node has experienced a problem.

Ready Transitional state that might or might not be due to normal operation.

Migrating Node is migrating stripes.

Dead Decommissioned.

The full server access mode is typically represented as three four-bit fields. For example:
mhpu+mhpu+0000.
The most significant bits show server privileges, the middle bits show root user privileges,
and the least significant bits show privileges for all other users.

130 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

The individual bits in these fields convey the following information.

Table 92 Individual bits in full server access mode fields

Bit Description

m Maintenance is allowed.

h HFS is writable.

p Persistent store is writable.

u User accounting is writable.

The following additional information is returned by the avmaint nodelist command.

Table 93 Additional information returned by the avmaint nodelist command

Information Description

Dis Number of dispatchers running on the node. There is one dispatcher for every
command that is currently running.

UsedMB Total amount of node RAM currently being used by all processes.

Errlen Size of the server message log in bytes.

Examples
Although the following example wraps to more than one line, you must enter all
commands and options on a single command line without any line feeds or returns.
The following command returns status of all Avamar server nodes:
avmaint nodelist --id=admin@avamar --hfsaddr=avamar-1.example.com
--xmlperline=1

avmaint 131
EMC CONFIDENTIAL
Command Reference

avmaint perf
The avmaint perf status command returns operational status and performance monitoring
statistics for the entire server or specified nodes.
The avmaint perf reset command resets the performance monitoring statistics.
The showperfhistory command runs avmaint perf status and displays the average disk
read performance rates in an easy-to-view format, sorted first by event sets, then by
average read rate.

Synopsis
avmaint perf {reset NODE-ID --disknum=NUM --events=EVENT-BITS
| status [NODE-ID]} GLOBAL-OPTIONS

Commands
Supply one and only one of the following commands on each command line for the
avmaint perf command.

Table 94 Commands for the avmaint perf command

Command Description

reset NODE-ID Resets the performance monitoring statistics.

--disknum=NUM
--events=EVENT-BITS NODE-ID specifies a logical node number, --disknum=NUM specifies a
disk on that node, and --events=EVENT-BITS is a valid numeric events
bit value for this disk.
To determine a valid --events=EVENT-BITS value, run showperfhistory
and use the value in the Event Bits column for the disk to reset.
NODE-ID, --disknum=NUM and --events=EVENT-BITS are all required.

status [NODE-ID] Outputs performance status in XML format.

If one or more NODE-IDs are supplied, then data is returned for those
nodes only; otherwise, data for all nodes is returned.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint perf command:
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.
◆ This command added in version 4.1.

Output
Output is XML in the following format:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE perfstatuslist>
<perfstatuslist>
<perfstatus node="0.F" create-time="1155949181"
start-time="1155947404">
<stripekinds indx="4" data="8" comp="2" winx="1" wdat="1"

132 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

wcmp="1" uinx="1" udat="2" lpar="6" mang="1" dlst="4"/>

<checkpoint count="2" time="2" stripe-total="62"/>
<garbagecollect count="90" time="304"/>
<hfscheck count="1" time="35"/>
<crunch count="0" time="0" nchunks="0" nbytes="0"/>
<connections>
<connection type="unknown" count="2" time="2"/>
<connection type="avmaint" count="7" time="8"/>
<connection type="accounting" count="2" time="2"/>
<connection type="restore+accounting" count="1" time="6"/>
</connections>
<addhashdata total-bytes="82055208">
<chunktype name="atomic" is-dir="false" is-encrypted="false"
has-hints="false">
<chunksizes block-length="1024">
<size count="15" start="0"/>
<size count="11" start="1024"/>
<size count="10" start="2048"/>
<size count="14" start="3072"/>
<size count="1" start="61440"/>
</chunksizes>
</chunktype>
<chunktype name="recipe2" is-dir="false" is-encrypted="false"
has-hints="true">
<chunksizes block-length="1024">
<size count="59" start="0"/>
</chunksizes>
<compsizes>
<elem count="8" size="1"/>
<elem count="21" size="3"/>
<elem count="20" size="4"/>
<elem count="8" size="6"/>
<elem count="2" size="9"/>
</compsizes>
</chunktype>
</addhashdata>
<gethashdata total-bytes="5143844">
<chunktype name="atomic" is-dir="false" is-encrypted="false"
has-hints="false">
<chunksizes block-length="1024">
<size count="15" start="0"/>
<size count="11" start="1024"/>
<size count="10" start="2048"/>
<size count="14" start="3072"/>
<size count="1" start="61440"/>
</chunksizes>
</chunktype>
<chunktype name="recipe2" is-dir="false" is-encrypted="false"
has-hints="true">
<chunksizes block-length="1024">
<size count="59" start="0"/>
</chunksizes>
<compsizes>
<elem count="8" size="1"/>
<elem count="21" size="3"/>
<elem count="20" size="4"/>
<elem count="8" size="6"/>
<elem count="2" size="9"/>
</compsizes>
</chunktype>
</gethashdata>
<messages total-requests="539">
<messagemap>
<message code="GET_HASH_DATA" count="420"/>
<message code="GETHFSCREATETIME" count="11"/>
<message code="STATS_DATA" count="2"/>

avmaint 133
EMC CONFIDENTIAL
Command Reference

<message code="GETSESSIONINFO" count="16"/>

<message code="GETNODELIST" count="2"/>
<message code="MSG_CMD_LOGIN" count="1"/>
<message code="MSG_CMD_ACCESS_CHILD" count="1"/>
<message code="CLOSE_CONNECTION" count="1"/>
<message code="INDEX_DATACENTER_MAP" count="1"/>
<message code="GETDISPATCHERLIST" count="11"/>
<message code="MSG_CMD_SEARCH" count="9"/>
<message code="GARBAGE_COLLECT" count="1"/>
<message code="SETSESSIONINFO2" count="1"/>
<message code="CHECKPOINTRM" count="1"/>
<message code="INITUSERINFO" count="1"/>
<message code="GETNODESTATUS" count="16"/>
<message code="DPNPING" count="12"/>
<message code="SYSLOG" count="10"/>
<message code="GCSTATUS" count="2"/>
<message code="REQUESTRUNLEVEL" count="1"/>
<message code="GETCONFIG" count="1"/>
<message code="REQUESTCONNECTION" count="2"/>
<message code="OPENCONNECTION" count="1"/>
<message code="GETDPNINFO" count="12"/>
<message code="GETCPSTATUS" count="1"/>
<message code="DPNCHECK_STATUS" count="1"/>
<message code="STARTOFFSETCONVERSION" count="1"/>
</messagemap>
</messages>
</perfstatus>
</perfstatuslist>
<perfhistorylist>
<perfhistory diskid="0" devsize="715914366976" devname="/dev/sda9"
bufsize="1048576" timeoutsecs="300" tests-used="2656"
tests-skipped="178" tests-failed="41" state="online">
<statvalue name="rawread" count="1003437" last="0.0159"
min="0.0004" max="36.1233" sum="14664.1959" mean="0.0146"
sdev="0.0998"/>
<statvalue name="mbpersec" count="2834" last="67.4734"
min="0.0554" max="271.7489" sum="199389.9495" mean="70.3564"
sdev="15.9513"/>
<eventstatlist>
<stathistorylist span="3" average="73.90" event-mask="[]"
event-bits="0">
<stathistory days-ago="0">
<statvalue count="320" last="67.4734" mean="75.8872"
min="66.6702" max="78.5025" sdev="2.8406"/>
</stathistory>
<stathistory days-ago="1">
<statvalue count="176" last="78.3248" mean="74.5322"
min="37.3438" max="78.4305" sdev="4.0133"/>
</stathistory>
<stathistory days-ago="2">
<statvalue count="87" last="75.0346" mean="72.2670"
min="20.0551" max="78.4076" sdev="11.0151"/>
</stathistory>
</stathistorylist>
</eventstatlist>
</perfhistory>
</perfhistorylist>

134 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Each state attribute within the perfhistory element for each disk can have the following
values.

Table 95 Values for the perfhistory state element

Value Meaning

online Disk is online and performing satisfactorily.

suspended Disk is suspended.

suspending Disk is in the process of being suspended.

resuming Disk is in the process of being put back online.

For example:
<perfhistory diskid="1" devsize="737840967680" devname="/dev/sdb1"
bufsize="1048576" timeoutsecs="300" tests-used="2676"
tests-skipped="158" tests-failed="34" state="online">

avmaint 135
EMC CONFIDENTIAL
Command Reference

avmaint ping
The avmaint ping command returns stripe status.

Synopsis
avmaint ping [STRIPE-ID] [{--alwaysping | --details}]
[--kind={comp | data | dlst | indx | lpar | mang | ppar | spar | udat
| uinx | wcmp | wdat | winx}] [--state={ONLINE | OFFLINE |
OFFLINE_MEDIA_ERROR | READY | MIGRATING | RESTARTING}]
GLOBAL-OPTIONS

Command options
The following commands are available for the avmaint ping command.

Table 96 Command options for the avmaint ping command

Option Description

STRIPE-ID Restricts the output to only the specified stripe id, for example
0.0-3

--alwaysping | --details Supplying either --alwaysping or --details forces a ping of all

stripes to obtain the most current status. The default setting is
false.

--kind={comp | data | Returns status for all stripes of a particular kind. Valid values are
dlst | indx | lpar | one of the following:
mang | ppar | spar |
udat | uinx | wcmp | • comp—Hash composite data stripe.
wdat | winx} • data—Hash atomic data stripe.
• dlst—Delete stripe.
• indx—Hash index stripe.
• lpar—Local parity stripe.
• mang—Manage stripe.
• ppar—Parity/parity stripe.
• spar—Safe parity stripe.
• udat—User data stripe.
• uinx—User index stripe.
• wcmp—Read/write composite data stripe.
• wdat—Read/write atomic data stripe.
• winx—Read/write index stripe.
The default setting is all stripes.

--state={ONLINE | Returns status for all stripes in a particular state. Valid values are
OFFLINE | one of the following:
OFFLINE_MEDIA_ERROR |
READY | MIGRATING | • ONLINE—Only return status for stripes in an online state.
RESTARTING} • OFFLINE—Only return status for stripes in an offline state.
• OFFLINE_MEDIA_ERROR—Only return status for stripes that are
offline due to hard disk (media) errors.
• READY—Only return status for stripes in a ready state.
• MIGRATING—Only return status for stripes that are currently
migrating data to other stripes.
• RESTARTING—Only return status for stripes that are restarting.
The default setting is all states.
This option added in version 4.0.

136 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint ping command:
◆ Similar to the avmaint stats command.
◆ You should include the --xml and the --xmlperline=NUM global option to specify XML
output and to control the number of XML attributes per line, respectively.

avmaint poolcheck
The avmaint poolcheck command is used to validate the integrity of the server free file
pool.
The avmaint poolcheck command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint poolcheck commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint poolcheck --avamaronly [--xmlperline=NUM]

Options
The following options are available for the avmaint poolcheck command.

Table 97 Command options for the avmaint poolcheck command

Option Description

--avamaronly Enables Avamar-only commands and options.

--xmlperline=NUM Controls number (NUM) of XML attributes per line.

Notes
Consider the following notes for the avmaint poolcheck command:
◆ This command added in version 5.0.
◆ You must include the --avamaronly option.
◆ This command does not output plain text. Output is strictly XML. You should include
the --xmlperline=NUM global option to control the number of XML attributes per line.

avmaint 137
EMC CONFIDENTIAL
Command Reference

Examples
The following example output is typical of what might be returned if a checkpoint is first
removed using avmaint rmcp command, then avmaint poolcheck is run:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<filepoolcheck timestamp="2013-Sep-21 22:23:25">
<response nodeid="0.3" code="MSG_ERR_NONE">
<filepoolcheckresults check-started="2013-Sep-21 22:19:28"
check-elapsed="00:03:48" check-timeout="false"
missing-disk-errors="0">
<freelist checked="6238" open-errors="0" in-use-errors="0"
write-errors="0" truncates="0"/>
<files checked="18191" in-use="8948" free="6238"
recent-allocations="0" recovered="3005"/>
</filepoolcheckresults>
</response>
<response nodeid="0.2" code="MSG_ERR_NONE">
<filepoolcheckresults check-started="2013-Sep-21 22:19:28"
check-elapsed="00:03:46" check-timeout="false"
missing-disk-errors="0">
<freelist checked="6156" open-errors="0" in-use-errors="0"
write-errors="0" truncates="0"/>
<files checked="18167" in-use="8993" free="6156"
recent-allocations="0" recovered="3018"/>
</filepoolcheckresults>
</response>
<response nodeid="0.1" code="MSG_ERR_NONE">
<filepoolcheckresults check-started="2013-Sep-21 22:19:28"
check-elapsed="00:03:57" check-timeout="false"
missing-disk-errors="0">
<freelist checked="5886" open-errors="0" in-use-errors="0"
write-errors="0" truncates="0"/>
<files checked="17757" in-use="8926" free="5886"
recent-allocations="0" recovered="2945"/>
</filepoolcheckresults>
</response>
<response nodeid="0.0" code="MSG_ERR_NONE">
<filepoolcheckresults check-started="2013-Sep-21 22:19:28"
check-elapsed="00:03:24" check-timeout="false"
missing-disk-errors="0">
<freelist checked="6401" open-errors="0" in-use-errors="0"
write-errors="0" truncates="0"/>
<files checked="18355" in-use="8956" free="6401"
recent-allocations="0" recovered="2998"/>
</filepoolcheckresults>
</response>
</filepoolcheck>

138 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint rebuildstripe
The avmaint rebuildstripe command returns rebuilds offline stripes.
The avmaint rebuildstripe command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint rebuildstripe commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint rebuildstripe {STRIPE-ID | --full} [--force] --avamaronly
GLOBAL-OPTIONS

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint rebuildstripe command.

Table 98 Parameters for the avmaint rebuildstripe command

Parameter Description

STRIPE-ID Rebuilds only this stripe. Another rebuild is not allowed until this stripe is finished
rebuilding.

--full Rebuilds all offline stripes.

Command options
The following command option is available for the avmaint rebuildstripe command.

Table 99 Command options for the avmaint rebuildstripe command

Option Description

--force Rebuilds stripes that are not in the OFFLINE_MEDIA_ERROR state.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

Examples
The following command rebuilds a single offline stripe (0.0-B9):
avmaint rebuildstripe 0.0-B9

The following command rebuilds all offline stripes in the system:

avmaint rebuildstripe --full

avmaint 139
EMC CONFIDENTIAL
Command Reference

avmaint removebadhashes
The avmaint removebadhashes command removes a set of hashes that are tied to a
specific verification token. You must first run avmaint findbadhashes to obtain the
verification token and to place the server in read-migrate mode.
The avmaint removebadhashes command is considered an advanced command that is
normally intended for use by expert users only. You must include the --avamaronly option
with all avmaint removebadhashes commands. If you are unsure about any aspect of this
command, contact EMC Customer Support for additional information before using it.

Synopsis
avmaint removebadhashes VERIFICATION --avamaronly GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint removebadhashes command.

Table 100 Parameters for the avmaint removebadhashes command

Parameter Description

VERIFICATION VERIFICATION token, output from avmaint findbadhashes.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command added in version 4.1.

140 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint rmcp
The avmaint rmcp command removes one or more checkpoints.
The avmaint rmcp command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint rmcp commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint rmcp {CP-ID | --full} [--risklosingallbackups] --avamaronly

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint rmcp command.

Table 101 Parameters for the avmaint rmcp command

Parameter Description

CP-ID If a valid checkpoint ID (CP-ID) is supplied, only that checkpoint is deleted.

--full Supplying --full invokes multiple checkpoint removal mode.

First, all checkpoints are initially considered as eligible to be deleted and the
checkpoints are chronologically sorted to determine which ones are retained in the
system.
Next, a previously specified number of most recent and validated (HFS-checked)
checkpoints are marked as ineligible for deletion. This behavior is controlled by the
avmaint config cpmostrecent and avmaint config cphfschecked commands,
respectively.
Finally, any checkpoints still determined to be eligible for deletion are then deleted by
the system.

Command options
The following command option is available for the avmaint rmcp command.

Table 102 Command options for the avmaint rmcp command

Option Description

--risklosingallbackups If supplied with a single checkpoint ID (CP-ID), the default

mechanism for determining which checkpoints to keep is defeated.
Effectively, this allows a single checkpoint to be deleted even if that
could result in loss of data.

Note: Misuse of this option could result in permanent loss of data.

This option added in version 5.0.

avmaint 141
EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 103 Deprecated command options for the avmaint rmcp command

Option Description

--keepmin This option added in version 4.0 and deprecated in version 5.0.
If supplied with --full, enables the keep minimal checkpoints feature for this
session.
This option can only be used with --full (not individual checkpoint IDs).

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
If a checkpoint is in progress when you run avmaint rmcp and you specify either the ID of
the checkpoint that is in progress or --full, then the avmaint rmcp command fails and the
following error is written to the gsan log files: MSG_ERR_CHECKPOINTS. To proceed with
removing the checkpoint that is in progress, run avmaint rmcp again with the
--risklosingallbackups option specified.

142 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint sched
The avmaint sched command is used to configure and manage server maintenance
windows and maintenance operations.
This command is not allowed when the server is in a readonly state.

Synopsis
avmaint sched {balance [--balancemin=NUM] | cancel --waittime=MIN
| conversion [OPTIONS] | cp [OPTIONS] [--delete={TRUE | FALSE}]
| crunchwait [--waittime=MIN] | gc [OPTIONS]
| hfscheck [OPTIONS] [--overtime={TRUE | FALSE}]
| resume [balance | conversion | cp | gc | hfscheck]
| profile PROFILE-NAME | reset --avamaronly| start | status | stop
| suspend [--permanent] [balance | conversion | cp | gc | hfscheck]
| window [WINDOW-OPTIONS]} [--permanent] [--reset] GLOBAL-OPTIONS

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint sched command.

Table 104 Parameters for the avmaint sched command (page 1 of 3)

Parameter Description

balance Configures server load balancing during the maintenance

[--balancemin=NUM] window.
When this value is zero, no balancing is performed.
When this value is one, all stripes except for HFS atomic data
stripes are balanced based on the count of each type of stripe on
each node.
For values between 2 and 99, this is a threshold percentage that
triggers load balancing.

Note: This option performs the same function as the avmaint

config balancemin parameter, but only during the maintenance
window. If you set the avmaint config balancemin parameter to a
value other than zero, then the avmaint sched balance parameter
is ignored.

If --permanent is supplied, these changes are permanent.

This parameter added in version 6.1.

cancel --waittime=MIN Cancels all active backups during the specified number of
minutes (MIN) prior to starting garbage collection.

conversion [OPTIONS] Specifies which settings to use for the next stripe conversion
operation, where OPTIONS is one or more valid avmaint
conversion option.
If --permanent is supplied, these changes are permanent.

cp [OPTIONS] Specifies which settings to use for the next checkpoint

operation, where OPTIONS is one or more valid avmaint
checkpoint option.
If --permanent is supplied, these changes are permanent.

avmaint 143
EMC CONFIDENTIAL
Command Reference

Table 104 Parameters for the avmaint sched command (page 2 of 3)

Parameter Description

crunchwait The crunchwait task keeps the system idle between garbage
[--waittime=MIN] collection and the first checkpoint to allow for asynchronous
crunching. The task runs for 60 minutes by default.
To change the duration of the task, use the --waittime=MIN
option with the avmaint sched crunchwait command.

Note: Asynchronous crunching does not occur if backups are in

progress.

If --permanent is supplied, these changes are permanent.

This parameter added in version 7.0.

gc [OPTIONS] Specifies which settings to use for the next garbage collection
operation, where OPTIONS is one or more valid avmaint
garbagecollect options.
If --permanent is supplied, these changes are permanent.

hfscheck [OPTIONS] Specifies which settings to use for the next checkpoint validation
operation (also known as HFS check), where OPTIONS is one or
more valid avmaint hfscheck options.
If --permanent is supplied, these changes are permanent.

resume Used to resume a previously suspended maintenance operation.

[balance | conversion Valid values are:
| cp | gc | hfscheck]
• balance—Server load balancing
• conversion—Stripe conversion
• cp—Checkpoint
• gc—Garbage collection
• hfscheck—Checkpoint validation (also known as HFS check)
If an operation is supplied, then only that operation is resumed.

profile PROFILE-NAME Specifies which profile to use. Profiles control the ordering of
maintenance activities. One of the following:
• capacity—Legacy ordering (gc, cp, hfscheck).
• choosebest—Automatically select optimum ordering of
maintenance activities at the start of each window.
• performance—Performance optimized ordering (cp, gc,
hfscheck).

reset Reset the scheduler's internal state. Window options, task

parameters, and suspend states are preserved.

start Start the scheduler so that maintenance activities automatically

run as scheduled.

status The current state of the internal scheduler is returned, including

all of the currently active settings.

stop Stop the scheduler entirely. Maintenance activities are no longer

automatically scheduled.
If this command is issued while maintenance operations are in
progress, then the current operation is stopped at the next
convenient point in time.

144 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 104 Parameters for the avmaint sched command (page 3 of 3)

Parameter Description

suspend Used to suspend a maintenance operation. Valid values are:

[balance | conversion
| cp | gc | hfscheck] • balance—Server load balancing
• conversion—Stripe conversion
• cp—Checkpoint
• gc—Garbage collection
• hfscheck—Checkpoint validation (also known as HFS check)
If an operation is supplied, then only that operation is
suspended.
If this command is issued while maintenance operations are in
progress, then the specified operation is suspended on the next
day.
If --permanent is supplied, then the specified operation is
suspended until an avmaint sched resume command is received.
If --permanent is not supplied, then the specified operations are
suspended until after the end of the next backup window, at
which time maintenance automatically resumes.

window [WINDOW-OPTIONS] The values of the specified options define the maintenance
windows. See below for details of these options.

Window options
Supply any of the following options with each avmaint sched window command to
configure a new maintenance window.

Table 105 Window options for the avmaint sched window command

Option Description

--backup-start=HHMM Defines the primary backup window start time in HHMM format,
where HH is the number of hours and MM is the number of
minutes. For example, 245 is 2 hours and 45 minutes; 1000 is 10
hours). The default setting is 8 p.m. (2000).

--backup-duration=HHMM Defines the backup window length in HHMM format, where HH is

the number of hours and MM is the number of minutes. For
example, 245 is 2 hours and 45 minutes; 1000 is 10 hours). The
default setting is 12 hours (1200).

--days=DAYS Defines the DAYS of the week to which this maintenance window
applies. Valid values are one or more three-character
abbreviations separated by commas (for example,
Mon,Tue,Wed,Thu,Fri,Sat,Sun). The default setting is all days.

--script-duration=HHMM Defines length of time at the start of each window to run

maintenance scripts in HHMM format, where HH is the number of
hours and MM is the number of minutes. This setting cannot
exceed 1 hour (100), or 1/3 of the duration of any window,
whichever is lower. The default setting is 15 minutes.

--timezone=ZONE Defines timezone used to interpret the value of the --backup-start

option.

avmaint 145
EMC CONFIDENTIAL
Command Reference

Other options
The following other options are available for the avmaint sched command.

Table 106 Command options for the avmaint sched command

Option Description

--delete={TRUE | FALSE} Used with cp command to control whether eligible older

checkpoints are deleted as newer checkpoints are taken.
Eligible checkpoints are determined using the same logic
described for the avmaint rmcp --full parameter.
The default setting is TRUE.

--overtime={TRUE | FALSE} Used with hfscheck command to control whether scheduled HFS
checks are allowed to run past the time allotted in the
maintenance window. The default setting is TRUE.
This option added in version 6.0.

--permanent If supplied with avmaint sched balance, cancel, conversion, cp,

crunchwait, gc, hfscheck, and suspend commands, all specified
settings are permanent changes. If not supplied, specified
settings only apply to the next invocation of the specified
operation. The default setting is false.

--reset If supplied with avmaint sched balance, cancel, conversion, cp,

crunchwait, gc, hfscheck, and suspend commands, settings for
the specified operation are returned to the factory default
values. The default setting is false.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Valid timezones
The avmaint sched window --timezone option must use one of the following timezone
descriptors:
Africa/Abidjan Africa/Accra Africa/Addis_Ababa
Africa/Algiers Africa/Asmera Africa/Bamako
Africa/Bangui Africa/Banjul Africa/Bissau
Africa/Blantyre Africa/Brazzaville Africa/Bujumbura
Africa/Cairo Africa/Casablanca Africa/Ceuta
Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam
Africa/Djibouti Africa/Douala Africa/El_Aaiun
Africa/Freetown Africa/Gaborone Africa/Harare
Africa/Johannesburg Africa/Kampala Africa/Khartoum
Africa/Kigali Africa/Kinshasa Africa/Lagos
Africa/Libreville Africa/Lome Africa/Luanda
Africa/Lubumbashi Africa/Lusaka Africa/Malabo
Africa/Maputo Africa/Maseru Africa/Mbabane
Africa/Mogadishu Africa/Monrovia Africa/Nairobi
Africa/Ndjamena Africa/Niamey Africa/Nouakchott
Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome

146 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Africa/Timbuktu Africa/Tripoli Africa/Tunis

Africa/Windhoek America/Adak America/Anchorage
America/Anguilla America/Antigua America/Araguaina
America/Aruba America/Asuncion America/Barbados
America/Belem America/Belize America/Boa_Vista
America/Bogota America/Boise America/Buenos_Aires
America/Cambridge_Bay America/Cancun America/Caracas
America/Catamarca America/Cayenne America/Cayman
America/Chicago America/Chihuahua America/Cordoba
America/Costa_Rica America/Cuiaba America/Curacao
America/Danmarkshavn America/Dawson America/Dawson_Creek
America/Denver America/Detroit America/Dominica
America/Edmonton America/Eirunepe America/El_Salvador
America/Fortaleza America/Glace_Bay America/Godthab
America/Goose_Bay America/Grand_Turk America/Grenada
America/Guadeloupe America/Guatemala America/Guayaquil
America/Guyana America/Halifax America/Havana
America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox
America/Indiana/Marengo America/Indiana/Vevay America/Indianapolis
America/Inuvik America/Iqaluit America/Jamaica
America/Jujuy America/Juneau America/Kentucky/Louisville
America/Kentucky/Monticello America/La_Paz America/Lima
America/Los_Angeles America/Louisville America/Maceio
America/Managua America/Manaus America/Martinique
America/Mazatlan America/Mendoza America/Menominee
America/Merida America/Mexico_City America/Miquelon
America/Monterrey America/Montevideo America/Montreal
America/Montserrat America/Nassau America/New_York
America/Nipigon America/Nome America/Noronha
America/North_Dakota/Center America/Panama America/Pangnirtung
America/Paramaribo America/Phoenix America/Port-au-Prince
America/Port_of_Spain America/Porto_Velho America/Puerto_Rico
America/Rainy_River America/Rankin_Inlet America/Recife
America/Regina America/Rio_Branco America/Rosario
America/Santiago America/Santo_Domingo America/Sao_Paulo
America/Scoresbysund America/Shiprock America/St_Johns
America/St_Kitts America/St_Lucia America/St_Thomas
America/St_Vincent America/Swift_Current America/Tegucigalpa
America/Thule America/Thunder_Bay America/Tijuana
America/Tortola America/Vancouver America/Whitehorse
America/Winnipeg America/Yakutat America/Yellowknife
Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville
Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer
Antarctica/South_Pole Antarctica/Syowa Antarctica/Vostok

avmaint 147
EMC CONFIDENTIAL
Command Reference

Arctic/Longyearbyen Asia/Aden Asia/Almaty

Asia/Amman Asia/Anadyr Asia/Aqtau
Asia/Aqtobe Asia/Ashgabat Asia/Baghdad
Asia/Bahrain Asia/Baku Asia/Bangkok
Asia/Beirut Asia/Bishkek Asia/Brunei
Asia/Calcutta Asia/Choibalsan Asia/Chongqing
Asia/Colombo Asia/Damascus Asia/Dhaka
Asia/Dili Asia/Dubai Asia/Dushanbe
Asia/Gaza Asia/Harbin Asia/Hong_Kong
Asia/Hovd Asia/Irkutsk Asia/Istanbul
Asia/Jakarta Asia/Jayapura Asia/Jerusalem
Asia/Kabul Asia/Kamchatka Asia/Karachi
Asia/Kashgar Asia/Katmandu Asia/Krasnoyarsk
Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait
Asia/Macao Asia/Macau Asia/Magadan
Asia/Makassar Asia/Manila Asia/Muscat
Asia/Nicosia Asia/Novosibirsk Asia/Omsk
Asia/Oral Asia/Phnom_Penh Asia/Pontianak
Asia/Pyongyang Asia/Qyzylorda Asia/Qatar
Asia/Rangoon Asia/Riyadh Asia/Saigon
Asia/Sakhalin Asia/Samarkand Asia/Seoul
Asia/Shanghai Asia/Singapore Asia/Taipei
Asia/Tashkent Asia/Tbilisi Asia/Tehran
Asia/Thimphu Asia/Tokyo Asia/Ujung_Pandang
Asia/Ulaanbaatar Asia/Urumqi Asia/Vientiane
Asia/Vladivostok Asia/Yakutsk Asia/Yekaterinburg
Asia/Yerevan Atlantic/Azores Atlantic/Bermuda
Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe
Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik
Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley
Australia/Adelaide Australia/Brisbane Australia/Broken_Hill
Australia/Darwin Australia/Hobart Australia/Lindeman
Australia/Lord_Howe Australia/Melbourne Australia/Perth
Australia/Sydney Europe/Amsterdam Europe/Andorra
Europe/Athens Europe/Belfast Europe/Belgrade
Europe/Berlin Europe/Bratislava Europe/Brussels
Europe/Bucharest Europe/Budapest Europe/Chisinau
Europe/Copenhagen Europe/Dublin Europe/Gibraltar
Europe/Helsinki Europe/Istanbul Europe/Kaliningrad
Europe/Kiev Europe/Lisbon Europe/Ljubljana
Europe/London Europe/Luxembourg Europe/Madrid
Europe/Malta Europe/Minsk Europe/Monaco
Europe/Moscow Europe/Nicosia Europe/Oslo
Europe/Paris Europe/Prague Europe/Riga

148 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Europe/Rome Europe/Samara Europe/San_Marino

Europe/Sarajevo Europe/Simferopol Europe/Skopje
Europe/Sofia Europe/Stockholm Europe/Tallinn
Europe/Tirane Europe/Uzhgorod Europe/Vaduz
Europe/Vatican Europe/Vienna Europe/Vilnius
Europe/Warsaw Europe/Zagreb Europe/Zaporozhye
Europe/Zurich GMT Indian/Antananarivo
Indian/Chagos Indian/Christmas Indian/Cocos
Indian/Comoro Indian/Kerguelen Indian/Mahe
Indian/Maldives Indian/Mauritius Indian/Mayotte
Indian/Reunion Pacific/Apia Pacific/Auckland
Pacific/Chatham Pacific/Easter Pacific/Efate
Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji
Pacific/Funafuti Pacific/Galapagos Pacific/Gambier
Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu
Pacific/Johnston Pacific/Kiritimati Pacific/Kosrae
Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas
Pacific/Midway Pacific/Nauru Pacific/Niue
Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago
Pacific/Palau Pacific/Pitcairn Pacific/Ponape
Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan
Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu
Pacific/Truk Pacific/Wake Pacific/Wallis
Pacific/Yap

Notes
Consider the following notes for the avmaint sched command:
◆ This command added in version 5.0.
◆ This command is not allowed when the server is readonly.
◆ This command requires that the Boost library POSIX timezone database is installed.
The default location is utility node /usr/local/avamar/etc. The file is automatically
installed on the utility node during installation. However, if avmaint is being run from
a different machine, the file must exist in /usr/local/avamar/etc on that machine.

avmaint 149
EMC CONFIDENTIAL
Command Reference

avmaint sessions
The avmaint sessions command returns information on the current active client sessions;
output displays in XML format.

Synopsis
avmaint sessions [--full] GLOBAL-OPTIONS

Command options
The following command option is available for the avmaint sessions command.

Table 107 Command options for the avmaint sessions command

Option Description

--full Also shows “unknown” sessions.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
This command does not output plain text. Output is strictly XML. You should include the
--xmlperline=NUM global option to control the number of XML attributes per line.

avmaint stats
The avmaint stats command returns status of all stripes by sending a message to each
stripe and receiving back some information about each stripe that responds.

Synopsis
avmaint stats [STRIPE-ID] [{--alwaysping | --details}] [--extended]
[--kind={comp | data | dlst | indx | lpar | mang | ppar | spar | udat
| uinx | wcmp | wdat | winx}] [--timing] GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint stats command.

Table 108 Command options for the avmaint stats command (page 1 of 2)

Option Description

STRIPE-ID Restricts the output to only the specified stripe id. For example:
0.0-3.

--alwaysping | --details Supplying either --alwaysping or --details forces a ping of all

stripes to obtain the most current status. The default setting is
false.

--extended Returns maximum information. Otherwise, only stripe ID, kind,

and status are returned for each stripe.

150 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 108 Command options for the avmaint stats command (page 2 of 2)

Option Description

--kind={comp | data Specifies the kind of stripe to operate on. Valid values are one
| dlst | indx | lpar of the following:
| mang | ppar | spar
| udat | uinx | wcmp • comp—Hash composite data stripe
| wdat | winx} • data—Hash atomic data stripe
• dlst—Delete stripe
• indx—Hash index stripe
• lpar—Local parity stripe
• mang—Manage stripe
• ppar—Parity/parity stripe
• spar—Safe parity stripe
• udat—User data stripe
• uinx—User index stripe
• wcmp—Read/write composite data stripe
• wdat—Read/write atomic data stripe
• winx—Read/write index stripe
The default setting is all stripes.

--timing Shows communications timing information. This is not the

default setting.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint stats command:
◆ Similar to the avmaint ping command.
◆ Beginning with version 5.0, XML output is no longer supported.

Examples
The following command lists contents of the client message store:
avmaint stats

avmaint 151
EMC CONFIDENTIAL
Command Reference

avmaint stripels
The avmaint stripels command returns file data for specified list of stripes.

Synopsis
avmaint stripels STRIPE-LIST [--full | --safe] GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint stripels command.

Table 109 Parameters for the avmaint stripels command

Parameter Description

STRIPE-LIST Specifies which stripes to operate on.

If not supplied (default behavior), XML output is generated for the current active
stripe and all checkpoints back to and including the first checkpoint where the
stored file is different to the active stripe, known here as the first safe checkpoint.
When a stripe is irremediably corrupted, this is useful in determining which
checkpoint can safely be used in a rollback to avoid use of the corrupted stripe.

Command options
Supply one and only one of the following command options on the command line for the
avmaint stripels command.

Table 110 Command options for the avmaint stripels command

Option Description

--full Lists all checkpoints.

--safe Lists only the first safe checkpoint, if any.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint stripels command:
◆ The XML output provides the stripe's node, disk and kind, and for each displayed
checkpoint, the filename, inode, file mode, link count, user ID, group ID, size in bytes,
file block count and the standard file access, modified and create times.
◆ You should include the --xmlperline=NUM global option to control the number of XML
attributes per line.

152 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint suspend
The avmaint suspend command temporarily halts client activities and denies new client
requests.

Synopsis
avmaint suspend [--force] [--now] GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint suspend command.

Table 111 Command options for the avmaint suspend command

Option Description

--force Forcefully and immediately stops all processes without sending any special
information to connected clients. This interrupts current users of the system.

--now If supplied, existing client sessions are gracefully terminated and no new client
sessions are allowed.
If not supplied, new client sessions are denied without suspending or terminating
existing client sessions.
Connected clients receive a SERVER_EXITING error immediately before the server
closes the connection socket.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

avmaint 153
EMC CONFIDENTIAL
Command Reference

avmaint test
The avmaint test command simulates internal server hardware faults for testing purposes.
The avmaint test command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint test commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint test {readerrors | writeerrors | ioerrors | networkerrors}
--disknum=NUM [--latency=USECS] --nodenum=NODE --percent=NUM
--avamaronly GLOBAL-OPTIONS

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint test command.

Table 112 Parameters for the avmaint test command

Parameter Description

readerrors Simulate disk read errors.

writeerrors Simulate disk write errors.

ioerrors Simulate disk read and write errors.

networkerrors Simulate network errors.

Command options
The following command options are available for the avmaint test command.

Table 113 Command options for the avmaint test command

Option Description

--disknum=DISK Sets the DISK number.

--latency=USECS Sets the simulated network latency in microseconds (USECS).

--nodenum=NODE Sets the NODE number.

--percent=NUM Sets the percentage of operations for which to simulate errors.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

154 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint testintegrity
The avmaint testintegrity command tests integrity of a stripe and its parity group. Status
for each of the stripes in the parity group is returned; returned status codes are good,
corrupt, or unknown.
The avmaint testintegrity command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint testintegrity commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint testintegrity STRIPE-ID [--repair] --avamaronly GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint testintegrity command.

Table 114 Parameters for the avmaint testintegrity command

Parameter Description

STRIPE-ID Specifies which STRIPE-ID to test.

Command options
The following command options are available for the avmaint testintegrity command.

Table 115 Command options for the avmaint testintegrity command

Option Description

--repair Asserts automatic rebuilding of a single corrupted stripe if other good stripes are
available.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
Consider the following notes for the avmaint testintegrity command:
◆ You must include the --avamaronly option.
◆ This command cannot be used while backups are in progress.

avmaint 155
EMC CONFIDENTIAL
Command Reference

avmaint timesync
The avmaint timesync command synchronizes server times with client.
The avmaint timesync command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint timesync commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint timesync [--count=NUM] [--repair] [--timeout=SEC] --avamaronly
GLOBAL-OPTIONS

Command options
The following command options are available for the avmaint timesync command.

Table 116 Command options for the avmaint timesync command

Option Description

--count=NUM Specifies the number of iterations. The default setting is 1000.

--repair Specifies that an attempt should be made to correct timing differences.

--timeout=SEC Specifies the number of seconds (SEC) before the operation is deemed to have
timed out and is terminated.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option. You also should include the --xmlperline=NUM
global option to control the number of XML attributes per line.

156 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmaint timing
The avmaint timing command times server operations.
The avmaint timing command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint timing commands. If you are unsure about any aspect of this command, contact
EMC Customer Support for additional information before using it.

Synopsis
avmaint timing {addhashdata | gethashdata | ispresent | ping |
refcheck} [--count=NUM] [--hashonly] [--maxsize=NUM]
[--minsize=NUM] [--seed=NUM] [--timeout=SEC] [--trace] --avamaronly
GLOBAL-OPTIONS

Parameters
Supply one and only one of the following parameters on each command line for the
avmaint timing command.

Table 117 Parameters for the avmaint timing command

Parameter Description

addhashdata Returns average elapsed time required to add a new hash to the hash file system.

gethashdata Returns average elapsed time required to read a hash from the hash file system.

ispresent Returns average elapsed time required to verify whether a hash exists in the hash
file system.

ping Returns average elapsed time required to establish communication with a node.

refcheck Returns average elapsed time required to verify integrity of the hash file system.

Command options
The following command options are available for the avmaint timing command.

Table 118 Command options for the avmaint timing command

Option Description

--count=NUM Specifies the number of iterations. The default setting is 1000.

--hashonly Specifies that data not be sent for timing messages.

--maxsize=NUM Specifies the maximum chunk size. The default setting is 8192.

--minsize=NUM Specifies the minimum chunk. The default setting is 1024.

--seed=NUM Specifies the random seed number (NUM) for timing.

--timeout=SEC Specifies the number of seconds (SEC) before the operation is deemed to have
timed out and is terminated.

--trace Specifies that hash tracing should be performed.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

avmaint 157
EMC CONFIDENTIAL
Command Reference

avmaint tracehash
The avmaint tracehash command traces the specified hash.
The avmaint tracehash command is considered an advanced command that is normally
intended for use by expert users only. You must include the --avamaronly option with all
avmaint tracehash commands. If you are unsure about any aspect of this command,
contact EMC Customer Support for additional information before using it.

Synopsis
avmaint tracehash HASH [--full] [--percent=NUM] [--remove]
--avamaronly GLOBAL-OPTIONS

Parameters
The following parameter is available for the avmaint tracehash command.

Table 119 Parameters for the avmaint tracehash command

Parameter Description

HASH 40-character hex HASH value.

Command options
The following command options are available for the avmaint tracehash command.

Table 120 Command options for the avmaint tracehash command

Option Description

--full Forces tracing of all hashes.

--percent=NUM Controls number (NUM) of hashes traced.

--remove Forces removal of the hash.

Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.

Notes
You must include the --avamaronly option.

158 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avmgr
The avmgr command is a command line interface to the Avamar account management
system.



The avmgr command is extremely powerful and can, if misused, completely and
irrevocably corrupt an entire Avamar server. For this reason, avmgr is strictly reserved for
use by EMC Customer Support only. Do not under any circumstances instruct non-EMC
personnel to use avmgr without prior approval from EMC Customer Support.

Synopsis
avmgr {addu | chgc | chge | chgl | chgp | chgr | chgv | cpdb | delb
| delu | getb | getc | getd | getl | getm | gets | getu | help | logn
| lstd | movb | newd | newm | priv | resf | resp | resr}

[--account={LOCATION | "ref{CID}"}] [--acnt={LOCATION

| "ref{CID}"}] [--ci=INFO] [--cmd=COMMAND] [--date=DATE]
[--expires=NUM] [--flagfile=FILE] [--format=FORMAT] [--help]
[--hfsaddr=AVAMARSERVER] [--hostname=NAME] [--id=USER@AUTH]
[--ignoreconfig] [--label=LABEL] [--le=END] [--list-backups]
[--loc="ref{CID}"] [--logfile=FILE] [--ls=START] [--mr=NUM]
[--mvpath=LOCATION] [--p=PASSWORD] [--password=PASSWORD]
[--path={LOCATION | "ref{CID}"}] [--pr=PASSWORD] [--pv=PRIVILEGE]
[--quiet] [--retention-type={daily | monthly | none | weekly
| yearly}] [--server=AVAMARSERVER] [--tryagain] [--u=NAME]
[--ud=AUTH] [--usage] [--verbose] [--verbosity=LEVEL] [--version]

Commands
Supply one and only one of the following commands on each command line for the avmgr
command.

Table 121 Commands for the avmgr command (page 1 of 3)

Command Description

addu Creates an Avamar user account and associates that user with a home location in the
Avamar server.
Use:
• --u=NAME to create the username.
• --p=PASSWORD (password) and --pr=PASSWORD (password retry) to set the
password.
• --pv=PRIVILEGE to set the privilege level.
• --path=LOCATION to specify the home location.
User accounts that are validated with an external authentication system must also
supply --ud=AUTH to specify the external authentication system.
--p=PASSWORD and --pr=PASSWORD are not supported when an external
authentication domain is used.

chgc Changes contact information.

Use --ci=INFO to supply new contact information.

chge Changes the backup expiration time.

Use --expires=NUM to supply a new expiration time in days (number of days until the
backup expires).

avmgr 159
EMC CONFIDENTIAL
Command Reference

Table 121 Commands for the avmgr command (page 2 of 3)

Command Description

chgl Changes the backup label.

Use --date=DATE to identify a backup and --label=LABEL to supply the new label.

chgp Changes the user password.

Use --u=NAME to specify the user to modify and --p=PASSWORD (password) and
--pr=PASSWORD (password retry) to specify the new password.
User accounts that are validated with an external authentication system must also
supply --ud=AUTH to specify the external authentication system.

chgr Changes the backup retention type.

Use --retention-type to designate the backup as a daily, weekly, monthly, or yearly. If
--retention-type is not supplied or type is set to none, then the backup is not explicitly
assigned an advanced retention type.
This command added in version 4.0.

chgv Changes the user privilege level.

Use --u=NAME to specify the user to modify and --pv=PRIVILEGE to set the new
privilege level.

cpdb Dumps the accounting database into a script file.

Use --list-snapups to list the backups (roothashes, timestamps, size, and percentnew)
for each account.

delb Deletes a backup.

Use --date=DATE to identify a backup.

delu Deletes a user.

Use --u=NAME to specify the user to delete.
This command only removes a user from a single location in the system. If the user
account was created with multiple (home) locations, then additional delu calls are
necessary.

getb Returns a list of all backups sorted by date, with the latest backup listed first.
Information includes label number, label name, number of bytes that were written
(created), total number of bytes that comprise the backup, number of bytes found to
be already present and not needing to be rewritten, and the expiration value (number
of days), where a zero indicates that the backup is to be kept indefinitely.
Use --ls, --le, and --mr to request a range or number of backups.
Use --retention-type to request one or more retention types (daily, weekly, monthly, or
yearly).

getc Returns contact information for the specified client.

Use --account=LOCATION to specify the client.

getd Returns a list of domains.

getl Returns a list of directories and clients.

Use --account=LOCATION to specify the domain. This does not perform a recursive
search through subdomains.

getm Returns a client list.

Similar to the getl command, but only returns clients.

gets Returns statistics. Information includes accumulative statistics for all clients in the
domain and monthly statistics, including the quantity of bytes backed up and the
quantity of bytes already stored on the server.
Use --account=LOCATION to specify the domain.

getu Returns a list of users at an account. This does not perform a recursive search through
the accounts.

160 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 121 Commands for the avmgr command (page 3 of 3)

Command Description

help Shows online help (commands, options and full descriptions), then exits. Same as
--help.

logn Tests authorization. If the user exists in the system, then the privilege level and type
of account are returned.

lstd Returns a list of available domains.

movb Moves a backup.

Use --mvpath=LOCATION to specify the new LOCATION for the backup.

newd Creates a domain. Use:

• --account=LOCATION to specify the name of the domain.
• --ci=INFO to supply contact information.
Use all of the following options to create a user account at the same time:
• --u=NAME to create the username.
• --p=PASSWORD (password) and --pr=PASSWORD (password retry) to set the
password.
• --pv=PRIVILEGE to set the privilege level.

newm Adds a client. Use:

• --account=LOCATION to specify the name and location. For example,
/clients/MyClient.
• --ci=INFO to supply contact information.
Use all of the following options to create a user account at the same time:
• --u=NAME to create the username.
• --p=PASSWORD (password) and --pr=PASSWORD (password retry) to set the
password.
• --pv=PRIVILEGE to set the privilege level.

priv Returns a list of available privilege settings.

resf Resolves the internal representation of the path. Translates the (fixed) internal
representation into the full text-based path name.

resp Resolves a path name to the block reference (blkref). Translates a text-based path
name into the (fixed) internal representation.
Hosts should save this internal representation in the avamar.cfg settings file with the
blkref parameter rather than the account option (text form) to facilitate renaming of
accounts. If the text version is saved and the host path changes, then automatic
backups fail.

resr Resolves internal representation of the path. Translates the (fixed) internal
representation into the text-based path name only to the parent level.

avmgr 161
EMC CONFIDENTIAL
Command Reference

Options
The following options are available for the avmgr command.

Table 122 Command options for the avmgr command (page 1 of 4)

Option Description

--account= Specifies a hierarchical LOCATION on the Avamar server. This

{LOCATION | "ref{CID}"} option is relative to the current home location, unless a slash (/) is
used as a prefix to the path designation, in which case an absolute
path is assumed.
When used with the resf command, a CID can be passed in to
obtain the location for that CID.
Same as --acnt or --path.

--acnt= Specifies a hierarchical LOCATION on the Avamar server. This

{LOCATION | "ref{CID}"} option is relative to the current home location, unless a slash (/) is
used as a prefix to the path designation, in which case an absolute
path is assumed.
When used with the resf command, a CID can be passed in to
obtain the location for that CID.
Same as --account or --path.

--blkref=REFERENCE This is used primarily in configuration files. This representation is

required to support renaming and moving of accounts.

--ci=INFO Contact information.

INFO can contain any text up to 1K in size. It is intended to hold
addresses, phone numbers and email addresses of people to
contact for billing or configuration changes.

--cmd=COMMAND Alternative mechanism for invoking the avmgr commands and

options.

--date=DATE Backup DATE.

DATE is a numerical value, processed according to the following
rules:
• If DATE is smaller than 1032, it is assumed to be a UNIX time
stamp
• Otherwise, it is assumed to be equal to the number of 100ns
increments since January 1, 1601.

--expires=NUM Used with chge command to specify number (NUM) of days from
the creation date or timestamp that a backup should be retained
in the system.
The timestamp for a backup is assigned when it finishes.
Any extension in retention time is added from the time of chge
command execution.
An expiration value of zero (0) means there is no end date for
removing the backup.

--flagfile=FILE Specifies a FILE containing a list of options and values that are
processed by this program as if they were included on the
command line. The default setting is
/usr/local/avamar/etc/usersettings.cfg.

162 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 122 Command options for the avmgr command (page 2 of 4)

Option Description

--format=FORMAT Output format. Valid values are:

• browser
• html
• plain
• xml
• xmldoc
The default format is plain. xmldoc includes an XML document
header in addition to the requested information.

--help Shows online help (commands, options and full descriptions),

then exits.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS).
This value is typically recorded in a configuration file. It can also be
set by way of an environment variable or on the command line with
each transaction. The default address is localhost (127.0.0.1).
Same as --server=AVAMARSERVER.

--hostname=NAME Specifies the client machine NAME.

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication
domain is “avamar.”
For example: jdoe@avamar.

--label=LABEL Backup LABEL. Optional short text description.

--le=END List end. Used with query commands (getb, getc, getd, getl, getm,
gets, and getu) and --ls option to bound a range of results.
END is context-sensitive. When used with getb, it accepts a date in
either of the following formats:
• YYYY-MM-DD HH-MM-SS
• YYYYMMDDHHMMSS
END can also be truncated to the desired resolution.
When used with other query commands, it accepts an alpha or
numeric value, which constitutes the end of the desired list.

--list-backups Used with cpdb command to return a list of backups (roothashes,

timestamps, size and percentnew) for each account.

--loc="ref{CID}" Used with newm command to specify a hierarchical location on

the Avamar server for a specific CID.

--logfile=FILE Log to this FILE. If no FILE value is supplied, default log file
(avmgr.log) is used.

--ls=START List start. Used with query commands (getb, getc, getd, getl, getm,
gets, and getu) and --le option to bound a range of results.
START is context-sensitive. When used with getb, it accepts a date
in either of the following formats:
• YYYY-MM-DD HH-MM-SS
• YYYYMMDDHHMMSS
START can also be truncated to the desired resolution.
When used with other query commands, it accepts an alpha or
numeric value, which constitutes the beginning of the desired list.

avmgr 163
EMC CONFIDENTIAL
Command Reference

Table 122 Command options for the avmgr command (page 3 of 4)

Option Description

--mr=NUM Max record count. Used with query commands (getb, getc, getd,
getl, getm, gets, and getu) to limit the size of the returned list.

--mvpath=LOCATION Used with movb command to specify the new LOCATION for the
backup. The new path name is always relative to the user's current
home location.

--p=PASSWORD Set PASSWORD.

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

--path= Specifies a hierarchical LOCATION on the Avamar server. This

{LOCATION | "ref{CID}"} option is relative to the current home location, unless a slash (/) is
used as a prefix to the path designation, in which case an absolute
path is assumed.
When used with the resf command, a CID can be passed in to
obtain the location for that CID.
Same as --account or --acnt.

--pr=PASSWORD Confirm PASSWORD. Always used with --p=PASSWORD.

--pv=PRIVILEGE User PRIVILEGE level. Valid values are:

• access—Allows additions, changes or deletions of users (for
example, avmgr).
• backup—Allows addition of backups (for example, avtar -c).
• create—Allows creation of accounts and clients.
• delete—Allows backups to be deleted.
• enabled—Controls whether the user is active or not.
• fullmanage—Allows all maintenance operations (for example,
avmaint shutdown, avmaint config, avmaint rebuildstripe).
• ignoreacls—Allows external users to view all data (ignore saved
access control lists).
• maint—Allows read maintenance data (for example, avmaint
nodelist, avmaint cpstatus).
• manage—Allows modify maintenance operations (for example,
avmaint hfscheck, avmaint decommission).
• move—Allows accounts to be moved or renamed.
• noticketrequired—Allows login without session ticket (that is,
not controlled by MCS).
• read—Allows retrieval of backups, accounts, statistics, contact
info lists (for example, avtar -x).
• readdir—Allows read of directory info only.
Named collections (must be specified alone):
• admin—Equivalent to create + read + backup + access + move +
delete + enabled + noticketrequired.
• backuponly—Equivalent to backup + enabled +
noticketrequired.
• readonly—Equivalent to read + enabled + noticketrequired.
• superuser—All privileges (no access restrictions).

--quiet Disables both warnings and status messages.

164 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 122 Command options for the avmgr command (page 4 of 4)

Option Description

--retention-type= Used with chgr to assign an advanced retention type, which allows
{daily | monthly | none this backup to be managed using advanced retention policies and
| weekly | yearly}
settings.
Valid values are one of the following types:
• daily—Explicitly designate this backup as a daily backup.
• monthly—Explicitly designate this backup as a monthly backup.
• none—Do not explicitly assign any retention type to this backup
(that is, treat it as a normal on-demand backup).
• weekly—Explicitly designate this backup as a weekly backup.
• yearly—Explicitly designate this backup as a yearly backup.
The default setting is none. If set to none or not supplied, backup
is not explicitly assigned an advanced retention type and any
existing retention type designation is cleared.
Used with getb to retrieve backups of a particular type.
This option added in version 4.0.

--server=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS).
This value is typically recorded in a configuration file. It can also be
set by way of an environment variable or on the command line with
each transaction. The default address is localhost (127.0.0.1).
Same as --hfsaddr=AVAMARSERVER.

--tryagain If server is idle, try completing this operation later. This is the
default setting.

--u=NAME Avamar user NAME. Used when creating a new user or modifying a
user's privilege level or password.

--ud=AUTH External authentication (AUTH) system. Always used with

--u=NAME.

--usage Shows abbreviated online help (commands and options only, no

descriptions), then exits.

--verbose Sets the verbosity level to verbose.

Equivalent to --verbosity=verbose.

--verbosity=LEVEL Sets the verbosity LEVEL. Valid values are:

• debug
• error
• fatal
• info
• verbose
• warn
The default setting is info.

--version Shows version, then exits.

Avamar-only commands
Avamar-only commands access advanced functionality that is normally reserved for use by
EMC personnel only. These commands require that you include the --avamaronly option to
emphasize this point.

avmgr 165
EMC CONFIDENTIAL
Command Reference

Misuse of these advanced commands can cause loss of data. If you are unsure about any
aspect of these commands, contact EMC Customer Support for additional information
before using them..

Table 123 Avamar-only advanced commands for the avmgr command

Command Description

addb Adds a backup.

blkd Disables a block.

blke Enables a block.

blkm Moves a block.

chgi Changes backup plug-in number.

chgk Changes backup locked status.

init Initializes the accounting system.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. You must include the --avamaronly option to use many of these
advanced command line options.
Misuse of these advanced options can cause loss of data. If you are unsure about any
aspect of these options, contact EMC Customer Support for additional information before
using them.

Table 124 Avamar-only advanced command options for the avmgr command (page 1 of 2)

Option Description

--acntver=NUM Sets the accounting system version.

--avamaronly Enables Avamar-only commands and options.

--bi=HASHCODE Sets backup information.

--bindir=PATH Sets the directory containing Avamar binary files. The default
setting is /root.

--cachedir=DIR Sets the local cache directory. The default setting is

/root/.avamardata. Same as --vardir=DIR.

--conntimeout=SEC Sets the socket connect timeout in seconds (SEC). The default
setting is 60 seconds.

--encrypt=METHOD Sets the encryption METHOD. Valid settings are:

• proprietary—No encryption.
• ssl:AES128-SHA—128-bit Advanced Encryption Standard.
• ssl:AES256-SHA—256-bit Advanced Encryption Standard.
• ssl—A special mode in which the program negotiates and uses
the strongest encryption setting that the session can support.
The default setting is proprietary.

--forceaddr Forces use of HFSADDR:HFSPORT.

--helpx Shows help including extended flags.

166 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 124 Avamar-only advanced command options for the avmgr command (page 2 of 2)

Option Description

--hfsport=PORT Sets the Avamar server port number (HFSPORT). The default setting
is 27000.

--ignoreconfig Does not read any configurations files while parsing flags. Same as
--noconfig.

--nagle Enables nagling.

--nat Sets whether the server is using NATing modules.

--noconfig Does not read any configuration files while parsing flags. Same as
--ignoreconfig.

--nouserinfo Suppresses getting UID and GID mapping.

--pizza Enables debugging messages. Same as --debug.

--singleconn Makes a single connection.

--su=STATE Sets the update state.

--sysdir=PATH Directory containing Avamar server files.

--syslog Sends log messages to the server. The default setting is TRUE.

--threadstacksize=SIZE Explicitly sets the default stack size. The default setting is zero (0),
which specifies that the operating system default stack size should
be used.

--vardir=DIR Sets the local cache directory. The default setting is

/root/.avamardata. Same as --cachedir=DIR.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 125 Deprecated command options for the avmgr command (page 1 of 2)

Option Description

--cid=CID Deprecated in version 6.0.

Sets the client ID. The default setting is 0. Same as --clientid=CID.

--clientid=CID Deprecated in version 6.0.

Sets the client ID. The default setting is 0. Same as --cid=CID.

--list-snapups Deprecated in version 4.1 in favor of --list-backups.

Used with cpdb command to return a list of backups (roothashes,
timestamps, size and percentnew) for each account.

--sessionid=NUM Deprecated in version 6.0.

Sets the session ID. Same as --sid=NUM.

--sid=NUM Deprecated in version 6.0.

Sets the session ID. Same as --sessionid=NUM.

avmgr 167
EMC CONFIDENTIAL
Command Reference

Table 125 Deprecated command options for the avmgr command (page 2 of 2)

Option Description

--wid=WID Deprecated in version 6.0.

Sets the work order ID. Same as --workorderid=WID.

--workorderid=WID Deprecated in version 6.0.

Sets the work order ID. Same as --wid=WID.

Notes
Consider the following notes for the avmgr command:
◆ Account names are case sensitive and can include only alphanumeric, underscore,
period, and hyphen characters. Account names cannot be longer than 63 characters.
◆ Usernames are case sensitive and can include only alphanumeric, underscore, period,
and hyphen characters. Usernames cannot be longer than 31 characters.
◆ Passwords are case sensitive and can include only alphanumeric, underscore, period,
and hyphen characters. Passwords must be at least six characters long but no longer
than 31 characters, and must contain at least one alpha and one numeric character.

Examples
Although the following example wraps to more than one line, you must enter all
commands and options on a single command line without any line feeds or returns.
The following command creates a new directory in the home location for a user:
avmgr newd --id=jdoe@avamar/clients/MyClient --password=ab4de6g
--server=avamar-1

The following command adds a client and a user for that client:
avmgr newm --id=jdoe@avamar/clients/MyClient
--account=clients/bobsclient --password=ab3de6g --u=bob --p=PSWD
--pr=PSWD --pv=backuponly

The following command adds a user:

avmgr addu --id=admin@site --account=clients/bobsclient
--password=ab3de6g --server=avamar-1 --u=bob --p=PSWD --pr=PSWD
--pv=readonly

The following command adds a user from an external authentication domain:

avmgr addu --id=admin@site --account=clients/bobsclient
--password=ab4de6g --server=avamar-1 --u=bob --ud=ldap
--pv=readonly

The following command changes a password:

avmgr chgp --id=admin@site --account=clients/bobsclient
--password=ab4de6g --server=avamar-1 --u=bob --p=NEWPSWD
--pr=NEWPSWD

The following command returns a list of users:

avmgr getu --id=admin@site --server=avamar-1 --password=ab4de6g
--account=clients/bobsclient

168 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

The following command returns a list of directories:

avmgr getl --id=admin@site --server=avamar-1 --password=ab4de6g
--account=clients/bobsclient

The following command deletes a backup created on a specific date (--date) and Avamar
server (--server):
avmgr delb --id=admin@avamar/site/node16 --password=ab4de6g
--server=avamar-1 --date=1019168580

The following command returns a list of backups for a client:

avmgr getb --id=admin@site --password=ab4de6g --server=avamar-1
--account=clients/bobsclient

The following command returns the CID for /clients/host1 in XML format:
avmgr resp --path=/clients/host1 --format=xml
1 Request succeeded
<account id="431de870.e4ac3f066775bd33898c2ac79bb78f6333488393"
name="/clients/host1" />

avmgr 169
EMC CONFIDENTIAL
Command Reference

avregister
The avregister command is used to register and activate a UNIX-variant (that is, IBM AIX,
HP-UX, Linux, SCO, or Sun Solaris) client with an Avamar server.
When invoked, it interactively prompts the user for the following information:
◆ Base directory of the Avamar client installation
◆ MCS server DNS name
◆ Avamar server domain where this client should reside

avregister.bat
The avregister.bat command is used to register and activate a GUI-less Windows client (for
example, Windows Server 2008 Core installation) with an Avamar server.

Synopsis
avregister.bat MCS-NAME [DOMAIN]

Parameters
The following parameters are available for the avregister.bat command.

Table 126 Parameters for the avregister.bat command

Parameter Description

MCS-NAME Specifies the actual network hostname (as defined in DNS) of the Avamar MCS to
which to register and activate this client.

DOMAIN Specifies an optional location for this client on the Avamar server.
If DOMAIN is not supplied, the default domain “clients” is used.
If specifying a subdomain (for example, (for example, clients/MyClients), do not
include a slash (/) as the first character. Including a slash as the first character
causes an error and prevents you from registering this client.

Notes
This command added in version 4.1.105.

170 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avscc
The avscc command responds to plug-in browsing, backup and restore requests passed to
it from the local avagent service, and performs the actual work associated with these
requests.
On Windows client platforms, it is located in Avamar Client for Windows C:\Program
Files\avs\bin folder, runs as a service, and is typically invoked by users from the Windows
system tray.
On other client platforms, it is located in the /usr/local/avamar/bin directory and can be
run from the command line.

Synopsis
avscc [--acaddr=IP-ADDR] [--acport=PORT] [--allowqueueworkorders]
[--command={backupnow | forceupdate | init | logfilelist | restore |
snapup | status | stop | uninit | wo_restore | wo_snapup}] [--debug]
[--dpnacl=USER@DOMAIN] [--dpnpath=PATH] [--encodings=NAME]
[--flagfile=FILE] [--hfsaddr=IP-ADDR] [--informationals]
[--interfacelanguage=NAME] [--logfile=FILE] [--log=FILE]
[--mcsaddr=IP-ADDR] [--noinformationals] [--nostdout]
[--nowarnings] [--quiet] [--server=IP-ADDR] [--snapset=NAME]
[--snapupremindhours=NUM] [--usage] [--verbose | -v] [--version]
[--wid=NAME]

Options
The following options are available for the avscc command.

Table 127 Command options for the avscc command (page 1 of 2)

Option Description

--acaddr=IP-ADDR Specifies the IP address (IP-ADDR) that Windows client agent

uses to directly communicate with the local avagent service.
The default setting is 127.0.0.1 (localhost).

--acport=PORT Specifies the data PORT that the Windows client agent uses to
directly communicate with the local avagent service.

--allowqueueworkorders Submits new workorders even when other workorders are

currently running.

--command={backupnow | Client agent command. One of the following:

forceupdate | init |
logfilelist | restore | • backupnow—Performs an on-demand backup (Linux
snapup | status | stop | platforms only)
uninit | wo_restore | • forceupdate
wo_snapup}
• init—Activates this client with the specified Avamar server.
• logfilelist—Shows log file information.
• restore—Performs a restore.
• snapup—Performs a backup.
• status—Shows status for all work orders related to this
client.
• stop—Stops the current operation.
• uninit—Removes activation with the specified Avamar
server.
• wo_restore
• wo_snapup

--debug Does not perform the actions.

avscc 171
EMC CONFIDENTIAL
Command Reference

Table 127 Command options for the avscc command (page 2 of 2)

Option Description

--dpnacl=USER@DOMAIN ACLs for the machine in the DPN accounting system.

USER is the Avamar username, and DOMAIN is the domain
name.

--dpnpath=PATH Specifies the directory (PATH) that identifies the machine.

--encodings=NAME Specifies character encodings.

--flagfile=FILE Specifies a FILE containing a list of options and values that are
processed by avagent as if they were included on the
command line. The default setting is
/usr/local/avamar/etc/usersettings.cfg.

--hfsaddr=IP-ADDR Avamar IP address (IP-ADDR) or fully qualified host (as defined

in DNS).
Same as --server=IP-ADDR.

--informationals Enables all status messages.

--interfacelanguage=NAME On Windows clients, NAME specifies the requested user

interface language for the GUI.

--log Logs to the FILE specified by --logfile=FILE. This is the default

setting.

--logfile=FILE Used with the --log option to specify the full path and filename
of the alternative log file.

--mcsaddr=IP-ADDR Specifies the administrative server IP address (IP-ADDR).

--noinformationals Disables all status messages.

--nostdout Disables output to STDOUT.

--nowarnings Disables warning messages.

--quiet Disables both warnings and status messages. Equivalent to

--noinformationals plus --warnings.

--server=IP-ADDR Avamar IP address (IP-ADDR) or fully qualified host (as defined

in DNS).

--snapset=NAME Specifies a filename for the snapset.

--snapupremindhours=NUM Specifies the number (NUM) of hours before a backup

reminder message is displayed.
The default setting is 24 hours.

--usage Shows abbreviated online help (commands and options only,

no descriptions), then exits.

--verbose | -v Supplying either --verbose or -v enables all messages (status

and warnings).

--version Shows version, then exits.

--wid=NAME Sets the work order ID.

172 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avsetup_avamarbin
The avsetup_avamarbin command creates the Avamar File System (AvFS) avamarbin
directories, which contain the platform-specific versions of the avacl program.

avsetup_avi.pl
The avsetup_avi.pl Perl script is used to set up the AvInstaller Tomcat instance.
This script should only be run by the avinstaller bootstrap.

Synopsis
avsetup_avi.pl

avsetup_connectemc.pl
The avsetup_connectemc.pl Perl script is used to install and configure the ConnectEMC
software on an Avamar server.

Synopsis
avsetup_connectemc.pl [--site_name=AVAMARSERVER] [--testconfigured]

Options
The following options are available for the avsetup_connectemc.pl Perl script.

Table 128 Command options for the avsetup_connectemc.pl Perl script

Option Description

--site_name=AVAMARSERVER User-defined name for the AVAMARSERVER.

--testconfigured If supplied, configuration is tested. The script exits with 0 if

ConnectEMC is properly configured, and 1 otherwise.

Notes
Consider the following notes for the avsetup_connectemc.pl Perl script:
◆ This Perl script added in version 5.0.
◆ The avsetup_connectemc.pl Perl script modifies the ConnectEMC.ini configuration file
and mcserver.xml.

avsetup_avamarbin 173
EMC CONFIDENTIAL
Command Reference

avsetup_ems
The avsetup_ems command configures an EMS. When run, it installs the Tomcat java
application server in /usr/local/avamar-tomcat and installs the Avamar Enterprise
Manager web application in Tomcat.
The avsetup_ems command is not intended to be run directly from the command line. The
information provided in this topic is for reference purposes only.

Synopsis
avsetup_ems [--updatejavahome]

Options
The following option is available for the avsetup_ems command.

Table 129 Command options for the avsetup_ems command

Option Description

--updatejavahome Updates JAVA_HOME environment variable to the version used by the EMS.

Notes
You must set the JAVA_HOME environment variable to /usr/java/jre1.5.0_12.

174 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avsetup_mccli
The avsetup_mccli command configures the Avamar Administrator CLI.
The EMC Avamar Management Console Command Line Interface (MCCLI) Programmer
Guide provides additional information.

Synopsis
avsetup_mccli [--app_root PATH] [--help] [--java_home PATH]
[--mcsaddr AVAMARSERVER] [--mcspasswd PASSWORD] [--mcsport PORT]
[--mcsuserid USER-ID] [--use_defaults] [--user_root PATH]

Options
The following options are available for the avsetup_mccli command.

Table 130 Command options for the avsetup_mccli command

Option Description

--app_root PATH Sets the application top level directory (that is $AVAMAR_ROOT).
The default setting is /usr/local/avamar.

--help Shows help, then exits.

--java_home PATH Sets the Java runtime directory. The default setting is
/usr/java/jre1.5.0_12.

--mcsaddr AVAMARSERVER Specifies which MCS to use to process Avamar Administrator CLI
commands.
This option added in version 4.0.

--mcspasswd PASSWORD Specifies the PASSWORD for the --mcsuserid account.

This option added in version 4.0.

--mcsport PORT Specifies the MCS data PORT.

This option added in version 4.0.

--mcsuserid USER-ID Specifies the Avamar administrative user account (USER-ID) that is
used to run Avamar Administrator CLI commands.
This option added in version 4.0.

--use_defaults If supplied, avsetup_mccli runs non-interactively and uses defaults

for all settings.

--user_root PATH Sets the user root directory. The default setting is
$HOME/.avamardata/var.

Files
The avsetup_mccli command updates the $AVAMAR_ROOT/lib/mcclimcs.xml default
options file.

avsetup_mccli 175
EMC CONFIDENTIAL
Command Reference

avsetup_mcs
The avsetup_mcs command configures an MCS.
It is typically run immediately after MCS software installation and before initializing the
MCS by way of mcserver.sh --init. It has no effect if it is run after the MCS is started by way
of mcserver.sh --start.
The avsetup_mcs program performs the following actions:
1. Updates the JRE version and installation directory used by all MCS scripts.
2. Defines the Avamar server that all clients managed by this MCS use for backups and
restores.
3. Directs all internal MCS-to-Avamar server communications to a specified Avamar
server hostname.
4. Creates all necessary MCS user accounts on the Avamar server and sets the MCUser
account password.
If avsetup_mcs is invoked more than once, it only performs the first three actions.
By default, avsetup_mcs runs interactively, prompting the user for any required values not
already supplied on the command line. If all the parameters it requires are supplied on the
command line or if the --noprompt option is supplied, it runs silently.

Synopsis
avsetup_mcs [--backuponlypass=PASSWORD] [--backuprestorepass=PASSWORD]
[--error] [--help] [--hfsaddr=AVAMARSERVER] [--hfsport=PORT]
[--java=DIR] [--lib] [--localdns=DNS] [--mcpass=PASSWORD]
[--natextaddr=IP-ADDR] [--nocreateaccounts] [--nonat] [--noprompt]
[--prefs] [--restoreonlypass=PASSWORD] [--rootpass=PASSWORD]
[--run] [--runasanyuser] [--smtphost=SMTP-SERVER]

Options
The following options are available for the avsetup_mcs command.

Table 131 Command options for the avsetup_mcs command (page 1 of 3)

Option Description

--backuponlypass=PASSWORD Specifies the password for the backuponly user account.

--backuprestorepass=PASSWORD Specifies the password for the backuprestore user account.

--error Shows error messages if execution fails.

--help Shows help, then exits.

176 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 131 Command options for the avsetup_mcs command (page 2 of 3)

Option Description

--hfsaddr=AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified

hostname (as defined in DNS).
This is the Avamar server that all clients are directed to for
backups and restores.
If a hostname is used, this name must be resolvable by all
clients using the system. For this reason, it is usually a name
resolvable by the corporate DNS or other name servers
external to the Avamar server.

Note: The MCS attempts to resolve AVAMARSERVER

hostname by way of external DNS and pings that host to
verify communication with the rest of the system. However,
it must be understood that this is no guarantee that the
clients can also do so.

--hfsport=PORT Specifies the data port used for intra-server communication.

The default setting is 27000.

--java=DIR Specifies the JRE installation directory (DIR) used by MCS.

--lib EMC internal use only.

If supplied, settings are written to the default (lib) version of
the mcserver.xml preferences file that resides in
/usr/local/avamar/lib/mcserver.xml.
This is not the default setting.

--localdns=AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified

hostname (as defined in DNS).
If a hostname is used, this name must be resolvable by the
MCS. In order for the MCS to monitor the Avamar server in
the presence of network failure or loss of external name
servers, the Avamar server internal IP address/fully
qualified hostname should be used. The AVAMARSERVER IP
address or fully qualified hostname has a .local.avamar.com
domain suffix, which is resolvable entirely by the name
server on the Avamar utility node. You can also set this
parameter to contain the same value as --hfsaddr to make
use of external name servers. The Avamar server internal
fully qualified hostname is set as the default setting.

--mcpass=PASSWORD Specifies the MCUser user account PASSWORD.

--natextaddr=IP-ADDR If Avamar server is deployed in a Network Address

Translation (NAT) environment, this is the actual
(non-translated) utility node or single node server IP
address.
If supplied, all NAT related user prompts are suppressed
during the avsetup_mcs session.

--nocreateaccounts If supplied, creation of the MCS user accounts on the

Avamar server is bypassed.

--nonat If supplied, avsetup_mcs does not prompt for the NAT

external address and inserts a null value into the
mcserver.xml external_nonat_addr preference.

--noprompt If supplied, avsetup_mcs runs silently.

avsetup_mcs 177
EMC CONFIDENTIAL
Command Reference

Table 131 Command options for the avsetup_mcs command (page 3 of 3)

Option Description

--prefs EMC internal use only.

If supplied, settings are written to the active (server_data)
version of the mcserver.xml preferences file that resides in
/usr/local/avamar/var/mc/server_data/prefs/
mcserver.xml.
This is the default setting. Supply --noprefs to turn this off.

--restoreonlypass=PASSWORD Specifies the password for the restoreonly user account.

--rootpass=PASSWORD Specifies the Avamar server root PASSWORD. MCS uses this
password to log in to the Avamar server to create all the
necessary accounts it needs and for requesting monitoring
data.

--run EMC internal use only.

--runasanyuser If supplied, this program can be run by any user.

--smtphost=SMTP-SERVER Specifies the IP address or hostname (as defined in DNS) of

the outgoing Simple Mail Transfer Protocol (SMTP) mail
server (SMTP-SERVER) that is used to send email home
status messages.

Examples
The following example sets the NAT address directly from the command line and runs
silently, but does not affect any other settings:
avsetup_mcs --extnataddr=x.x.x.x --noprompt

178 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avsetup_mds
The avsetup_mds command enables the Avamar metadata search feature. It performs two
actions:
1. First, it creates a symbolic link from the Avamar File System (AvFS) mount point
/mnt/axion to /var/www/html/axion. This symbolic link allows the Avamar File
System (AvFS) to be accessed by way of Avamar Enterprise Manager so files returned
by the search can be displayed as a hyperlinked list.
2. Secondly, the default schedule for the starting metadata_cron is inserted into the MCS
database.

Synopsis
avsetup_mds [--accessnodehost=NAME] [--mdspass=PASSWORD]
[--mdsdbport=PORT] [--testconfigured] [--testmdsrunning]
[--updateaccessnode]

Options
The following options are available for the avsetup_mds command.

Table 132 Command options for the avsetup_mds command

Option Description

--accessnodehost=NAME Specifies the access node hostname.

--mdsdbport=PORT Specifies the metadata search database TCP port.

--mdspass=PASSWORD Sets the new mdsuser account PASSWORD.

This option added in version 4.0.

--testconfigured Tests whether the Avamar metadata search feature has been
configured.
If it has been configured, avsetup_mds exits with return code 0.
If it has not been configured, avsetup_mds exits with a non-zero
return code.

--testmdsrunning Tests whether the Avamar metadata search feature is running.

If it is running, avsetup_mds exits with return code 0.
If it is not running, avsetup_mds exits with a non-zero return code.

--updateaccessnode Updates access node hostname and port configuration.

Notes
The --testconfigured and --testrunning options are intended to be used by other scripts
that can process the return codes to determine the status of metadata search.

avsetup_mds 179
EMC CONFIDENTIAL
Command Reference

avsetup_snmp
The avsetup_snmp command configures a Net-SNMP agent so that it can communicate
with an Avamar server by way of the Avamar Simple Network Management Protocol
(SNMP) sub-agent.
When avsetup_snmp is run, it examines an existing /etc/snmp/snmpd.conf file (if
present) for configuration settings required by the Avamar sub-agent.
If no v1/v2c SNMP communities are configured, then snmpconf --access_control is run to
set up the required read/write and read-only SNMP communities.
If system configuration settings are not present in /etc/snmp/snmpd.conf, then snmpconf
--system_setup is run.
Finally, snmpd is enabled.

Synopsis
avsetup_snmp [--access_control] [--config_dir=DIR] [--mibdir=DIR]
[{--on | --off}] [--port=PORT] [--system_setup] [--verbose]

Options
The following options are available for the avsetup_snmp command.

Table 133 Command options for the avsetup_snmp command

Option Description

--access_control Forces running of snmpconf --access_control command during program

session.

--config_dir=DIR Specifies an alternate location for the snmpd.conf file.

--mibdir=DIR Specifies an alternate location for the Avamar MIB file.

--on | --off Supplying --on enables snmpd. This is the default setting.
Supplying --off disables snmpd.

--port=PORT Specifies an alternate data PORT for SNMP communication. The default port
is 161.

--system_setup Forces running of snmpconf --system_setup command during program

session.

--verbose Provides maximum information.

Notes
Consider the following notes for the avsetup_snmp command:
◆ Do not run avsetup_snmp from /etc/snmp. Doing so causes any existing
/etc/snmp/snmpd.conf file to be deleted.
◆ Configuration settings for snmpd are stored in /etc/snmp/snmpd.conf. avsetup_snmp
generates a basic snmpd.conf file. Another script (snmpconf) is provided with
net-snmp. The snmpconf script should only be run if you have solid knowledge of
net-snmp and want to use Net-SNMP to monitor other SNMP-enabled clients besides
the Avamar server. Documentation for snmpconf is available by way of man pages
provided with the net-snmp package or from www.net-snmp.org.

180 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avsetup_webstart
The avsetup_webstart command configures Avamar Administrator from Avamar Enterprise
Manager.

avsetup_wrapper
The avsetup_wrapper command performs selected subsystem initializations and updates.
As of Avamar 6.0, the avsetup_wrapper is located in /usr/local/avamar/lib/dpnutils.

Synopsis
avsetup_wrapper [--debug] [--help] [--verbose]
{connectemc-init-upgrade | ems-init | ems-setup | help | lm-start |
mccli | snmp-update | tomcat-update | website-update | webstart}

Options
The following options are available for the avsetup_wrapper command.

Table 134 Command options for the avsetup_wrapper command

Option Description

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits. Same as supplying the help command.

--verbose Provides maximum information.

Commands
Supply one and only one of the following commands on each command line for the
avsetup_wrapper command.

Table 135 Commands for the avsetup_wrapper command

Command Description

connectemc-init-upgrade Initializes ConnectEMC.

ems-init Performs second part of EMS subsystem initialization.

ems-setup Performs first part of EMS subsystem initialization.

help Shows help, then exits. Same as supplying the --help option.

lm-start Stops, then restarts Login Manager processes (lm).

mccli Initializes or updates mccli.

snmp-update Updates MCS SNMP configuration.

tomcat-update Updates EMS Tomcat component.

website-update Updates web server configuration.

webstart Initializes or updates Avamar Administrator web interface.

avsetup_webstart 181
EMC CONFIDENTIAL
Command Reference

Environment variables
The avsetup_wrapper command uses the following environment variables.

Table 136 Environment variables used by the avsetup_wrapper command

Environment variable Description

$PATH Executable locations

avsysconfig
The avsysconfig command configures or enables/disables various hardware components
on a node, including controllers and attached components such as array disks and virtual
disks. Each avsysconfig command described in this section must be run as a separate
command and must be run as root.

Synopsis
avsysconfig clear-alert-log
avsysconfig export-log
avsysconfig service [items=ITEM] [action=ACTION]

Options
The following options are available for the avsysconfig command.

Table 137 Command options for the avsysconfig command

Option Description

clear-alert-log Clears the Baseboard Management Controller (BMC) event log. Equivalent to
running ipmitool sel clear. Running this command removes all history of
system-level events on the host. This option should only be executed if the
BMC event log is full, which should rarely occur. Otherwise,
hardware-related event history is also lost.

Note: To export the BMC event log, run this command:

ipmitool sel list > /tmp/sel.log.

export-log Exports the storage controller event log. It is intended for diagnosing storage
subsystem issues. For the Dell platform, it creates the file
/var/log/lsi_MMDD.log, where MMDD represents the current 2-digit month
and 2-digit day. For the Intel platform, it creates the file /tmp/a0-events.log.

service Identifies which Dell OM services on the Dell platform you want to configure.
items=ITEM Allowable ITEM: webserver
action=ACTION
Allowable ACTION: stop, start, restart
If items=webserveris specified, the specified ACTION is applied to the DSM
SA Connection Service on the Dell platform. This is equivalent to running:
omconfig system webserver action={stop,start,restart}
If no ITEM is specified, the specified ACTION is applied to all of the Dell OM
services on the Dell platform.
Actions stop, start, or restart underlying system services needed for
avsysreport. This command option is currently implemented only on the
Dell platform.

182 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

avsysreport
The avsysreport command displays the status of various hardware components on a node,
including controllers and attached components such as array disks and virtual disks.

Synopsis
avsysreport [options] entity [ entity | attribute=value ]

Options
The following options are available for the avsysreport command.

Table 138 Command options for the avsysreport command

Option Description

--verbose, -v Turns verbose mode on.

--help, -h, -? Prints out a help message with the items in this table.

--debug Starts the interactive debugger.

--info, -i Prints internal information.

--validate Checks platform tools availability.

--yaml Outputs in YAML format, a modular CSS human-readable data format.

Entities
This utility recognizes the following entities for the avsysreport command.

Table 139 Command entities for the avsysreport command (page 1 of 2)

Entity Description

controller | Reports properties and status of available storage controllers. When

controllers
optional attribute controller is not specified, information on all
controllers is presented.
Optional attribute: controller=controller-id
This attribute restricts output for the specified controller-id. The
format of the controller-id is a single number specifying the
Controller ID.

avsysreport 183
EMC CONFIDENTIAL
Command Reference

Table 139 Command entities for the avsysreport command (page 2 of 2)

Entity Description

physical-disk | Reports properties and status of physical disks seen from the
physical-disks | storage controller.
pdisk | pdisks
Required attribute: controller=controller-id
Specifies the storage controller to which the virtual disks are
configured. The format of the controller-id is a single number
specifying the Controller ID.
Optional attribute: pdisk=pdisk-id
Restricts output for the specified pdisk-id. The format of the pdisk-id
is platform-specific:
• For the Dell platform, it is three numbers, each separated by a
colon (:), as in 0:0:1, which would map to the pdisk identified
with attribute ID: 0:0:1. Dell defines these values as
connectorID:enclosureID:portID.
• For the Intel platform, it is two numbers, each separated by a
colon (:), as in 8:3, which would map to the pdisk identified with
attribute Enclosure Device ID 8 and attribute Slot Number 3.

virtual-disk | Reports properties and status of virtual disks seen from the storage
virtual-disks | vdisk controller.
| vdisks
Required attribute: controller=controller-id
Specifies the storage controller to which the virtual disks are
configured. The format of the controller-id is a single number
specifying the Controller ID.
Optional attribute: vdisk=vdisk-id
Restricts output for the specified vdisk-id. The format of the vdisk-id
is a single number specifying the Virtual Disk ID.

To obtain detailed information on particular entities, use the following syntax:

avsysreport entity [ entity ] ... --help
avsysreport entity [ entity ] ... -h
avsysreport entity> [ entity ] ... -?
avsysreport --help entity [ entity ] ...
avsysreport -h entity [ entity ] ...
avsysreport -? entity [ entity ] ...

Attributes
The following attributes are available for the avsysreport command.



The attributes in each table that follows are cumulative lists for both Dell and Intel
platforms. Since some of them are unique to only one of the underlying platform reporting
tools, a return value might be Undefined or […Needs details…] if it is not retrievable.

Table 140 Controller command attributes for the avsysreport command (page 1 of 2)

Attribute Description

Controller ID Disk controller ID, as seen on the system. 0 is the first disk
controller, 1 is the second, and so forth.

Status Operational status of the controller. One of OK, Degraded,

Failed, Unknown.

Name Product name of the controller.

184 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 140 Controller command attributes for the avsysreport command (page 2 of 2)

Attribute Description

Firmware Version Version string of the current firmware on the controller.

Rebuild Rate The percentage of CPU resources devoted to rebuilding data onto
a new drive after a failure.

Background The percentage of CPU resources devoted to initializing a virtual

Initialization Rate drive ( for instance, mirroring disks for RAID 1 or writing parity for
RAID 5).

Check Consistency Rate The percentage of CPU resources at which consistency check
operations are run (for instance, rebuilding the redundant data).

Reconstruct Rate The percentage of CPU resources at which a drive group

modification operation is carried out.

Cache Memory Size The amount of fast memory on the controller that holds recently
accessed data.

Patrol Read Mode Indicates the current Patrol Read mode. One of Auto, Manual,
Disabled.

Patrol Read State The current state of any Patrol Read task.

Patrol Read Rate The percentage of CPU resources at which Patrol Read operations
are run.

Patrol Read Iterations The number of Patrol Read iterations that have run since reboot.

PCI Device ID The PCI bus ID of the controller consisting of the 4-tuple <Vendor
ID:DeviceID:SubVendorID:SubDeviceID> as seen by the system.

Alarm If enabled, an audible alarm is sounded for critical and warning

events. One of Enabled, Disabled, Not Applicable.

Auto Rebuild If enabled, virtual drives will automatically attempt to rebuild

after a failure. One of Enabled, Disabled.

Battery Backup Present Indicates if there is a battery backup solution for the controller in
case of power failure. One of Yes, No.

Battery Warning If enabled, a low battery warning event is generated at the

appropriate time. One of Enabled, Disabled, Not Applicable.

Table 141 Physical disk command attributes for the avsysreport command (page 1 of 2)

Attribute Description

Physical Disk ID Physical disk ID, as seen on the system. 0 is the first physical
disk, 1 is the second, and so forth.

Enclosure Device ID The enclosure ID that hosts the physical drive, as seen by the
system.

Slot Number The slot number of the physical disk within the chassis.

Device ID The device id within the enclosure of the physical disk.

SAS Address The worldwide name of the physical drive, as seen on the SAS
bus.

Failure Predicted Yes or No value, dependent on a zero or nonzero value for the
number of S.M.A.R.T. errors.

avsysreport 185
EMC CONFIDENTIAL
Command Reference

Table 141 Physical disk command attributes for the avsysreport command (page 2 of 2)

Attribute Description

Media Error Count The number of S.M.A.R.T. errors on the drive related to the drive
media.

Other Error Count The number of S.M.A.R.T. errors on the drive not related to the
drive.

Predictive Failure Count The total number of S.M.A.R.T. errors on the drive.

Disk Type One of the following: SATA or SAS.

Raw Size The raw capacity of the drive in GB or TB.

Formatted Size The formatted capacity of the drive in GB or TB.

Status One of the following:

• Online—A drive that can be accessed by the RAID controller
and is part of the virtual drive.
• Unconfigured Good—A drive that is functioning normally but
is not currently configured as part of a virtual drive or hot
spare.
• Hot Spare—A drive that is powered up and ready to use as a
hot spare in case an online drive fails.
• Failed—A drive that was originally configured as Online or Hot
Spare, but the firmware has detected an unrecoverable error.
• Rebuilding—A drive to which data is being written to restore
full redundancy for a virtual drive.
• Unconfigured Bad—A drive on which the firmware detects an
unrecoverable eror; the drive was either Unconfigured Good
or the drive could not be initialized.
• Missing—A drive that was Online but has been removed from
its location.
• Offline—A drive that is part of a virtual drive but has invalid
data from the RAID configuration.
• Unknown—The drive status cannot be determined.

Rebuild Progress If a RAID set is rebuilding, the Status value should be Rebuilding,
and this value is a percentage complete (0-100). Otherwise, this
value is None.

Product ID The product model identification of the disk drive.

Serial Number The unique serial number of the disk drive.

Firmware Revision The drive firmware version currently on the disk drive.

Device Speed The drive-capable communication speed on the storage bus.

Link Speed The actual drive communication speed on the storage bus.

Media Type One of the following: Hard Disk Device, SSD, and so forth.

Write Caching Indicates if the write cache on the physical drive is being used.
One of the following: Enabled, Disabled.

Native Command Queueing Indicates if the native command queuing (an extension to the
SATA protocol) feature of the physical drive is enabled or not.
One of the following: Enabled, Disabled.

Vendor One of the following: Dell, Intel.

186 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 142 Virtual disk command attributes for the avsysreport command

Attribute Description

Virtual Disk ID Virtual disk ID, as seen on the system. 0 is the first virtual disk, 1 is the
second, and so forth.

Status The operational status of the virtual disk. One of the following:
• OK—The virtual drive is operating fine, all physical disks online.
• Degraded—One or more of the configured physical drives has failed or
is offline.
• Degraded-Rebuilding—One or more of the configured physical drives
has failed and is currently being rebuilt.
• Failed—The virtual drive has failed.
• Offline—The virtual drive is not available to the controller.
• Unknown—Cannot be determined.

Layout RAID configuration, one of the following: RAID-0, RAID-1, RAID-5, RAID-6,
RAID-10, and so forth.

Size The storage capacity of the virtual disk, either in GB or TB.

Device Name The operating system device name of this virtual disk.

Bus Protocol The storage bus interface, typically either SATA or SAS.

Media The type of storage media, one of Hard Disk Device, SSD, and so forth.

Access Policy One of the following: Read/Write, Read Only, Blocked.

Read Policy One of the following:

• Read Ahead—Enables the controller to read sequentially ahead of the
requested data and cache it.
• No Read Ahead—Disables the read ahead capability.

Write Policy One of the following:

• Write Back—The controller sends a write completion to the host when
the controller cache has received the write data.
• Write Through—The controller sends a write completion to the host
when the disk subsystem has received the write data.

IO Policy One of the following:

• Direct—Reads are not buffered in cache memory. Data is transferred
to the cache and host concurrently. If the same block is read again, it
comes from the cache.
• Cached—All reads are buffered in cache memory.

Stripe Size The length of the interleaved data segments that the controller writes
across the multiple drives within the RAID set, not including the parity
drives.

Dish Cache Policy One of the following:

• Enabled—The virtual drive cache is used.
• Disabled—The virtual drive cache is not used.

Number of Drives The number of physical disks within this virtual disk.

avsysreport 187
EMC CONFIDENTIAL
Command Reference

Example output
The following are examples of avsysreport command output.
Controller Dell
#: avsysreport controller
=== Disk controller hardware
Reconstruct Rate : 30%
Name : PERC H700 Integrated
Cache Memory Size : 512 MB
Patrol Read Rate : 30%
Patrol Read Iterations : 110
Auto Rebuild : <Undefined>
Patrol Read Mode : Disabled
Rebuild Rate : 30%
Background Initialization Rate : 30%
Alarm : Not Applicable
Firmware Version : 12.10.0-0025
PCI Device ID : <Undefined>
Patrol Read State : Stopped
Battery Backup Present : <Undefined>
Status : Ok
Battery Warning : <Undefined>
Check Consistency Rate : 30%
Controller ID : 0

Controller Intel
#: avsysreport controller
=== Disk controller hardware
Reconstruct Rate : 30%
Name : Intel(R) Integrated RAID Module
RMS25CB080
Cache Memory Size : 1024MB
Patrol Read Rate : 0%
Patrol Read Iterations : 10
Auto Rebuild : Enabled
Patrol Read Mode : Disabled
Rebuild Rate : Yes
Background Initialization Rate : Yes
Alarm : Enabled
Firmware Version : 23.7.0-0033
PCI Device ID : 005b
Patrol Read State : Stopped
Battery Backup Present : Yes
Status : OK
Battery Warning : Enabled
Check Consistency Rate : 30%
Controller ID : 0

Physical Disk Dell

188 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

#: avsysreport pdisk controller=0

=== Physical disks
Write Caching : [...Needs details...]
Media Error Count : <Undefined>
Firmware Revision : 03.00C09
Serial Number : WD-WMATV585736557365
Device Speed : 3.00 Gbps
Media Type : HDD
Slot Number : <Undefined>
Product ID : WDC WD1002FBYS-18W8B0
Other Error Count : <Undefined>
Formatted Size : 931.00 GB (999653638144 bytes)
Raw Size : <Undefined>
Native Command Queueing : [...Needs details...]
Link Speed : 3.00 Gbps
Failure Predicted : No
Enclosure Device ID : <Undefined>
Physical Disk ID : 0:0:11
Device ID : <Undefined>
Rebuild Progress : Not Applicable
Vendor : DELL
Disk Type : SATA
SAS Address : 500065B36789ABE9
Predictive Failure Count : <Undefined>
Status : Online

Write Caching : [...Needs details...]

Media Error Count : <Undefined>
Firmware Revision : 03.00C09
Serial Number : WD-WMATV588201382013
Device Speed : 3.00 Gbps
Media Type : HDD
Slot Number : <Undefined>
Product ID : WDC WD1002FBYS-18W8B0
Other Error Count : <Undefined>
Formatted Size : 931.00 GB (999653638144 bytes)
Raw Size : <Undefined>
Native Command Queueing : [...Needs details...]
Link Speed : 3.00 Gbps
Failure Predicted : No
Enclosure Device ID : <Undefined>
Physical Disk ID : 0:0:3
Device ID : <Undefined>
Rebuild Progress : Not Applicable
Vendor : DELL
Disk Type : SATA
SAS Address : 500065B36789ABE7
Predictive Failure Count : <Undefined>
Status : Online

...

Physical Disk Intel

#: avsysreport pdisk controller=0
=== Physical disks
Write Caching : Disabled
Media Error Count : 0
Firmware Revision : A870
Serial Number : YGGM8WSA
Device Speed : 6.0Gb/s
Media Type : SATA
Slot Number : 11
Product ID : HUA723020ALA640
Other Error Count : 0

avsysreport 189
EMC CONFIDENTIAL
Command Reference

Formatted Size : 1.817 TB

Raw Size : 1.819 TB
Native Command Queueing : Enabled
Link Speed : 3.0Gb/s
Failure Predicted : No
Enclosure Device ID : 8
Physical Disk ID : 11
Device ID : 20
Rebuild Progress : Not Applicable
Vendor : Intel
Disk Type : SATA
SAS Address : 5001517E3B0BF0AB
Predictive Failure Count : 0
Status : Online

Write Caching : Disabled

Media Error Count : 0
Firmware Revision : A870
Serial Number : YGGL64JD
Device Speed : 6.0Gb/s
Media Type : SATA
Slot Number : 6
Product ID : HUA723020ALA640
Other Error Count : 0
Formatted Size : 1.817 TB
Raw Size : 1.819 TB
Native Command Queueing : Enabled
Link Speed : 3.0Gb/s
Failure Predicted : No
Enclosure Device ID : 8
Physical Disk ID : 6
Device ID : 15
Rebuild Progress : Not Applicable
Vendor : Intel
Disk Type : SATA
SAS Address : 5001517E3B0BF0A6
Predictive Failure Count : 0
Status : Online

...

Virtual Disk Dell

#: avsysreport vdisk controller=0
=== Virtual disks
Write Policy : Write Through
Size : 931.00 GB (999653638144 bytes)
Layout : RAID-1
IO Policy : <Undefined>
Virtual Disk ID : 5
Bus Protocol : SATA
Access Policy : <Undefined>
Media : HDD
Disk Cache Policy : Disabled
Number of Drives : <Undefined>
Stripe Size : 64 KB
Read Policy : No Read Ahead
Device Name : /dev/sdf
Status : Ok

Write Policy : Write Through

Size : 931.00 GB (999653638144 bytes)
Layout : RAID-1
IO Policy : <Undefined>
Virtual Disk ID : 0

190 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Bus Protocol : SATA

Access Policy : <Undefined>
Media : HDD
Disk Cache Policy : Disabled
Number of Drives : <Undefined>
Stripe Size : 64 KB
Read Policy : No Read Ahead
Device Name : /dev/sda
Status : Ok

...

Virtual Disk Intel

#: avsysreport vdisk controller=0
=== Virtual disks
Write Policy : Write Back
Size : 1.817 TB
Layout : RAID-1
IO Policy : Direct
Virtual Disk ID : 5
Bus Protocol : <Undefined>
Access Policy : Read/Write
Media : <Undefined>
Disk Cache Policy : Disabled
Number of Drives : 2
Stripe Size : 64 KB
Read Policy : No Read Ahead
Device Name : <Undefined>
Status : OK

Write Policy : Write Back

Size : 1.817 TB
Layout : RAID-1
IO Policy : Direct
Virtual Disk ID : 4
Bus Protocol : <Undefined>
Access Policy : Read/Write
Media : <Undefined>
Disk Cache Policy : Disabled
Number of Drives : 2
Stripe Size : 64 KB
Read Policy : No Read Ahead
Device Name : <Undefined>
Status : OK

...

avsysreport 191
EMC CONFIDENTIAL
Command Reference

avtar
The avtar command is used to:
◆ Back up files and directories.
◆ Delete an existing backup.
◆ Extract and restore files or directories from a previous backup.
◆ List the labels and dates of backups, or list the names of files and directories in a
backup.
◆ Validate a backup to ensure that data can be extracted.

Synopsis
avtar {{--create | -c} | --delete | {--extract | --get | -x}
| {--list | -t} | --backups | --validate}

FILE1 [FILE2 ... ] DIR1 [DIR2 ... ]

[--account=LOCATION] [{--aclrestore | --existing-dir-aclrestore}]

[--after=DATE] [--backupsystem]
[--backupsystem-ignore-version-check={TRUE | FALSE}]
[--before=DATE] [--cacheprefix=PREFIX]
[--cache-migration-period=DAYS] [--cache-prefix]
[--cacheitmsize=TRUE|FALSE] [--cachepaxstream=TRUE|FALSE]
[--checkcache] [--clearcache] [--count=NUM] [--ddr={true | false}]
[--ddr-index=NUM] [--deflateofficexml={TRUE | FALSE}]
[{--dereference | -h}] [--diff_sequencenumber=NUM]
[{--directory=DIR | -C DIR}] [--enable-filecache=TRUE|FALSE]
[--enable-hashcache=TRUE|FALSE] [--encodepassword=PASSWORD]
[--exclude=PATTERN] [--exclude_cachefile]
[{--exclude-from=FILE | --exclude_from=FILE | -X FILE}]
[--existing-file-overwrite-option --overwrite}={always
| modified | never | newest | newname}]
[--expires={NUM | TIMESTAMP}] [--flagfile=FILE] [--force]
[--forcefs=FSTYPE] [--from-stdin] [--help] [--hfsaddr=AVAMARSERVER]
[--id=USER@AUTH] [--ignorefs=FSTYPE] [--include=PATTERN]
[{--include-from=FILE | --include_from=FILE}]
[--informationals=N | --noinformationals]
[--inflateofficexml={TRUE | FALSE}] [{--keep-old-files | -k}]
[{--label=NAME | -f NAME}] [--labelnumber=ID]
[--libavctl_path=PATH] [--logfile=FILE]
[--max-cache-pages-resident=NUM] [--no-recursion] [--nostdout]
[--nowarnings] [--oktoclear] [{--one-file-system | -l}]
[--open-file-restore-option={deferred | never | newest | newname}]
[--paging-cache={TRUE | FALSE}] [--password=PASSWORD] [--parallel]
[--path=LOCATION] [--pluginid-list=LIST | pluginids=LIST]
[--preservepaths] [--quiet] [--repaircache] [--reparse_limit=N]
[--restore-acls-only]
[--restorehidden={TRUE | FALSE}] [--restoreshortnames]
[--restoresystem] [--restorewfp] [--retention-type={daily | monthly
| none | weekly | yearly}] [--run-after-freeze=SCRIPT]
[--run-after-freeze-clauses=STRING] [--run-at-end=SCRIPT]
[--run-at-start=SCRIPT] [--run-at-start-clauses=STRING
| --run_at_start_clauses=STRING] [--sequencenumber=ID]
[--server=AVAMARSERVER] [--showlog] [--skip-high-latency]
[--sms_auth=NAME] [--sms_password=PASSWORD]
[--stored_on_pool=POOL-NAME] [--streamformat=N]
[--systemstatefile=FILE.bkf] [--suspend_nss_compression]
[--target=PATH] [--testwfp] [{--to-stdout | -O}] [--totals]
[--tryagain] [--usage]
[--utilize_changed_block_list={TRUE | FALSE}]

192 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

[{--verbose[=LEVEL] | -v}] [--version]

Commands
Supply one and only one of the following commands on each avtar command line.

Table 143 Commands for the avtar command

Command Description

--create | -c Creates a new backup. Either --create or -c can be used.

Typically, you should include a list of files, directories, or a path to
back up. If you do not specify which files, directories, or a path to
back up, then the entire local file system is backed up.

--delete Deletes an existing backup.

Backups can only be deleted one at a time.
By default, this command deletes the most recent backup. However,
you can delete a backup by supplying --after=DATE, --before=DATE,
--label=NAME, --retention-type, or --sequencenumber=ID options.
This command added in version 4.0.

--extract | --get | -x Restores (extracts) files or directories from a previous backup.

Either --extract or -x can be used.
The extraction (restoration) defaults to the most recent backup, if no
selection criteria is provided.
By default, existing files are not overwritten during an extraction
(restoration). To overwrite existing files, supply the
--existing-file-overwrite-option.
During an extraction, the path indicated in the syntax when the
backups were created is the path to which the files are extracted.
The options most often used with the --extract command include
--label and --target=PATH, where PATH is the device and directory
location to where the files or directories is extracted.

--list | -t Lists the contents of a backup. Either --list or -t can be used.

When used with the --verbose option, it returns file and directory
permissions, size, creation date and time, as well as the file or
directory name.
By default, information from the most recent backup is returned.
However, you can return information on other backups by filtering
for a range of backup creation dates using --after=DATE or
--before=DATE.
Additionally, if you labeled the backup when you created it, you can
also filter by that descriptive label using --label=NAME.

--backups Lists all backup names and when they were created by a specific
user account.
Output is sorted by backup time (latest first) and returns size,
creation date and time, backup label and the path that was backed
up.
The listing can be filtered for a range of creation dates by using
--after=DATE or --before=DATE.

--validate Validates the integrity of a previous backup by attempting a restore

without actually restoring any data.

avtar 193
EMC CONFIDENTIAL
Command Reference

File and directory list

If you use the --create, --extract, or --list commands, then you can include a list of files or
directories to back up or restore. If you do not supply a list, then the entire local file
system is backed up or restored. The following table describes the file and directory list
that you can supply for avtar.

Table 144 File and directory list for the avtar command

Command Description

FILE1 [FILE2 ... ] One or more files or directories to back up (create), restore (extract), or
DIR1 [DIR2 ... ] list.
Separate multiple entries with white space.
You can supply both a list of files and a list of directories on the same
avtar command line.
On all platforms except Microsoft Windows, common glob operators
(wildcards) such as asterisk (*) and question mark (?) are allowed.
The default behavior is to recursively process all subdirectories.

Options
The following options are available for the avtar command.

Table 145 Command options for the avtar command (page 1 of 11)

Option Description

--account=LOCATION Specifies a hierarchical LOCATION on the Avamar

server. This option is relative to the current home
location, unless a slash (/) is used as a prefix to
the path designation, in which case an absolute
path is assumed.
Same as --path=LOCATION.

--aclrestore | Used with --extract to replace security settings

--existing-dir-aclrestore (ACLs) on pre-existing directories.

--after=DATE Used with --delete, --extract, --list, or --backups to

only process backups created on or after this
calendar DATE.
Expected date/time format is YYYY-MM-DD
HH:MM:SS.
DATE can also be truncated to the desired
resolution.
--after interacts with both --before and --count in
the following manner:
1. If a valid range of dates is specified by
supplying both --before and --after, then avtar
operates on all backups within that range and
--count is superfluous.
2. If either --before or --after is supplied without
the other, then avtar operates on the number of
backups specified by --count. If --count is not
supplied, then only one backup is processed.

194 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 2 of 11)

Option Description

--backupsystem Used with --create to back up Windows system

state along with the file system. This option is only
applicable to Windows platforms.
When specified, the following actions are
performed during the backup:
1. avtar invokes NTBackup, which generates a
SystemState.bkf file in the EMC \var directory.
This file stores a snapshot of the Windows
system state, as well as the Windows\Sysvol
folder on servers using Active Directory.
You can specify --systemstatefile=FILE.bkf to
override the default SystemState.bkf file
location.
2. avtar then pre-processes the SystemState.bkf
file to maximize data deduplication.
3. Finally, avtar performs the backup, which is
assumed to comprise the entire file system,
including the SystemState.bkf file.

--backupsystem-ignore-version-check Used with --create to ignore Windows version

={true | false} checks. This option is only applicable to Windows
platforms.

--before=DATE Used with --delete, --extract, --list, or --backups to

only process backups created before this calendar
DATE.
Expected date/time format is YYYY-MM-DD
HH:MM:SS.
DATE can also be truncated to the desired
resolution.
--before interacts with both --after and --count in
the following manner:
1. If a valid range of dates is specified by
supplying both --before and --after, avtar
operates on all backups within that range.
--count is superfluous.
2. If either --before or --after is supplied without
the other, then avtar operates on the number of
backups specified by --count. If --count is not
supplied, only one backup is processed.

--cache-migration-period=DAYS Specifies the length of time to use the f_cache.dat

and p_cache.dat cache files as a source for
migration.
The default setting is 14 days.

--cache-prefix Creates unique caches.

--cacheitmsize={TRUE | FALSE} Forces storage of additional access time in the file

cache.
Use only for the file cache.
The default setting is FALSE.

--cachepaxstream={TRUE | FALSE} Enables caching for the PAX stream format.

The default setting Is FALSE.

avtar 195
EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 3 of 11)

Option Description

--cacheprefix=PREFIX Defines a prefix for cache file names.

A prefix enables the creation of unique cache files
for use with multiple simultaneous instances of
avtar.

Note: The --cacheprefix option applies to both

sets of cache files: the original cache files and the
demand-paging cache files.

This option added in version 5.0.

--checkcache Verifies the integrity of the cache.

--clearcache Deletes existing cache files and starts new cache

files from scratch.
This option disables the migration feature from an
older-format cache file, if such a file exists.

--count=NUM Used with --backups to only list this number

(NUM) of backups. If this option is not supplied,
default behavior is to list all backups.
Additional information about how --count
interacts with --after and --before is available in
the --after and --before option listings.

--ddr={TRUE | FALSE} Specifies whether to store the backup on a Data

Domain system instead of the Avamar server. To
store the backup on a Data Domain system,
specify TRUE.

--ddr-index=NUM Any positive integer (INT) specifies the index

number (1, 2, 3, and so forth) of the Data Domain
system on which to store the backup. The index
number is assigned to the Data Domain system
when it is added to the Avamar server
configuration.
If --ddr-index=0 is supplied, backup is stored on
the Avamar server.

--deflateofficexml={TRUE | FALSE} Enables or disables special restore processing of

Microsoft Office 2007 files. The default setting is
TRUE.
This option added in version 5.0.

--dereference | -h Includes all files pointed to by symbolic links.

Either --dereference or -h can be used.

--diff_sequencenumber=NUM Specifies the backup sequence number (NUM) for

comparison. Used to compare the list of files in
two backups.

--directory=DIR | -C DIR Changes to this directory (DIR) before backup or

restore.
Either --directory=DIR or -C DIR can be used.

--enable-filecache={TRUE | FALSE} Enables or disables the file cache.

The default setting is TRUE.

--enable-hashcache={TRUE | FALSE} Enables or disables the hash cache.

The default setting is TRUE.

196 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 4 of 11)

Option Description

--encodepassword=PASSWORD Converts a plain-text Avamar server PASSWORD to

an encrypted PASSWORD. The encrypted
password string is written to stdout.
Beginning with version 6.1, Avamar clients and
command line utilities can use either plain text or
encrypted passwords, even though passwords are
always stored on disk in encrypted format.
Encrypted passwords are host-specific. A
password encrypted and stored on one host
cannot be copied and used on another host.
This option added in version 6.1.

--exclude_cachefile={TRUE | FALSE} Excludes cache files from backup. Default is TRUE.

--exclude-from=FILE | Specifies the FILE containing a list of matching

--exclude_from=FILE | -X FILE patterns used to exclude files from a backup or
restore.
Common glob operators (wildcards) such as
asterisk (*) and question mark (?) are allowed.
When specifying exclusions, case sensitivity
varies according to the target computing platform
you are backing up. Exclusions specified for
Windows platforms are not case-sensitive;
exclusions specified for most other platforms are
case-sensitive.
Either --exclude-from=FILE, --exclude_from=FILE
or -X FILE can be used.
Multiple exclude files can be used. However, each
one must be preceded by a separate
--exclude-from=FILE option.

--exclude=PATTERN Excludes these files from a backup or restore.

PATTERN is a single matching pattern. Common
glob operators (wildcards) such as asterisk (*) and
question mark (?) are allowed.
When specifying exclusions, case sensitivity
varies according to the target computing platform
you are backing up. Exclusions specified for
Windows platforms are not case-sensitive;
exclusions specified for most other platforms are
case-sensitive.
You can use multiple --exclude=PATTERN options
on the same command line. However, each
--exclude=PATTERN option can contain only one
matching PATTERN.
Use the --exclude-from=FILE option to pass in
multiple file exclusions.

--expires={NUM | TIMESTAMP} Specifies the backup expiration date and time.

If an integer (NUM) smaller than 32-bits is
supplied, backup expires in that number of days.
If a TIMESTAMP is supplied, backup expires on
that calendar date and time. 32-bit integers are
processed as a UNIX TIMESTAMP; 64-bit integers
are processed as a Windows TIMESTAMP.

avtar 197
EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 5 of 11)

Option Description

--flagfile=FILE Specifies the FILE containing a list of options and

values that are processed by this program as if
they were included on the command line. The
default setting is
/usr/local/avamar/etc/usersettings.cfg.

--force Forces traversal of Network File System (NFS) and

Loopback File System (LOFS) mounts.

--forcefs=FSTYPE Forces traversal of this file system type (FSTYPE).

--from-stdin Used with --create to back up a stdin stream.

--help Shows full online help (options and full

descriptions), then exits.

--id=USER@AUTH Authenticate as this Avamar user ID (account

name).
USER is the Avamar username, and AUTH is the
authentication system used by that user. The
default internal authentication domain is
“avamar.”
For example: jdoe@avamar.

--existing-file-overwrite-option Used with --extract to overwrite existing files

--overwrite}={always | modified during a restore (extraction). One of the following:
| never | newest | newname
• always—Replaces any existing client file if it
exists in the backup.
• modified—Does not restore the file if the
date/time stamp of the backup file is the same
as the local client file.
• never—Prevents client files from being
overwritten.
• newest—Only restores the file if the date/time
stamp of the file in the backup is newer than
the file on the local client.
• newname—Restores the file but appends a
version number to the restored file (for
example, myfile.txt becomes myfile(1).txt when
restored).
Either --overwrite or --existing-file-overwrite-option
can be used.

--ignorefs=FSTYPE Forces avtar to not traverse (that is, ignore) this

file system type (FSTYPE).

198 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 6 of 11)

Option Description

--include-from=FILE | Specifies a FILE containing a list of matching

--include_from=FILE patterns used to include files 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.
Either --include-from=FILE or --include_from=FILE
can be used.
Multiple include files can be used. However, each
one must be preceded by a separate
--include-from=FILE option.

--include=PATTERN Includes these files in a backup or restore.

This option only includes files that would
otherwise have been excluded with the
--exclude=PATTERN option.
PATTERN is a single matching pattern. 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.
You can use multiple --include=PATTERN options
on the same command line. However, each
--include=PATTERN option can contain only one
matching PATTERN.
Use the --include-from=FILE option to pass in
multiple file inclusions.

--inflateofficexml={TRUE | FALSE} Enables or disables special backup processing of

Microsoft Office 2007 files. The default setting is
FALSE.
This option added in version 4.0.

--informationals=N | Supplying --informationals=N sets the information

--noinformationals level. For example, --informationals=3.
Supplying --noinformationals disables all status
messages.

--label=NAME | -f NAME Used with --create to apply this short descriptive

NAME to the new backup or delete operation.
Used with other commands and options to search
or filter behavior by this NAME.
Either --label=NAME or -f NAME can be used.

--libavctl_path=PATH Specifies the full PATH to the libavctl shared

library.

--logfile=FILE Logs to this FILE. If no FILE value is supplied,

default log file (avtar. log) is used.

avtar 199
EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 7 of 11)

Option Description

--max-cache-pages-resident=NUM Specifies the maximum number of cache pages

held in RAM at any time.
The default setting is 20.

--no-recursion If set, causes avtar to not descend into

subdirectories during restore.

--nostdout Disables output to stdout; output still goes to log

file.

--nowarnings Disables warning messages.

--one-file-system | -l Used with --create to only backup files on the

same local file system as the target directory.
Either --one-file-system or -l can be used.

--open-file-restore-option= Used with --extract to specify how open client files

{deferred | never | newest are restored (extracted). Valid settings are:
| newname}
• deferred—Replaces open files the next time the
client computer is rebooted.
• never—Does not ever overwrite an open file
during a restore.
• newname—Only restores an open file if the
date/time stamp of the file in the backup is
newer than the open file on the local client.
• newest—Restores the open file but appends a
version number to the restored file (for
example, myfile.txt becomes myfile(1).txt when
restored).

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

--parallel Asserts parallel processing of directories.

Supported for backups and restores on Avamar
Data Store systems only; the --parallel switch is
not supported with Data Domain.
In many cases --parallel can make backups slower.
This is because --parallel is only useful if you are
actually traversing different physical hard drives.
If you try --parallel with multiple targets on the
same disk, this can slow the process down due to
disk thrashing.

--plugins=LIST | Constrains backup activity to include backups

--pluginid-list=LIST originally taken with one or more plug-in types,
where LIST is a comma-separated list of one or
more integer plug-in IDs.

--preservepaths Used with --extract to restore the complete path of

all files relative to the --target directory.

--quiet Disables both warnings and status messages.

Equivalent to --noinformationals plus
--nowarnings.

--repaircache Repairs a corrupted cache file.

--reparse_limit=N Specifies the maximum number (N) of reparse

point levels to traverse in an NTFS file system. The
default setting is 1.

200 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 8 of 11)

Option Description

--restore-acls-only If true, restores ACLs to existing files on disk, but

does not restore any files.

--restore-interceptor-check= Used with --extract to detect if pre-existing

{TRUE | FALSE} directories have access denied due to ACLs, file
filters, or file interceptors.
If TRUE, and the directory exists, and cannot be
written into, avtar records a problem and
continues to the next folder.
This option is only applicable to Windows
platforms.

--restore-sparse-threshold=KB Used with --extract to specify the number of

consecutive zero bytes in KB that must exist in a
file to create a sparse region in that file.
This option does not apply when directing output
to a stream.
Setting this option to zero disables all sparse
region checking.

--restorehidden={TRUE | FALSE} Used with --extract to control whether hidden files

(files with the “hidden” attribute set) should be
restored.

--restoreshortnames Used with --extract to restore short (8.3) Windows

filenames.

Note: This option only applies to Windows XP and

Server 2003 and later version. If supplied with
earlier versions, it has no effect.

--restoresystem Used with --extract to restore system files.

--restorewfp Used with --extract to restore files protected with

Windows File Protection (WFP).

--retention-type= Used with --create to assign an advanced

{daily | monthly | none | weekly | retention type, which allows this backup to be
yearly}
managed using advanced retention policies and
settings.
Valid values are one of the following types:
• daily—Explicitly designate this backup as a
daily backup.
• monthly—Explicitly designate this backup as a
monthly backup.
• none—Do not explicitly assign any retention
type to this backup (that is, treat it as a normal
on-demand backup).
• weekly—Explicitly designate this backup as a
weekly backup.
• yearly—Explicitly designate this backup as a
yearly backup.
The default setting is none. If set to none or not
supplied, backup is not explicitly assigned an
advanced retention type.
This option added in version 4.0.

--run-after-freeze-clauses=STRING | Use these clauses (STRING) to invoke the

--run_after_freeze_clauses=STRING --run-after-freeze=SCRIPT.

avtar 201
EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 9 of 11)

Option Description

--run-after-freeze=SCRIPT Runs SCRIPT after OTM freezes open files.

This option can only be run against Windows
clients.
SCRIPT must be located in C:\Program
Files\avs\etc\scripts.
SCRIPT must have a .bat, .js or .vbs extension.

--run-at-end=SCRIPT Runs SCRIPT at end of avtar session.

SCRIPT must be located 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.

--run-at-start-clauses=STRING | Use these clauses (STRING) to invoke the

--run_at_start_clauses=STRING --run-at-start=SCRIPT.

--run-at-start=SCRIPT Runs SCRIPT at beginning of avtar session.

SCRIPT must be located 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.

--sequencenumber=ID Used with --delete, --extract, --list, or --validate to

specify the backup on which to operate.

--server=AVAMARSERVER AVAMARSERVER IP address or fully qualified

hostname (as defined in DNS). Same as
--hfsaddr=AVAMARSERVER.

--showlog Shows session log for successful backups.

--skip-high-latency Used with --create to enable special processing

that does not include certain files and directories
with high latency in the backup. The default
setting is false.
This option added in version 3.7.1.

--sms_auth=NAME Used when backing up or restoring an Avamar

Client for NetWare to specify which user account
to use to perform the backup or restore. NAME
must be a full distinguished username. For
example, admin.it.corp.

--sms_password=PASSWORD Used when backing up or restoring an Avamar

Client for NetWare to specify the --sms_auth user
account PASSWORD.

202 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 10 of 11)

Option Description

--stored_on_pool=POOL-NAME Used when backing up or restoring an Avamar

Client for NetWare to specify the name of the NSS
storage pool in which to store the deltas from
incoming writes to any volume provisioned by the
storage pool that has been snapped. By default,
the same pool that has been backed up is used as
the stored on pool.

--streamformat=N Used with --create and --extract to specify stream

format. The default setting is none.

--suspend_nss_compression Used when backing up an Avamar Client for

NetWare to suspend NSS compression during
backups.
This option added in version 5.0.

--systemstatefile=FILE.bkf Used with the --backupsystem option to override

the default Windows system state backup file
(FILE.bkf) location.

--target=PATH Used with --extract to restore files to a different

location (PATH) on the local file system.

--testwfp Lists all files protected with Windows File

Protection (WFP).

--to-stdout | -O Used with --extract to restore a single file to

stdout.
Either --to-stdout or -O can be used.

--totals Used with --list to print total bytes listed.

You must also supply either --verbose or -v to view
--totals information.

--tryagain If server is idle, try completing this operation later.

This is the default setting.

--usage Shows abbreviated online help (options only, no

descriptions), then exits.

--utilize_changed_block_list= Enables or disables special processing of

{TRUE | FALSE} VMware® Image backups in which changed block
tracking is used to determine which blocks within
the VMware image have changed and only process
those changed blocks. The default setting is TRUE.
This option added in version 5.0.

avtar 203
EMC CONFIDENTIAL
Command Reference

Table 145 Command options for the avtar command (page 11 of 11)

Option Description

--verbose[=LEVEL] | -v Specifies application message verbosity. Four

levels are available:
• Level 1 or no level supplied—Enables all
messages (status and warnings) but with
minimum verbosity.
• Level 2—Includes all information in level 1, the
avtar session ID and mount point information
for each backup, and expanded path properties
(size, ownership, permissions, etc). Level 2
also includes information for browse and
status operations, which are not included in
level 1.
• Level 3—Includes all information in level 2, the
percentage of a file that has been sent during a
backup, and some DLL information on
Windows clients.
• Level 4—Includes all information in level 3, and
Windows tray applet information. If an error
occurs during a file backup, path information is
shown.

--version Shows version, then exits.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 146 Avamar-only advanced command options for the avtar command (page 1 of 8)

Option Description

--acntver=NUM Sets the accounting system version. --acntver=2 is currently

the only supported setting.

--alldc Connects directly to all datacenters. The default setting is

TRUE.

--allnodes Connects directly to all nodes.

--backuptag=TAG Used with -c to specify a custom backup TAG.

Used with -t and -x to list or extract the specified backup,
respectively.
This custom TAG is independent of the backup label.
This option added in version 3.7.2.

--bigdirgroup=NUM Controls how many files should be handled in each big

directory group. By default, files are read in groups of
250,000 entries. A larger value consumes more memory but
requires fewer passes of the directory.

204 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 146 Avamar-only advanced command options for the avtar command (page 2 of 8)

Option Description

--bigdirslotlimit=SLOTS Controls threshold at which avtar considers a directory to

be a big directory (bigdir). This threshold is based on the
byte size of the directory itself and therefore is an estimate
of the number of files that might be contained within that
directory. The default setting of 25,000 causes directories
that contain at least 25,000 slots to go through the new
nbackbigdir-smartdirwalk logic to break the directory into
smaller pieces.
When this threshold is exceeded and the new bigdir
handling code is used, a new INFO message appears:
INFO: Handling big directory: "DIR-NAME"

where DIR-NAME is the actual directory name being

processed.
Setting --bigdirslotlimit=-1 disables all of the
nbackbigdir-smartdirwalk logic to facilitate debugging.

--bindir=PATH Sets the directory containing Avamar binary files. This

directory is specified during Avamar client installation. The
default setting is /usr/local/avamar/bin.

--blocksize=BYTES Sets the number of bytes to read from one file at a time
during a backup. The default setting is 131072.

--cachebuckets=NUM Specifies the number of buckets in the hash cache. The

default setting is 20.

--cachedir=DIR Sets the local cache directory. This directory is specified

during Avamar client installation. The default setting is
/root/.avamardata. Same as --vardir=DIR.

--checkrestoresize= If TRUE, then target disk is checked for adequate free space
{TRUE | FALSE} before starting a restore. The default setting is TRUE.

--chunkstats Outputs more chunker information.

--clevel=NUM Used with --compress to specify the numeric backup

compression level. Larger values specify more
compression.

--commentfile=FILE Adds this FILE to the backup as .system_info/comment.

--comstats Enables communication statistics every second.

--compress Enables backup compression.

--compthreshold=MAGIC Sets the composite block sticky byte magic number. The
default setting is 1152.

--conntimeout=SEC Sets the socket connect timeout. The default setting is 60

seconds.

--consolidate Enables a special storage mode that stores data associated

with a composite contiguously on the same disk. This is the
default setting.
This option added in version 4.0.

--controlport=PORT Sets the control port number. The control port is a socket
connection that avtar uses to monitor stats requests.

avtar 205
EMC CONFIDENTIAL
Command Reference

Table 146 Avamar-only advanced command options for the avtar command (page 3 of 8)

Option Description

--cpu-throttle=PERCENT Controls the CPU usage rate at which avtar sends data to
the server.
If --cpu-throttle=PERCENT is supplied, avtar pauses as long
as necessary after sending each packet to ensure that CPU
usage does not exceed the average rate; average rate is
specified as a percent.
For example, --cpu-throttle=40 enables avtar to use up to
40% of CPU resources.

--dblevel=NUM Sets the numeric debug level. The default setting is -1.

--debug Enables debugging messages.

--degenerate Enables degenerate mode. If set, avtar performs a backup

of the client file system but does not connect to the server.

--delete Deletes a single backup from the Avamar server. The

selection method to determine which backup to delete is
the same as other avtar commands that operate on
backups. Note that to reduce accidental deletions, the
--force option must also supplied.
This option added in version 3.7.2.

--depth=NUM Sets the level in chunktree at which to send tree to server.

The default setting is 2. Larger values might use excessive
amounts of client memory.

--detect-acl-changes If supplied, file-cache holds the atime of each file and a

new backup compares the current and previous atimes. If a
mismatch is detected, then the file is re-scanned to detect
ACL changes.

--dirthreshold=MAGIC Sets the directory block sticky byte magic number. The
default setting is 8192.

--dpnobj Uses the dpnobj internal representation when listing the

contents of a backup.

--dumpformat Writes NDMP stream. Used by avndmp only.

--dumplittle Writes NDMP stream with little-endian byte ordering. Used

by avndmp only.

--dumpnetapp_acls Writes NDMP stream with NetApp ACLs. Used by avndmp

only.

--encrypt-strength={High | Sets the encryption METHOD. Valid settings are:

Medium | None}
• High—Strongest available encryption
• Medium—Moderate encryption
• None—No encryption

--encrypt=METHOD Sets the encryption METHOD. Valid settings are:

• tls—Server authentication not requested
• tls-sa—Server authentication requested

--filecachemax=MB Sets the maximum file cache size in MB (negative value is

fraction of RAM). The default setting is -8.

--filestatmin=NUM Sets the minimum byte threshold for candidates in

filestats. The default setting is 1048576.

206 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 146 Avamar-only advanced command options for the avtar command (page 4 of 8)

Option Description

--filestats=NUM Sets the number of files recorded in .system_info/filestats.

The default setting is 500.

--fixedatomsize=BYTES Sets the fixed size for atomic chunks (disables sticky).

--fixedcomposite=COUNT Sets the number of hashes in a composite block (disables

sticky).

--forceaddr Forces use of HFSADDR:HFSPORT.

--format=FORMAT Sets the display FORMAT. The default setting is xml.

--freezecachesize=MB Used with Open Transaction Manager (OTM) on Windows

platforms to specify the OFA cache size in MB (negative
value is percent or hard drive used). The default setting is
-1.

--freezemethod=METHOD Specifies the method avtar uses to freeze a volume before

performing a backup. Only NetWare and Windows clients
support volume freezing. The default setting is best. Valid
settings are:
• best—The avtar program determines the method based
on the platform type.
• vss—The avtar program uses Volume Shadow-copying
Service (VSS).
• otm—The avtar program uses OTM. Use otm only for
platforms running Windows versions before Windows
2003.
• none—The avtar program does not freeze the volume
before a backup. Activities on the volume such as read
and write continue while avtar performs a backup.

--freezetimeout=SECS Used with OTM on Windows platforms to specify OFA

timeout for freezing volumes. The default setting is 120.

--freezewait=SECS Used with OTM on Windows platforms to specify OFA quiet

wait for freezing volumes. The default setting is 5.

--hashcachemax=MB Sets the maximum hash cache size in MB (negative value is

fraction of RAM). The default setting is -16.

--helpx Shows help including extended flags.

--hfsport=PORT Sets the Avamar server port number (HFSPORT). The default
setting is 27000.

--ignoreacls Solaris: ignores Solaris ACLS security descriptors.

--ignoreconfig Does not read any configurations files while parsing flags.
Same as --noconfig.

--ignoredefaultexcludes Windows: ignores default excludes from registry.

--ignorerwxmapping Windows: ignores mapping Windows security descriptors to

UNIX RWX.

--ignorewinperm Windows: ignores restoring Windows security descriptors.

--incpartials Include partial backups in accounting system queries.

--internal Restores or displays internal (hidden) directory types

(.system_info).

avtar 207
EMC CONFIDENTIAL
Command Reference

Table 146 Avamar-only advanced command options for the avtar command (page 5 of 8)

Option Description

--level0 Used with --create to not send is-present messages

(assume all hashes not present on server).

--makeview Creates a new backup view based on a list of files already

on the server.

--makeview_nosubsysteminfos= If TRUE, then system information from individual backups is

{TRUE | FALSE} not merged when creating a backup view. The default
setting is FALSE.

--makeview_pluginmerge= If TRUE, then individual backups are merged into a single

{TRUE | FALSE} backup view. The default setting is FALSE.

--mapi Uses MAPI protocol to communicate with an Exchange

server. Used by avexchange only.

--mapipassword=PASSWORD PASSWORD for --mapiprofile=PROFILE. A password might

not be required in all circumstances. Used by avexchange
only.

--mapiprofile=PROFILE Communicates with Exchange server defined in this MAPI

PROFILE. Used by avexchange only.

--maxchunksize=BYTES Sets the maximum size of an atomic chunk. The default

setting is 61440.

--maxcompsize=MB Sets the threshold at which a composite's elements are

chained together rather than individually queued in the
TODO queue for simultaneous execution. The default
setting is 100 MB (that is, composites that span 100 MB or
more of data are chained).
This option added in version 3.7.1.

--maxfile=MB If not zero, skips files larger than this size in MB.

--maxfilesize=MB Imposes a maximum file size on files that are backed up.
The default setting is 104857600 MB, which sets the limit
at 100 TB. Therefore, any file that reports a size greater than
100 TB is ignored by avtar.

--maxpending=NUM Sets the maximum number of backup or restore chunks in

the air. The default setting is 80.

--maxprefetch=SIZE Used with --parallel to set how much data each prefetch
thread is allowed to read before blocking occurs. The
default setting is 2048 KB (2 MB).

--memman=MODE Sets memory debugging mode.

--memmap Sets the memory map source files.

--minchunksize=BYTES Sets the minimum size of an atomic chunk. The default

setting is 1000.

--mincompsize=BYTES Sets the minimum size of a composite chunk. The default

setting is 96.

--mindirsize=BYTES Sets the minimum size of a directory chunk. The default

setting is 1024.

--msg-retry-timeout=SEC Specifies the maximum time in seconds (SEC) to wait after a

timeout before canceling a replication. The default setting
is 5 minutes (300 seconds).

208 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 146 Avamar-only advanced command options for the avtar command (page 6 of 8)

Option Description

--nagle Enables nagling.

--nat Sets whether the server is using NATing modules.

--nearest Restores from nearest module.

--net-throttle=MBPS Controls the average network rate at which avtar sends data
to the server.
If --net-throttle=MBPS is supplied, avtar pauses as long as
necessary after sending each packet to ensure that network
usage does not exceed the average bandwidth; average
bandwidth is specified in mega bits per second.
For example, --net-throttle=5 uses half a 10Mbps
connection, --net-throttle=0.772 restricts usage to one-half
of a T1 link.

--nocache={TRUE | FALSE} Enables or disables both file and hash caching.

The default setting is FALSE.

--noconfig Does not read any configurations files while parsing flags.
Same as --ignoreconfig.

--nohiddendir Does not write backup information on exit.

--nouserinfo Suppresses getting UID and GID mapping.

--numconns=NUM Sets the number of connections.

--numports=NUM Sets the HFS port count.

--numthreads=NUM Sets the number of threads.

--oktoclear Enables clearing of local cache. The default setting is TRUE.

--paging-cache={TRUE | Enables or disables the demand-paging cache feature for

FALSE} Avamar backups.
The default setting is FALSE if the target is Avamar Datastore
is the target and TRUE if the target is Data Domain.
To revert back to the f_cache.dat and p_cache.dat cache
files, specify FALSE.

--permissions Preserves permissions. The default setting is TRUE.

--ping Checks availability of server. Returns status=0 if reachable.

--pluginport=PORT Specifies the avagent communication PORT.

This value can only be set programmatically by avagent.

--randchunk=NUM Sends random chunks to server up to given number (NUM)

of chunks.

--randseed=NUM Sets random seed.

--raw Does not expand composites blocks.

--readonly-retry-timeout=SEC When setting the server to read-only, specifies the time in

seconds (SEC) to wait before timing out. The default setting
is 1 hour (3600 seconds).

--refcheck Checks hash references of comp and dir chunks.

avtar 209
EMC CONFIDENTIAL
Command Reference

Table 146 Avamar-only advanced command options for the avtar command (page 7 of 8)

Option Description

--replicate Intelligently duplicates contents of one Avamar server to

another.

--replicate-reportonly EMC internal use only.

Implements replicate --reportonly mode.
This option added in version 4.1.

--resetarchive Following successful backup, resets operating system

archive bit for all files backed up.

--search-format Uses the format compatible with metadata search when

listing the contents of a backup.

--sessionticket=FILE Specifies a FILE containing management console-supplied

session ticket.

--short-output | Generates shorter output with --backups.

--short_output

--singleconn Makes a single connection.

--size=BYTES Sets the size hint for client pipe command.

--statistics | --stats Outputs chunk statistics.

--status=SEC Enables periodic status messages and sets the number of

seconds between messages.

--sysdir=DIR Directory (DIR) containing Avamar server files.

--syslog Sends log messages to the server. The default setting is

TRUE.

--tarfile Used with --extract to restore files to a defined system tape

device.
The --tarfile option requires a very specific command line
syntax: --to-stdout is required, as well as piping the output
to the UNIX dd program. For example:
avtar -x clients/MyClient --to-stdout
--avamaronly --tarfile | dd of=/dev/tape
obs=20b

--threadstacksize=SIZE Used with --parallel to explicitly set the default stack size.
The default setting is zero (0), which specifies that the
operating system default stack size should be used.

--threshold=NUM Sets the atomic block sticky byte magic number (NUM). The
default setting is 30000.

--throttle=MBPS Controls rate at which avtar sends data to the server.

If --throttle=MBPS is supplied, avtar pauses as long as
necessary after sending each packet to ensure that network
usage does not exceed the specified maximum bandwidth;
maximum bandwidth is specified in mega bits per second.
For example, --throttle=5 uses half a 10 Mbps connection,
--throttle=0.772 restricts usage to one-half of a T1 link.

--udp Uses UDP instead of TCP.

--uflagsdebug Sets debug parsing. If set, shows each option as it is

processed and each configuration file as it is parsed.

210 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 146 Avamar-only advanced command options for the avtar command (page 8 of 8)

Option Description

--usearchiveattr Forces backup of any files for which the operating system
archive bit is set.

--unknown-okay Forces backup of unknown filesystems.

--vardir=DIR Sets the local cache directory. This directory is specified

during Avamar client installation. The default setting is
/root/.avamardata. Same as --cachedir=DIR.

--web-format | --web_format Puts output in web-parsable form.

--windebug On Windows, opens a progress/status window.

--workorder=FILE Specifies a FILE containing management console-supplied

work request.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 147 Deprecated command options for the avtar command

Option Description

--encrypt=METHOD The following METHOD values were deprecated in version 4.0:

• proprietary—No encryption.
• ssl:AES128-SHA—128-bit Advanced Encryption Standard.
• ssl:AES256-SHA—256-bit Advanced Encryption Standard.
• ssl—A special mode in which the program negotiates and uses
the strongest encryption setting that the session can support.

--restorelength=BYTES Deprecated in version 4.0.

When restoring (extracting) a single file, specifies the length of
the restored file in BYTES.

--restoreoffset=BYTES Deprecated in version 4.0.

When restoring (extracting) a single file, specifies a file offset in
BYTES.

--run-at-end-exit= Deprecated in version 4.0.

{TRUE | FALSE}
If set true and script invoked by way of --run-at-end encounters an
error, avtar exits. Otherwise, avtar continues to run. The default
setting is TRUE.

--run-after-freeze-exit= Deprecated in version 4.0.

{TRUE | FALSE}
If set true and script invoked by way of --run-after-freeze
encounters an error, avtar exits. Otherwise, avtar continues to
run. The default setting is TRUE.

--run-at-start-exit= Deprecated in version 4.0.

{TRUE | FALSE}
If set true and script invoked by way of --run-at-start encounters
an error, avtar exits. Otherwise, avtar continues to run. The
default setting is TRUE.

avtar 211
EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the avtar program:
◆ Run locations—The avtar program resides in and can be run from any of the following
locations:
• Single-node server or multi-node server utility node /usr/local/avamar/bin
• AIX and Linux client /usr/local/avamar/bin
• HP-UX and Solaris client /opt/AVMRclnt/bin
• Windows client C:\Program Files\avs\bin
◆ Username and password—If the Avamar username and password are present in the
.avamar file, then --id=USER@AUTH and --password=PASSWORD are not required on
the command line.

Examples
Although the following examples wrap to more than one line, you must enter all
commands and options on a single command line without any line feeds or returns.
The following command backs up all files within the MyFiles and abcd directories and
labels the backup jdoeFiles:
avtar -c --label="jdoeFiles" MyFiles/ abcd/
--id=jdoe@avamar/clients/MyClient

The following command lists information about the three most recent backups created
after the indicated date and time. Verbose (status and warning) messages are enabled:
avtar --backups --verbose --count=3 --after="2000-09-01 04:30:15"
--id=jdoe@avamar/clients/MyClient

The following command lists files and directories inside the backup labeled jdoeFiles
created before the indicated date and time, with highly verbose (--verbose=2) messages
enabled:
avtar -t --verbose=2 /myfiles/rem --label="jdoeFiles"
--before="2000-09-01 04:30:15" --id=jdoe@avamar/clients/MyClient

The following command extracts into the old_newsletters directory all of the files found in
the backup labeled newsletters that were created before the indicated date and time:
avtar -xv --target="old_newsletters" --before="2001-03-24 15:00:00"
--id=jdoe@avamar/clients/MyClient --label="newsletters"

The following command extracts into the old_newsletters directory those files found in the
abcd and MyFiles directories in the backup labeled newsletters:
avtar -xv --label="newsletters" --target="old_newsletters" abcd/
MyFiles/ --id=jdoe@avamar/clients/MyClient

The following command adds a user-defined prefix (VOL2) to the client f_cache.dat and
p_cache.dat files:
avtar --cacheprefix=VOL2

Filenames are VOL2_f_cache.dat and VOL2_p_cache.dat.

212 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Specifying user accounts on the command line

Because Avamar user accounts can be added to domains and machines, the exact avtar
command line syntax for specifying a user account can vary.
The following command shows how to specify a “global” user account (one that has been
created at the top-level server root domain):
avtar -c --id=jdoe --ap=PASSWORD --account=/DOMAIN/MACHINENAME

Notice that because no domain or machine was specified with the --id option, that this
user account is assumed to exist at the top-level server root domain.
The following command shows how to specify a user account that has been created within
a domain other than the top-level server root domain:
avtar -c --id=jdoe@/DOMAIN --ap=PASSWORD --account=/DOMAIN/SUBDOMAIN

The following command shows how to specify a user account that has been created at the
client level:
avtar -c --id=jdoe@/DOMAIN/CLIENT --ap=PASSWORD

Notice that the --account option is not required because the client was specified by the --id
option.

Restoring system files

On UNIX variant systems, device and special files (named pipes, Solaris doors, named
sockets, and so forth) are considered system files and are not restored unless avtar is run
as root and the --restoresystem option is supplied.
On Windows systems, files with the SYSTEM attribute set, as well as files protected by
Windows File Protection (WFP) are considered system files and are not restored unless the
--restoresystem option is supplied.
Even if --restoresystem is supplied, WFP-protected files cannot be restored in normal
Windows operating modes. Windows must be booted into a special recovery mode to
overwrite WFP-protected files.

Backing up from stdin

This two-line command snaps up a stdin stream:
touch FILE
cat DATA | avtar --create --from-stdin FILE

The touch command in the previous example creates a file stub from which a filename and
access permissions are read. During subsequent restore operations, this is the file that is
restored.

avtar 213
EMC CONFIDENTIAL
Command Reference

Script subprocessing
The following clauses provide additional script subprocessing capabilities such as setting
additional environment variables, controlling argument parsing behavior and setting
timeouts.
These additional processing clauses are passed into the script subshell using the
--run-after-freeze-clauses=string or --run-at-start-clauses=string command line options.
The following table lists and describes each clause. The Default (not supplied) column
lists the default behavior (that is, behavior that occurs if the clause is not supplied). The
No value columns lists the behavior used if the clause is supplied without a value (for
example, exit-on-error).

Table 148 Script subprocessing clauses for the avtar command (page 1 of 3)

Clause Default (not supplied) No value Description

desc=text run-at-end for Descriptive text for this clause.

--run-after-freeze-clauses
run-at-start for
--run-at-start-clauses

env=name=value Defines environment variable name

with this value for the script
environment.
The default behavior is to only inherit
environment variables already set in
parent shell, plus the following four
environment variables:
• $AVAMAR_SCRIPT_DESCRIPTION
• $AVAMAR_VARDIR
• $AVAMAR_BINDIR
• $AVAMAR_SYSDIR
$AVAMAR_SCRIPT_DESCRIPTION is the
string stored in the desc=text clause.
$AVAMAR_VARDIR, $AVAMAR_BINDIR
and $AVAMAR_SYSDIR contain values
corresponding to avtar --vardir,
--bindir, and --sysdir options,
respectively.

exit-on-error={true | false} false true If true, exit this process if the sub
script exits with a non-zero exit code.
The default setting is true.

skip-on-error={true | false} false true If true, skip the next backup/restore

component if an error is encountered.
The default setting is true.

214 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 148 Script subprocessing clauses for the avtar command (page 2 of 3)

Clause Default (not supplied) No value Description

list={true | false} | false true Specifies one of two possible parsing

stringlist-args={true | false} modes for
--run-after-freeze-clauses=string and
--run-at-start-clauses=string:
• If false, split string into separate
arguments for the script. Arguments
must be separated by white space.
• If true, use each argument string as
a single argument to be passed into
the script. Arguments can contain
white space and must be separated
by commas.
False is the default setting, primarily to
ensure backward compatibility.
However, this restricts the arguments
that can be passed into the subscript.
This backward compatibility mode
requires that only one argument string
be present. For example:
--run-at-end="scriptname arg1
arg2"

However, using list parsing mode (with

this clause set to true), the following
script command line containing
multiple arguments with spaces is
allowed:
--run-at-end="scriptname","arg
1 with spaces","arg2 with
spaces"

use-cscript={true | false} false true If true, the script is executed with

Microsoft cscript.exe. The default
setting is false, and unless
use-cscript-raw clause is defined, the
script is executed with Microsoft
cmd.exe /q /c.

use-cscript-raw={true | false} false true If true, the script is executed with

Microsoft cscript.exe /nologo. The
default setting is false, and unless the
use-cscript clause is specified true,
the script is executed with Microsoft
cmd.exe /q /c.

avtar 215
EMC CONFIDENTIAL
Command Reference

Table 148 Script subprocessing clauses for the avtar command (page 3 of 3)

Clause Default (not supplied) No value Description

timeout-seconds=SEC Specifies the script timeout in seconds

(SEC). The default setting is 3600 (1
hour). If the script does not return
before the timeout has elasped, the
script is terminated and avtar resumes
processing as if the script had returned
an error.
For example, supplying
--run-at-start-clauses=timeout-second
s=7200 on the avtar command line
sets the script timeout to 7200
seconds (2 hours).

create-stdout-pipe={true | false} If BOOL is true, create a stdout pipe

with script. The default setting is false.

create-stderr-pipe={true | false} If BOOL is true, create a stderr pipe

with script. The default setting is false.

avtar.bin
The avtar.bin file is the actual binary executable for the avtar command.



You should not run the avtar.bin file directly. Instead, use the avtar command.

axion_install
The axion_install command is a master script that installs or uninstalls Avamar server
software on various node types.
By default, it resides in the /usr/local/avamar/src/VERSION directory after the customer
tarball is extracted during server software installation; where VERSION is the server
operating system version that was last installed (for example, RHEL4_64).

Synopsis
axion_install [--checks] [--client_only] [--cversion=VERSION]
[--debug] [--extract] [--force] [--help] [--idir=PATH] [--install]
[--log] [--logdir=PATH] [--logfile=PATH/FILE] [--logname=FILE]
[--nodeps] [--nodetype=TYPE] [--nodownloads] [--noenable]
[--noprompting] [--nosupport] [--quiet] [--remove_all]
[--sdir=PATH][--server_only] [--show] [--timeout=SEC] [--uninstall]
[--upgrade] [--verbose] [--version=VERSION]

216 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Options
The following options are available for the axion_install command.

Table 149 Command options for the axion_install command (page 1 of 2)

Option Description

--checks If supplied, checks for certain processes and RPMs already installed.
This flag is on by default.

--client_only If supplied, a client-only server upgrade is performed (that is, only the
contents of the client release tarball are installed). A client tarball must
exist in the source directory specified or the default directory.

--cversion=VERSION Specifies the client VERSION to use.

--debug If supplied, shows what axion_install would do without performing the

commands.

--extract If supplied, extracts the contents of any tarballs present in the source
directory specified or the default directory. This is the default setting.

--force If supplied, forces install of all RPMs. This is the not the default setting.

--help Shows full online help (options and full descriptions), then exits.

--idir=PATH Specifies the full PATH to the installation directory. The default directory
is /usr/local/avamar/src.

--install If supplied, installs all required Avamar RPMs for the specified node
type. This is the default setting.

--log Enables logging. This is the default setting.

--logdir=PATH Specifies only the full PATH of the log file (without filename).

--logfile=PATH/FILE Specifies both the full PATH and FILE name of the log file.

--logname=FILE Only specifies the log FILE name (without a path).

--nodeps If supplied, installs all RPMs, ignoring any dependencies.

--nodetype=TYPE If supplied, override automatic node type detection

{$INSTALLDIR/node.cfg} and specify node TYPE. Valid types are:
• a—Accelerator node
• c—CAT server (obsolete)
• e—Single-node server
• ma—MCS node (obsolete)
• md—Storage node
• ms—Services node (obsolete)
• s—Axion-s server (obsolete)
• sp—Spare node
• u—Utility node

--nodownloads If supplied, does not install or uninstall dpnwebdoc or

dpnwebdownloads RPMs.

--noenable If supplied, does not enable unattended shutdown and restart on a

single-node server.
The default setting is --enable.

--noprompting If supplied, suppresses all interactive prompts.

--nosupport If supplied, does not uninstall, install or update support RPMs.

axion_install 217
EMC CONFIDENTIAL
Command Reference

Table 149 Command options for the axion_install command (page 2 of 2)

Option Description

--quiet Runs quietly (suppresses interactive prompts and status messages).

--remove_all If supplied, uninstall all RPMs including all client download RPMs. This
is the default setting.

--sdir=PATH Specifies the full PATH of the source directory. The default setting is
/usr/local/avamar/src.

--server_only If supplied, only the contents of the server release tarball are installed.

--show If supplied, shows which commands are being run by axion_install.

--timeout=SEC Specifies the timeout length in seconds (SEC) for Avamar services
running checks.

--uninstall If supplied, uninstalls any previously installed Avamar RPMs.

--upgrade If supplied, upgrades all RPMs.

--verbose If supplied, shows maximum information. This adds a --verbose option

to each command invoked under axion_install.

--version=VERSION Specifies the release tarball VERSION to use.

Environment variables
The axion_install command uses the following environment variables.

Table 150 Environment variables used by the axion_install command

Environment variable Description

$INSTALLDIR Installation directory for extraction of Avamar release tarball(s). The

default setting is /usr/local/avamar/src.

$SOURCEDIR Source directory for Avamar release tarball(s). The default setting is
/usr/local/avamar/src.

Notes
On upgrades and new installs, use of avw_install and avqinstall is subject to the following
conditions:
◆ A unified tarball is present in the correct install directory and no client tarball is
present.
◆ Both a current server tarball and a client tarball are present in the install directory.
◆ A unified tarball and a client tarball that is a later release and specifically needed to
replace the client RPMs in the unified tarball are present in the install directory.

218 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

axionfs
The axionfs command is a system service that implements the Avamar File System (AvFS).
The axionfs command is not intended to be run directly from the command line. To
configure and control the Avamar virtual file system feature on the Avamar server, use
dpnctl.

Synopsis
axionfs [--account=LOCATION] [--avamarmetadata={TRUE | FALSE}]
[--avamarmetafile | --noavamarmetafile] [--backstats]
[--cachestats] [--comstats] [--dateoption={0 | 1 | 2}] [--deltamode]
[--flagfile=FILE] [--fuseoptions="OPTIONS-LIST"] [--help]
[--id=USER@AUTH] [--largeprefetch=NUM-BUFS] [--latestonly]
[--logfile=FILE] [--mountpoint=PATH] [--password=PASSWORD]
[--quiet] [--server=AVAMARSERVER] [--singlethreaded]
[--smallprefetch=NUM-FILES] [--usage]
[{--verbose | -v | --verbose=2 | -vv}] [--version]

Options
The following options are available for the axionfs command.

Table 151 Command options for the axionfs command (page 1 of 3)

Option Description

--account=LOCATION Specifies a hierarchical LOCATION on the Avamar server.

This option is relative to the current home location, unless
a slash (/) is used as a prefix to the path designation, in
which case an absolute path is assumed.

--avamarmetadata= Used to enable (true) or disable (false) extended file

{TRUE | FALSE} system metadata, which can be used by the avacl program
to restore file system metadata from tape backups. The
default setting is true.

--avamarmetafile | Controls the format in which file system metadata is

--noavamarmetafile rendered in the Avamar File System (AvFS).
Supplying --avamarmetafile stores file system metadata in
.avamarmetafile files. This is the preferred behavior and is
the default setting.
Supplying --noavamarmetafile stores file system metadata
in .avamarmetadata subdirectories. This is the pre-4.1
behavior, which has been deprecated due to slow
performance.
This option added in version 4.1.

--backstats Causes performance and network transfer statistics to be

printed on axionfs unmount.

--cachestats Displays objcache stats every second.

--comstats Enables communication statistics every second.

axionfs 219
EMC CONFIDENTIAL
Command Reference

Table 151 Command options for the axionfs command (page 2 of 3)

Option Description

--dateoption={0 | 1 | 2} Renders by-date directory contents in one of the following

date/time formats:
• 0—Renders by-date directory contents in
YYYYMMDD_HHMMSS-UTC format. This is the default
setting.
• 1—Renders by-date directory contents in
YYYYMMDD_HHMMSS-TZ format where the time is the
local time and TZ is the local timezone (for example,
PDT).
• 2—Renders by-date directory contents in
YYYYMMDD_HHMMSS format where the time is in the
local time and the implicit timezone is the local
timezone.
For all these date/time formats: YYYY is a four-digit
calendar year, MM is a two-digit calendar month, DD is a
two-digit calendar date and HHMMSS is a six-digit time
stamp.

--deltamode Causes the contents of backups after the oldest for each
account to contain only the changed or new files and
directories; essentially an incremental update view.

--flagfile=FILE Specifies the FILE containing a list of options and values

that are processed by this program as if they were included
on the command line. The default setting is
/usr/local/avamar/etc/usersettings.cfg.

--fuseoptions="OPTIONS-LIST" OPTIONS-LIST is a space-delimited list, comprising of any

of the following options:
• -d—Debug mode (implies -f).
• -f—Remain in the foreground.
• -s—Single-threaded in the fuse layer.

Note: The top-level axionfs --singlethreaded option is

somewhat redundant, but operates at a different level.

• -o—Comma-separated list comprising any of the

following file system options:
allow_other—Allow system users other than the user
mounting the file system to have access.
hard_remove—If unlink() is called while a file is open,
remove that file immediately.
large_read—Issue larger than 4Kb reads (only valid on
2.4.x kernels).
use_ino—Accept the inode numbers that axionfs code
assigns in getdir or stat.
The -o options list must be supplied after -d, -f, or -s
options. For example: --fuseoptions="-s -f -o
allow_other,use_ino"

--help Shows full online help (options and full descriptions), then
exits.

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the
authentication system used by that user. The default
internal authentication domain is “avamar.”
For example: jdoe@avamar.

220 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 151 Command options for the axionfs command (page 3 of 3)

Option Description

--largeprefetch=NUM-BUFS This controls the number of 256 KB buffers (NUM-BUFS)

that are automatically pre-fetched when reading large files.
The default setting is 8, yielding up to 8*256=2 MB of
read-ahead. Setting this option to 0 disables the large file
read-ahead cache.

--latestonly Presents only the latest backup for the user whose
credentials are being used under the mount point, rather
than creating the full hierarchy of domains, clients and
backups.

--mountpoint=PATH Specifies the path to the (empty) directory that is used as

the mount point for the file system.

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

--quiet Suppresses logging messages.

--server=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as

defined in DNS).

--singlethreaded Wraps all axionfs callbacks with a mutex. This is not the
default setting.

--smallprefetch=NUM-FILES This controls the number of small (<32KB) files

(NUM-FILES) that are immediately pre-fetched when a
directory is read. The default setting is 1024 files. Setting
this option to 0 disables the small file pre-fetch cache.
When AvFS is used predominantly for interactive use,
rather than as a file export mechanism, use
--smallprefetch=0 to improve interactive response time.

--usage Shows abbreviated online help (options only, no

descriptions), then exits.

--verbose | -v Supplying either --verbose or -v enables all messages

--verbose=2 | -vv (status and warnings).
Supplying either --verbose=2 or -vv enables highly verbose
messages including the avtar session ID and mount point
information for each backup.
Additional levels of verbosity can also be specified with
--verbose=N, where N is the desired level of verbosity.

--version Shows version, then exits.

Notes
The --avamarmetadata and --avamarmetafile options are typically defined in the
/usr/local/avamar/var/axionfs.cmd configuration file.

axionfs 221
EMC CONFIDENTIAL
Command Reference

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 152 Avamar-only advanced command options for the axionfs command

Option Description

--fakeattr Use dummy implementation of getattr callback for testing.

--fakedir Use dummy implementation of getdir callback for testing.

--fakeread Use dummy implementation of read callback for testing.

backendreport
The backendreport command runs a backend capacity report. Each report can be
configured to report on the entire Avamar server, specific Avamar domains, or specific
Avamar clients

Synopsis
backendreport [--exclude=PATTERN] [--include=PATTERN] [--verbose]

Options
The following options are available for the backendreport command.

Table 153 Command options for the backendreport command

Option Description

--exclude=PATTERN Excludes clients that match a specific PATTERN in the report, where
PATTERN is any of the following:
• Domain path (for example, exclude all clients in/clients/MyDomain).
• Client (for example, exclude /clients/MyDomain/MyClient).
• Partial character string, which will be greedily matched (for example,
/clients/vm will match any client in the /clients domain that has ‘vm’
any place in the client name).

--include=PATTERN Includes clients that match a specific PATTERN in the report, where
PATTERN is any of the following:
• Domain path (for example, include all clients in/clients/MyDomain).
• Client (for example, include /clients/MyDomain/MyClient).
• Partial character string, which will be greedily matched (for example,
/clients/vm will match any client in the /clients domain that has ‘vm’
any place in the client name).

--verbose Provides maximum information by listing each backup included in the

report.

222 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Notes
You cannot run more than one backend capacity report at a time.
Running a backend capacity report is resource intensive. Avoid running a backend
capacity report when backup or maintenance activities are in progress, or are scheduled
to occur.
Backend capacity reports cannot include Data Domain system data. If you run a backend
capacity report that includes any clients with backups stored on a Data Domain system,
the report will fail.

Examples
The following command runs a backend capacity report on the entire Avamar server (all
domains):
backendreport

Information similar to the following appears in the command shell:

bytessent="1538144256"
==================== Finished backendreport ====================

The bytessent value is the amount of backend capacity in bytes used by the entire server.
The following command runs a backend capacity report on a specific domain:
backendreport --include=/MyDomain

where MyDomain is the specific domain you want to include in this report.
Information similar to the following appears in the command shell:
bytessent="87356416"
==================== Finished backendreport ====================

The bytessent value is the amount of backend capacity in bytes used by all clients in the
/MyDomain domain.
The following command runs a backend capacity report on a specific client:
backendreport --include=/MyDomain/MyClient

where MyDomain/MyClient is the path to the client you want to include in this report.
Information similar to the following appears in the command shell:
bytessent="163564"
==================== Finished backendreport ====================

The bytessent value is the amount of backend capacity in bytes used by MyClient.

backendreport 223
EMC CONFIDENTIAL
Command Reference

The following command runs a backend capacity report in which a character string is used
to match all clients in a domain with those characters anywhere in the client name:
backendreport --include=/MyDomain/vm

where /MyDomain is a domain in which only clients with ‘vm’ in the host name will be
included in the report.
Information similar to the following appears in the command shell:
bytessent="278059"
==================== Finished backendreport ====================

The bytessent value is the amount of backend capacity in bytes used by all clients in the
/MyDomain domain that have “vm” anywhere in the client name.

backup_upgrade_files
The backup_upgrade_files command backs up critical Avamar configuration files so that
site-specific customizations can be saved during system upgrades.

Synopsis
backup_upgrade_files [--diffdir=TMP-DIR] [--dir=PATH] [--help]
[--verbose]

Options
The following options are available for the backup_upgrade_files command.

Table 154 Command options for the backup_upgrade_files command

Option Description

--diffdir=TMP-DIR Compares currently active Avamar configuration files with corresponding

files in a temporary directory (TMP-DIR) and reports whether there are any
differences.
Specific differences within files are not reported, just whether the files
differ.

--dir=PATH Specifies the logfile PATH.

--help Shows help, then exits.

--verbose Provides full information.

Notes
The backup_upgrade_files command backs up the following files:
◆ /data01/home/admin/.avamar
◆ /etc/hosts
◆ /etc/ldap.conf*
◆ /etc/nsswitch.conf
◆ /etc/ntp.conf
◆ /etc/pam.d/lm*
◆ /etc/pam.d/login
◆ /etc/pam.d/system-auth
◆ /etc/resolv.conf

224 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

◆ /etc/sysconfig/network
◆ /etc/sysconfig/network-scripts/ifcfg-eth0
◆ /etc/yp.conf
◆ /usr/local/avamar/bin/cp_cron
◆ /usr/local/avamar/bin/evening_cron_run
◆ /usr/local/avamar/bin/gc_cron
◆ /usr/local/avamar/bin/hfscheck_cron
◆ /usr/local/avamar/bin/morning_cron_run
◆ /usr/local/avamar/etc/domains.cfg
◆ /usr/local/avamar/etc/repl_cron.cfg
◆ /usr/local/avamar/etc/usersettings.cfg
◆ /usr/local/avamar/var/mc/server_data/adminlogpattern.xml
◆ /usr/local/avamar/var/mc/server_data/prefs/mcserver.xml
◆ /usr/local/avamar/var/probe.xml
◆ /usr/share/snmp/snmpd.conf

Examples
The following command compares currently active configuration files with corresponding
files in /tmp/backup_files and reports verbosely whether there are any differences:
backup_upgrade_files --diffdir=/tmp/backup_files --verbose

backup_upgrade_files 225
EMC CONFIDENTIAL
Command Reference

btfix
The btfix program prepares Avamar server logfiles for use by EMC Customer Support by
changing memory offset messages into human readable output.

Synopsis
btfix -INPUTFILE > OUTPUTFILE

Notes
Consider the following notes for the btfix program:
◆ Do not use the which gsan command when running btfix.
◆ Always use the gsan binary from the running node.
◆ When running btfix against avtar, use avtar.bin as the binary.
◆ Ensure that you are using the correct binary version. Be mindful of patches to binaries
that might not return the correct version information.
◆ Provide context around the btfix. Fifty lines before and 50 lines after the “FATAL” is a
good rule of thumb.
◆ If the crash was a cgsan crash, be sure to run btfix against the cgsan binary.
◆ If the gsan.log file does not provide information about backtraces, look in the gsan.out
file in /home/admin.

Example
The following example describes how to prepare gsan logfiles for analysis:
1. Copy both the gsan binary and the gsan logfiles from the Avamar server you are
troubleshooting into a temporary directory.
2. Open a command shell and log in as user admin.
3. Run btfix by typing:
btfix -./gsan gsan.log > btfix.out

Information similar to the following appears in the command shell:

mkdir ~admin/btfix
cd ~admin/btfix
scn 0.0:/data01/cur/gsan.log ./
scn 0.0:/home/admin/gsan ./
btfix -./gsan gsan.log > btfix.out

226 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

capacity.sh
The capacity.sh shell script generates a capacity utilization report listing the amount of
Avamar server data that is added and freed each day.

Synopsis
capacity.sh [--client=CLIENT-NAME] [--days=NUM] [--domain=DOMAIN-NAME]

Options
The following options are available for the capacity.sh command.

Table 155 Command options for the capacity.sh shell script

Option Description

--client=CLIENT-NAME Limits scope of report to this CLIENT-NAME only. In this context, report
output changes to show dataset used for each backup.

--days=NUM Limits scope of report to only include the specified number (NUM) of
days. The default setting is 30 days.

--domain=DOMAIN-NAME Limits scope of report to this DOMAIN-NAME only.

Notes
This command added in version 4.1.

Example
The following command lists capacity utilization for the past 10 days:
capacity.sh --days=10
Date New Data #BU Removed #GC Net Change
---------- ---------- ----- ---------- ----- ----------
2013-10-06 1364 mb 7 0 mb 1 1364 mb
2013-10-07 2827 mb 7 0 mb 1 2827 mb
2013-10-08 60186 mb 7 0 mb 1 60186 mb
2013-10-09 60187 mb 7 0 mb 1 60187 mb
2013-10-10 60187 mb 7 0 mb 1 60187 mb
2013-10-11 60196 mb 7 0 mb 1 60196 mb
2013-10-12 60187 mb 7 0 mb 1 60187 mb
2013-10-13 60187 mb 7 0 mb 1 60187 mb
2013-10-14 60187 mb 7 -46801 mb 2 13385 mb
2013-10-15 60189 mb 7 -99541 mb 1 -39351 mb
---------- ---------- ----- ---------- ----- ----------
Average 48570 mb -14634 mb 136.4 mb

Top 3 High Change Clients:

--------------------------
awk: cmd. line:2: warning: escape sequence `\%' treated as plain `%'
Total for all clients 1062500 mb 100.0%
MyServer-1 159818 mb 15.0%
MyServer-2 154664 mb 14.6%
MyServer-3 154650 mb 14.6%

capacity.sh 227
EMC CONFIDENTIAL
Command Reference

The New Data column lists the amount of data in MB that has been added to the Avamar
server on a daily basis. The #BU column shows the number of backups or replications that
occurred each day.
The Removed column lists the amount of data in MB that garbage collection recovered.
The #GC column shows the number times garbage collection ran each day.
The Net Change column lists the amount of data in MB that were added or freed each day.
Finally, a summary at the end of the report lists the three highest change rate clients for
the time period of this report.

change-passwords
The change-passwords command assists system administrators with changing operating
user account passwords and Avamar server user account passwords, as well as generating
and propagating new OpenSSH keys.
The change-passwords program interactively prompts and guides you through the
following operations:
◆ Changing operating system login passwords for the admin, dpn, and root accounts.
◆ Creating new admin and dpnid OpenSSH keys.
◆ Changing internal Avamar server passwords for the root and MCUser accounts.

Synopsis
change-passwords [--debug] [--help] [--probedir=PATH] [--verbose]

Options
The following options are available for the change-passwords command.

Table 156 Command options for the change-passwords command

Option Description

--debug Enables debug mode, which shows messages programmers can use to
debug program execution.

--help Shows help, then exits.

--probedir=PATH Specifies the PATH to the directory that contains a legacy probe.out file.

--verbose Provides maximum information.

Notes
Consider the following notes for the change-passwords command:
◆ The change-passwords command should be run as user dpn because the dpn user
account inherently retains old SSH keys (for example, the original factory SSH dpnid
key), which might be required to change keys when new nodes are added to
multi-node servers.

228 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

◆ The change-passwords program verifies whether you are running as dpn and issues a
warning if you are not. However, it is possible to run change-passwords as user
admin, provided that the correct keys are available.
◆ It is not necessary to pre-load any SSH keys before running change-passwords.
◆ The change-passwords program disallows quote marks and other shell
metacharacters in passwords.
◆ The change-passwords program presently does not remind users to update the
repl_cron.cfg file on replication sources when passwords are changed on a replication
target.
◆ The change-passwords program fails if the current working directory is not readable.
The work-around is to use su - dpn instead of su dpn if one is starting out as the root
user.
◆ The change-passwords program fails when OpenSSH refuses to proceed because a
host key has changed, causing OpenSSH to suspect a man-in-the-middle attack. The
remedy is to update or to remove ~dpn/.ssh/known_hosts when a node is changed
out “in place” (the node's hostname and IP address are the same as before, but the
node has a new host key, either because the node is a new replacement or (less likely)
because someone re-initialized the host key).

Troubleshooting information
If change-passwords fails, examine /usr/local/avamar/var/change-passwords.log for
detailed information regarding any issues or problems reported in the final
change-passwords interactive messages.
For example, on some older nodes, ownership of /usr/local/avamar/etc/ might be
root:root. This causes change-passwords to exit with an error because it cannot create a
backup of the usersettings.cfg file. The reason change-passwords exited would only be
apparent by examining the change-passwords.log file.

change-passwords 229
EMC CONFIDENTIAL
Command Reference

change_nodetype
The change_nodetype program configures a new node to function as a specific node type
in an Avamar server.

Synopsis
change_nodetype {--accelerator | --access | --axion-e | --data |
--spare | --utility} [--dhcp] [--legacy] [--networking] [--system]
[--verbose]

Node type designators

Supply only one of the following node type designators with each change_nodetype
command.

Table 157 Node type designators for the change_nodetype command

Designator Node type

--accelerator Avamar NDMP Accelerator

--access Access node

--axion-e Single node server

--data Storage node

--spare Spare node

--utility Utility node

Options
The following options are available for the change_nodetype command.

Table 158 Command options for the change_nodetype command

Option Description

--dhcp Configures storage nodes to use DHCP.

If supplied with the --data node type and the --legacy option, all network files are
modified in such a manner as to prevent create_newconfigs from running.
Instead, the node is configured to use DHCP, which is required when data nodes
are added to older Avamar servers.

--legacy Modifies network files in a format that is supported by create_newconfigs.

--networking Configures the node with networking services.

--system Configures and enables all necessary system services, such as dhcpd, nfs, http,
and so forth.

--verbose Provides maximum information.

230 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the change_nodetype program:
◆ The change_nodetype program resides in the /usr/local/avamar/src directory and
should be run from that location.
◆ Use --dhcp and --legacy only if directed to do so by EMC Customer Support.

check.dpn
The check.dpn command performs system integrity checks. It can be run directly and is
also called by start.dpn.
The actual checks are performed by executing “run instruction files” located in these
directories:
◆ check.dpn.d/cron/5min (--checks=cron/5min)
◆ check.dpn.d/cron/10min (--checks=cron/10min)
◆ check.dpn.d/inventory (--inventory)
◆ check.dpn.d/monitor (--monitor)
◆ check.dpn.d/preinstall (--preinstall)
◆ check.dpn.d/postinstall (--postinstall)
These directories do not contain the actual check scripts; these directories contain run
instruction files. The actual scripts reside in /usr/local/avamar/bin/check.dpn.d/init.d.

Synopsis
check.dpn [--checks=DIR,...] [--debug] [--exclude=CHECK,...]
[--inventory] [--mail] [--monitor] [--nodedb=FILE] [--postinstall]
[--preinstall] [--quiet] [--results=DIR] [--select=CHECK,...]
[--verbose]

Options
The following options are available for the check.dpn command.

Table 159 Command options for the check.dpn command (page 1 of 2)

Option Description

--checks=DIR,... Executes run instruction files located in this directory (DIR). Use a
comma-separated list to define multiple directories.

--debug Enables debug mode, which shows messages programmers can use to
debug program execution.

--exclude=CHECK,... Explicitly excludes this CHECK from being run. Use a comma-separated
list to exclude multiple check scripts.

--inventory Performs inventory checks by running scripts based on instructions in

check.dpn.d/inventory.
Inventory checks return information about specific hardware and
software installed in the system.

--mail Emails information to the utility node admin user account.

Exact behavior is highly dependent on the individual checks being run.

check.dpn 231
EMC CONFIDENTIAL
Command Reference

Table 159 Command options for the check.dpn command (page 2 of 2)

Option Description

--monitor Performs monitoring checks by running scripts based on instructions in

check.dpn.d/monitor.
Monitoring checks return the status of system components.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--postinstall Performs post-installation checks by running scripts based on

instructions in check.dpn.d/postinstall.
Post-installation checks are generally performed after installing or
upgrading Avamar software to verify integrity of a deployed Avamar
server.

--preinstall Performs pre-installation checks by running scripts based on

instructions in check.dpn.d/preinstall.
Pre-installation checks are generally performed before installing or
upgrading Avamar software.

--quiet Disables all non-essential messages.

--results=DIR Specifies the directory (DIR) for the results file.

--select=CHECK,... Explicitly executes on those checks (CHECK) specified by this option

(excludes all other checks). Use a comma-separated list to define
multiple checks.
The --select option only works for checks that have corresponding R*
(run instruction) files. Without the R* file, check.dpn does not run the
check, even if a check by that name exists. This is because the R* file
contains vital information about how to run the test.

--verbose Provides maximum information.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 160 Deprecated command options for the check.dpn command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Notes
Consider the following notes for the check.dpn command:
◆ You must load either the dpnid or admin OpenSSH key before running this command.
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable typically stores the
path to a directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the
default probe.xml location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.

232 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Creating a new check script

Two files are required:
◆ A check script
◆ Run instructions for the script
Template files are supplied to help you with this.
1. Copy check.dpn.d/init.d/Template to the new script (for example, newcheck).
2. Edit newcheck to perform the desired checks.
3. Place the new script into check.dpn.d/init.d/newcheck.
4. Copy check.dpn.d/preinstall/Template to create a new run instruction filenamed
R{nnn}newcheck, where {nnn} is a sequence of digits (for example, 105).
This helps to control the script's placement in the lexicographic run order.
5. Edit the run instructions file (for example, R105newcheck) so as to indicate how and
on what types of nodes to run the new script.
6. Place the new run instructions file into check.dpn.d/{mode}, where {mode} is one of
the subdirectories preinstall/, postinstall/, monitor/, inventory/. You can instead
place the file into a user-defined directory that can be selected by way of the
--checks=DIR option (for example, check.dpn.d/cron).

Examples
The following command runs all preinstall checks:
check.dpn --preinstall

The following command runs only checkntp in preinstall mode:

check.dpn --preinstall --select=checkntp

The following command runs status checks defined in the cron/5min subdirectory:
check.dpn --checks=cron/5min

check.dpn 233
EMC CONFIDENTIAL
Command Reference

check.mcs
The check.mcs command performs integrity checks on the MCS. It can be run directly and
is called by mcserver.sh when the --check or --init options are supplied.
The check.mcs command must be run from the utility node in multi-node Avamar systems.

Synopsis
check.mcs {--poststart | --preavsetup | --preinit | --prestart |
--testserver} [--verbose]

Commands
Supply one and only one of the following commands on each command line for the
check.mcs command.

Table 161 Commands for the check.mcs command

Command Description

--poststart Tests a running MCS.

--preavsetup Tests utility node setup and software installs.

--preinit Tests readiness to initialize the MCS.

--prestart Tests readiness to start the MCS.

--testserver Tests the MCS response time.

--testaxionserver Tests the Avamar server response time.

Options
The following option is available for the check.mcs command.

Table 162 Command options for the check.mcs command

Option Description

--verbose Provides maximum information.

checklib.pm
The checklib.pm file is a Perl module used by mcsmon_run, monmcs, and pingmcs.

234 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

clean_db.pl
The clean_db.pl command is a Perl script that removes old data from the MCS and Avamar
Enterprise Manager server databases, mcdb and emdb, respectively. Periodic removal of
old data or "pruning" is an essential practice for ensuring adequate database
performance.
The clean_db.pl program is typically run as a cron job. The start time is controlled by the
/usr/local/avamar/var/em/server_data/prefs/emserver.xml clean_db_start preference.
However, clean_db.pl can also be run directy from the command line.
Parameters for clean_db.pl are set in emserver.xml and mcserver.xml. Edit those files to
change the default parameters, or use command line options to temporarily override the
parameters.

Processing behavior and default settings

MCS and Avamar Enterprise Manager server database tables are processed by the
clean_db.pl program according to conditions in the following table.

Table 163 Processing behavior for database tables

Database table Processing behavior

activities Processed if the current timestamp is greater than the numerical sum of the
database completed_ts column value and the clean_db_activities_days
mcserver.xml preference value, and if activity expires (expiration value is non
zero) and if the current time in epoch seconds is greater than the database
expiration column value.

activity_errors Processed if the database cid, pid_number and session_id column values do
not match the corresponding entries in the activites table.

audits Processed if the current timestamp is greater than the numerical sum of the
database date_time column value and the clean_db_audits_days mcserver.xml
preference setting.

events Processed if the current timestamp is greater than the numerical sum of the
database date_time column value and the clean_db_events_days mcserver.xml
preference setting.

sv_node_space Processed if the current timestamp is greater than the numerical sum of the
database date_time column value and the clean_db_sv_node_space_days
mcserver.xml preference setting.

sv_node_util Processed if the current timestamp is greater than the numerical sum of the
database date_time column value and the clean_db_sv_node_util_days
mcserver.xml preference setting.

The default setting for all previously mentioned mcserver.xml preference settings is 365
days (1 year).

Synopsis
clean_db.pl [--activities=DAYS]
[--activitiesfrom=DATE --activitiesto=DATE] [--audits=DAYS]
[--events=DAYS] [--nodespace=DAYS] [--nodeutil=DAYS]

clean_db.pl 235
EMC CONFIDENTIAL
Command Reference

Options
Supplying any of the following options for clean_db.pl overrides the default parameters
defined by emserver.xml and mcserver.xml.

Table 164 Command options for the clean_db.pl Perl script (page 1 of 2)

Option Description

--activities=DAYS Specifies the maximum number of DAYS of activities table

entries to retain (that is, clean_db.pl removes any entries
older than this number of DAYS). Overrides mcserver.xml
clean_db_activities_days preference.

--activitiesfrom=DATE Specifies a DATE range of activities table entries to retain

--activitiesto=DATE (that is, clean_db.pl removes any entries outside of this
date range).
These options added in version 6.0.

--activitiesrecords=RECORDS Specifies the maximum number of activities table

RECORDS that are retained when pruning. Overrides the
clean_db_activities_records preference in mcserver.xml.
This element added in version 6.1.

--audits=DAYS Specifies the maximum number of DAYS of audits table

entries to retain (that is, clean_db.pl removes any entries
older than this number of DAYS). Overrides mcserver.xml
clean_db_audits_days preference.

--auditsrecords=RECORDS Specifies the maximum number of audit table RECORDS

that are retained when pruning. Overrides the
clean_db_audits_records preference in mcserver.xml.
This element added in version 6.1.

--cmop=DAYS Specifies the maximum number of DAYS of

cm_operation_log table entries to retain (that is,
clean_db.pl removes any entries older than this number of
DAYS). Overrides the clean_emdb_cm_operation_log_days
preference in emserver.xml.
This element added in version 6.1.

--cmopsrecords=RECORDS Specifies the maximum number of cm_operation_log table

RECORDS that are retained when pruning. Overrides the
clean_emdb_cm_operation_log_days preference in
emserver.xml.
This element added in version 6.1.

--cmqueue=DAYS Specifies the maximum number of DAYS of cm_queue_info

table entries to retain (that is, clean_db.pl removes any
entries older than this number of DAYS). Overrides the
clean_emdb_cm_queue_info_days preference in
emserver.xml.
This element added in version 6.1.

--cmqueuerecords=RECORDS Specifies the maximum number of cm_queue_info table

RECORDS that are retained when pruning. Overrides the
clean_emdb_cm_queue_info_days preference in
emserver.xml.
This element added in version 6.1.

--ddrnodespacerecords=RECORDS Specifies the maximum number of ddr_node_space table

RECORDS that are retained when pruning. Overrides the
clean_db_ddr_node_space_records preference in
mcserver.xml.
This element added in version 6.1.

236 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 164 Command options for the clean_db.pl Perl script (page 2 of 2)

Option Description

--ddrrecords=RECORDS Specifies the maximum number of ddr_info table RECORDS

that are retained when pruning. Overrides the
clean_emdb_ddr_info_records preference in
emserver.xml.
This element added in version 6.1.

--dpnrecords=RECORDS Specifies the maximum number of dpn_info table

RECORDS that are retained when pruning. Overrides the
clean_emdb_dpn_info_records preference in
emserver.xml.
This element added in version 6.1.

--events=DAYS Specifies the maximum number of DAYS of events table

entries to retain (that is, clean_db.pl removes any entries
older than this number of DAYS). Overrides mcserver.xml
clean_db_events_days preference.

--eventsrecords=RECORDS Specifies the maximum number of events table RECORDS

that are retained when pruning. Overrides the
clean_db_events_records preference in mcserver.xml.
This element added in version 6.1.

--nodespace=DAYS Specifies the maximum number of DAYS of sv_node_space

table entries to retain (that is, clean_db.pl removes any
entries older than this number of DAYS). Overrides the
clean_db_sv_node_space_days preference in
mcserver.xml.

--nodespacerecords=RECORDS Specifies the maximum number of sv_node_space table

RECORDS that are retained when pruning. Overrides the
clean_db_sv_node_space_records preference in
mcserver.xml.
This element added in version 6.1.

--nodeutil=DAYS Specifies the maximum number of DAYS of sv_node_util

table entries to retain (that is, clean_db.pl removes any
entries older than this number of DAYS). Overrides the
clean_db_sv_node_util_days preference in mcserver.xml.

--nodeutilrecords=RECORDS Specifies the maximum number of sv_node_util table

RECORDS that are retained when pruning. Overrides the
clean_db_sv_node_util_records preference in
mcserver.xml.
This element added in version 6.1.

Notes
This command added in version 3.7.1. Additional parameters and command line
arguments added in versions 6 and 6.1.

Pruning logic
A RECORDS parameter for a table (for example, clean_db_events_records), in either a
settings file or on the command line, overrides the table’s DAYS parameter (for example,
clean_db_events_days). Records are first pruned according to the DAYS parameter. If the
remaining records exceed the number specified by RECORDS, the records are reduced to
that number by pruning the oldest records first.

clean_db.pl 237
EMC CONFIDENTIAL
Command Reference

Examples
The following command prunes all the database tables with the default parameters except
for the events table, which is pruned using 1 day as a value:
clean_db.pl --events=1

clean.dpn
The clean.dpn command completely removes all customer data from all /data??/cur.* or
/data??/hfscheck* directories.
The clean.dpn --cur command is destructive and removes customer data from the system.
Do not run this command unless instructed to do so by EMC Customer Support.

Synopsis
clean.dpn [--checkpoints={all | CP-ID,CP-ID,...}] [--cur] [--hfscheck]
[--nodes=NODE-LIST] [--norollback] [--verbose]

Options
The following options are available for the clean.dpn command.

Table 165 Command options for the clean.dpn command

Option Description

--checkpoints= Completely removes one or more specified checkpoints (CP-IDs) or

{all | CP-ID,CP-ID,...} all checkpoints.
This option added in version 4.1.

--cur Completely removes all customer data from all /data??/cur.*

directories.

--hfscheck Completely removes all customer data from all /data??/hfscheck.*

directories.

--nodes=NODE-LIST Specifies which nodes to clean. If not supplied, all nodes are
cleaned.
Requires physical MODULE.NODE designations as defined in the
probe.xml file.

--norollback Does not remove certain temporary files that might remain
following a server rollback.

--verbose Provides maximum information.

238 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

convert-probe
The convert-probe command converts a legacy probe.out file to an XML format. The new
file is named probe.xml.

Synopsis
convert-probe [--debug] [--help] [--in=PATH] [--out=PATH] [--verbose]

Options
The following options are available for the convert-probe command.

Table 166 Command options for the convert-probe command

Option Description

--debug Enables debug mode, which shows messages programmers can use to debug
program execution.
The default setting is --nodebug.

--help Shows help, then exits.

--in=PATH Specifies an alternative PATH to the legacy proble.out file.

The default location is /usr/local/avamar/var.

--out=PATH Specifies an alternative PATH to the probe.xml file.

The default location is /usr/local/avamar/var.

--verbose Displays the results of the conversion.

The default setting is --noverbose.

Notes
Consider the following notes for the convert-probe command:
◆ The convert-probe --in=PATH command reads the probe.out file from stdin.
◆ The convert-probe --out=PATH command writes the node resource database to stdout.
The --verbose option has no effect in this case.

convert-probe 239
EMC CONFIDENTIAL
Command Reference

copy-ata-drive
The copy-ata-drive command makes a copy of an ATA drive containing Linux ext2 or ext3
filesystems to another ATA drive.
By default, the copy-ata-drive program makes a bootable backup copy of the main system
disk (drive hda) onto drive hde.
In Avamar nodes with part numbers 32021003-01 and 32021003-02, the physical drive
locations are:
◆ hda is in drive slot 4 (the far right drive slot)
◆ hde is in drive slot 2 (the middle left drive slot)
◆ hdg is drive slot 1 (the far left drive slot)

Synopsis
copy-ata-drive [--bios=8x] [--boot=m] [--debug] [--dst=hdY] [--help]
[--inplace] [--liloconfig=FILE] [--noactivate] [--nocheck]
[--root=n] [--src=hdX] [--verbose]

Options
The following options are available for the copy-ata-drive command.

Table 167 Command options for the copy-ata-drive command

Option Description

--bios=8x Specifies the BIOS device ID for boot.

--boot=m Specifies the boot partition number. The default setting is 1.

--debug Shows example session information but does not perform the specified
actions.

--dst=hdY Specifies the destination hard drive (hdY). The default setting is hde.

--help Shows help, then exits.

--inplace Sets up to boot in place (do not boot as source device).

--liloconfig=FILE Specifies the lilo configuration FILE for destination hard drive.

--noactivate Does not run lilo on destination drive.

--nocheck Does not perform source check or destination read-only bad block check.

--root=n Specifies the boot partition number. The default setting is 5.

--src=hdX Specifies the source hard drive (hdX). The default setting is hda.

--verbose Provides maximum information.

Notes
Consider the following notes for the copy-ata-drive command:
◆ The copy-ata-drive command must not be run on a storage node under any
circumstances. The reason for this that there are typically no spare drives on a storage
node. Therefore, doing so adversely affects data stored on the server. There is
currently no safeguard to prevent you from running copy-ata-drive on a storage node.

240 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

◆ Apart from --debug and --verbose, the only option normally used is --dst, which
specifies an alternative destination drive.
◆ The behavior of the backup system drive is different from the original in exactly one
way: all hard drives apart from hda are commented out in the backup system drive's
/etc/fstab, and therefore are not mounted by default when booting on the backup
system drive. Additionally, over time the contents of the backup system drive
naturally might diverge from those of the original.
◆ The copy-ata-drive program performs some integrity checking on the source drive
before committing the copy, primarily by doing test dumps of the data to /dev/null. An
amount of time proportional to the amount of data to be copied is allotted for read
and write operations. If these operations time out, then the copy operation is deemed
to have failed.
◆ The partitioning scheme of the original drive is preserved, although some partitions
might grow by up to 32 MB if some specialized error conditions are encountered while
creating new filesystems on the destination drive.
◆ The lilo configuration of the original drive is also preserved, except for some minor
modifications necessary to render the backup system drive bootable when the
backup is eventually placed into the primary system slot.
◆ When using copy-ata-drive from an interactive shell, the following interactive warning
prompt appears:
WARNING: This program will instantly destroy all
data on destination drive hde. Proceed?
y(es), n(o), q(uit/exit):

Answer y(es) to proceed with the copy operation.

◆ Use the following command to completely bypass the interactive warning prompt:
copy-ata-drive </dev/null

◆ With the 2.4.18-3 Linux kernel and possibly with other versions, an Amax 1U node
hangs during the boot process if either drive hda or hdc is not physically present. It is
acceptable for either hde or hdg not to be physically present. The Linux kernel hangs
while probing for drives on the motherboard's primary and secondary ATA channels.
Therefore, it is best to make copies of the system disk to hde or to hdg, rather than to
hdc.
◆ The --inplace option currently does not work on Amax 1U nodes because it is not
known how to make the BIOS boot directly and solely from a secondary drive.
Therefore, to make it possible for those nodes to boot on the backup system disk, you
must presently accept the default behavior, which requires physically moving the
backup system drive (hde by default) to the primary ATA slot (hda).

Examples
The following command copies hda to hde and makes hde bootable as hda:
copy-ata-drive

The following command copies hda to hdg and makes hdg bootable as hda:
copy-ata-drive --dst=hdg

copy-ata-drive 241
EMC CONFIDENTIAL
Command Reference

The following command copies hda to hdc and makes it bootable in place as hdc:
copy-ata-drive --dst=hdc --bios=0x81 --inplace

The following command copies hda to hdc and makes it bootable using a pre-defined lilo
configuration file, lilo.conf.hdc:
copy-ata-drive --dst=hdc --liloconfig=lilo.conf.hdc

copy-checkpoint
The copy-checkpoint command performs one-to-one copying of checkpoints between
identically configured multi-node servers.



Because this utility requires a legacy probe.out file, beginning with version 5.0, this
command has been deprecated.

Synopsis
copy-checkpoint --checkpoint=cp.YYYYMMDDHHMMSS [--debug] [--degree=N]
{[--destination=MODULE-1s[,MODULE-2s] | [--dprobedir=DIR]}
[--dryrun] [--fakenodes] [--help] [--key=FILE] [--nodes=NODELIST]
{[--source=MODULE-1s[,MODULE-2s | [--sprobedir=DIR]} [--verbose]

Options
The following options are available for the copy-checkpoint command.

Table 168 Command options for the copy-checkpoint command (page 1 of 2)

Option Description

--checkpoint= Specifies which checkpoint to copy, where

cp.YYYYMMDDHHMMSS[,...] cp.YYYYMMDDHHMMSS is a valid checkpoint ID.
Multiple checkpoints can be specified on the same command
line; separate multiple checkpoint IDs with a comma.
This option is required.

--debug Does not perform the actions.

--degree=N Specifies the degree of parallelism (# of nodes at once).

--destination= Specifies the destination Avamar server utility nodes, where

MODULE-1s[,MODULE-2s] MODULE-1s and MODULE-2s are the primary and secondary
utility node hostnames or IP addresses, respectively. This is used
to locate a valid probe.xml file.
Most multi-node Avamar servers are deployed in a single-module
configuration. Therefore, specification of a secondary utility node
is usually not required.

--dprobedir=DIR Specifies the directory (DIR) for existing destination Avamar

server probe.xml file.

--dryrun Runs auxiliary scripts in debug mode.

--fakenodes Uses false module information; implies --debug.

--help Shows help, then exits.

242 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 168 Command options for the copy-checkpoint command (page 2 of 2)

Option Description

--key=FILE Specifies the path to destination Avamar server OpenSSH dpnid

key FILE.

--nodes=NODELIST Copies only selected source nodes. The default setting is #.#.

--source= Specifies the source Avamar server utility nodes, where

MODULE-1s[,MODULE-2s] MODULE-1s and MODULE-2s are the primary and secondary
utility node hostnames or IP addresses, respectively. This is used
to locate a valid probe.xml file.
Most multi-node Avamar servers are deployed in a single-module
configuration. Therefore, specification of a secondary utility node
is usually not required.

--sprobedir=DIR Specifies the directory (DIR) for the existing source probe.xml file.

--verbose Provides maximum information.

Notes
Consider the following notes for the copy-checkpoint command:
◆ You must load the dpnid OpenSSH key before running this command.
◆ This command requires that source and destination Avamar server nodes have similar
data partitioning schemes (for example, both source and destination servers have
/data01 through /data04 partitions).

Examples
Although the following examples wrap to more than one line, you must enter all
commands and options on a single command line without any line feeds or returns.
The following example copies checkpoint cp.20130616081500 from the source Avamar
server to destination Avamar server specified using the --destination option:
copy-checkpoint --destination=avamar-1s,avamar-2s
--checkpoint=cp.20130616081500

This multi-line example copies checkpoint cp.20130616081500 from the source Avamar
server to destination Avamar server using existing stmp/probe.xml and dtmp/probe.xml
and to define the source and destination Avamar servers, respectively:
(cd stmp && export SYSPROBEDIR=. && probe dpn01 dpn02)
(cd dtmp && export SYSPROBEDIR=. && probe dpn03 dpn04)
copy-checkpoint --sp=stmp --dp=dtmp --checkpoint=cp.20130616081500

The following example copies checkpoint cp.20130616081500 from the source Avamar
server to destination Avamar server specified using the --destination option and also
specifies the path to the destination Avamar server OpenSSH dpnid key file:
copy-checkpoint --destination=avamar-1s,avamar-2s
--key=$HOME/.ssh/avamar-1-dpnid --checkpoint=cp.20130616081500

copy-checkpoint 243
EMC CONFIDENTIAL
Command Reference

cp_cron
The cp_cron command is primarily intended to be run as a cron job to perform a
checkpoint. However, cp_cron can also be run directly to create a list of valid checkpoints
in the system.



Beginning with version 5.0, this command has been deprecated in favor of avmaint
checkpoint.

Synopsis
cp_cron [--nodelete] [--nolist] [--waittime=SEC]

Options
The following options are available for the cp_cron command.

Table 169 Command options for the cp_cron command

Option Description

--nodelete If supplied, checkpoints are not deleted.

--nolist If supplied, new checkpoint IDs are not added to

/usr/local/avamar/var/checkpoints.xml.

--waittime=SEC Specifies the number of seconds (SEC) to wait for server to enter read-only
mode. If the server does not enter read-only mode within this period of time,
cp_cron terminates. The default setting is 300; minimum allowable setting is
30 seconds.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 170 Deprecated command options for the cp_cron command

Option Description

--keepmin This option added in version 4.0 and deprecated in version 5.0.
Enables the keep minimal checkpoints feature for this session.

Notes
You must run cp_cron as user dpn.

244 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

cplist
The cplist command takes the XML output of avmaint lscp and displays it in a more
readable form.

Synopsis
cplist [--checkpointsfile=PATH] [--flagfile=FILE] [--full]
[--hardcopy] [--help] [--helpx] [--helpxml] [--lscp]
[--memman=MODE] [--memmantrigger=MODE] [--nodes=NODE-LIST]
[--uflagsdebug] [--usage] [--version] [--xml] [--xmlperline=NUM]

Options
The following options are available for the cplist command.

Table 171 Command options for the cplist command (page 1 of 2)

Option Description

--checkpointsfile=PATH Save XML data to this file. The default setting is

/usr/local/avamar/var/checkpoints.xml.

--flagfile=FILE Specifies the FILE containing a list of options and values that are
processed by this program as if they were included on the command
line. The default setting is /usr/local/avamar/etc/usersettings.cfg.

--full If supplied, all valid checkpoints are displayed.

--hardcopy Save XML data to file.

--help Shows help, then exits.

--helpx Shows extended help, then exits.

--helpxml Shows help in XML format, then exits.

--lscp Invokes the avmaint lscp command to list available checkpoints.

When you use this option, the command compiles the information
with the running core storage server (gsan) program. If you do not
use the option, then the command runs a gsan program on each
node and compiles the information with the cplist program, which
typically takes longer than when you use the option.
If gsan is offline on a node and you run cplist both with the --lscp
option and without it, then the command results may be different
because cplist does not have access to the information on the node
where gsan is offline.

--memman=MODE EMC internal use only.

Memory debugging MODE.

--memmantrigger=MODE EMC internal use only.

Extra memory debugging MODE.

--nodes=NODE-LIST Specifies which nodes are affected.

Requires physical MODULE.NODE designations as defined in
probe.xml.

--uflagsdebug Specifies the flag parsing debug mode.

--usage Shows abbreviated online help (commands and options only, no

descriptions), then exits.

--version Shows version, then exits.

cplist 245
EMC CONFIDENTIAL
Command Reference

Table 171 Command options for the cplist command (page 2 of 2)

Option Description

--xml Formats the output of cplist --lscp in XML.

--xmlperline=NUM Controls number (NUM) of XML attributes per line.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 172 Deprecated command options for the cplist command

Option Description

--keepmin Deprecated in version 5.0.

--oldstyle Deprecated in version 5.0.

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Output
Output conforms to the following format:
CHECKPOINT DATE CHECKED VALIDITY CHECK TYPE DELETABLE NODES
REFCOUNT/NODECOUNT NUMNODES STRIPES NUMSTRIPES

For example:
cp.20130402185644 Mon Apr 2 11:56:44 2013 valid hfs del nodes 6/6
stripes 414

The following attributes appear in cplist output.

Table 173 Attributes for cplist output

Attribute Values

validity Either valid or invalid.

type One of the following:

• hfs—All checks on all stripes.
• rdc—Reduced checks.
• par—Partial set of checks or stripes.
• PERCENTAGE—A numerical percentage of checks complete.

REFCOUNT The number of nodes that responded to the lscp command for this checkpoint.
A full checkpoint can have a lower than expected REFCOUNT if the lscp
command occurred when a node was offline.

NODECOUNT The total number of online nodes that participated in the checkpoint. This can
be different than the number of nodes (offline and online) on the system. A
“minimal” checkpoint (that is, one with a node missing) always produces a
lower than expected REFCOUNT because the missing node (even if now online)
does not respond for the checkpoint in question.

del If the checkpoint can be deleted, it is indicated with del.

246 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Example
cplist
cp.20131116154531 Sun Nov 16 07:45:31 2013 valid hfs --- nodes 2/3 stripes 2013113013571
cp.20131117155032 Mon Nov 17 07:50:32 2013 valid --- --- nodes 2/3 stripes 13578
cp.20131117184533 Mon Nov 17 10:45:33 2013 valid rdc --- nodes 2/3 stripes 13578
cp.20131130203620 Sun Nov 30 12:36:20 2013 valid --- --- nodes 2/2 stripes 13586
cp.20131201361132 Mon Dec 1 08:11:32 2013 valid rdc --- nodes 2/2 stripes 13586
cp.20131201203712 Mon Dec 1 12:37:12 2013 valid --- --- nodes 2/2 stripes 13586

Checkpoints cp.20131116154531, cp.20131117155032 and cp.20131117184533 each

had 3 total nodes that participated in creation of the checkpoint. However, only 2 of those
nodes were online. This condition is denoted by the 2/3 entry.
Checkpoints cp.20131130203620, cp.20131201361132, and cp.20131201203712 had
2 total nodes that participated in creation of the checkpoint; both nodes were online. This
condition is denoted by the 2/2 entry.
Dates and times shown are utlility node local time.
The following example shows the content of the specified FILE, assumed to be in XML
format as produced by avmaint lscp:
cplist FILE --full

The following example illustrates how to use cplist to filter avmaint lscp output:
avmaint lscp | cplist

The following example creates the standard file (with all valid checkpoints if --full is
specified) and then displays it:
cplist --lscp --full

cplist 247
EMC CONFIDENTIAL
Command Reference

cps
The cps command is used to analyze the amount of server capacity used by checkpoints.
The cps command can only be run from single-node servers or multi-node server storage
nodes. Therefore, in a multi-node server environment, you must first copy the cps
executable file from the utility node to each storage node.

Synopsis
cps -blk -find -scan -sum -version

Options
The following options are available for the cps command.

Table 174 Command options for the cps command

Option Description

-blk Returns checkpoint usage statistics by partition.

-find Returns a detailed list of checkpoints.

-scan Generates scan log.

-sum Generates sum log.

-version Shows version, then exits.

Example
cps -blk
Checkpoint usage by partition:
78.695 /data01/cur
101.555 /data02/cur
101.620 /data03/cur
0.144 (null)/hfscheck
0.211 /data02/hfscheck
0.198 /data03/hfscheck
0.003 (null)/cp.20130208070906
0.000 /data02/cp.20130208070906
0.000 /data03/cp.20130208070906
0.135 (null)/cp.20130207072952
0.141 /data02/cp.20130207072952
0.468 /data03/cp.20130207072952
0.123 (null)/cp.20130205070905
0.139 /data02/cp.20130205070905
0.462 /data03/cp.20130205070905

GB used %use Total checkpoint usage by node:

2188.957 Total blocks on node Tue Feb 9 22:04:45 2013
1793.468 81.93 Total blocks available
281.870 12.88 cur Tue Feb 9 21:50:25 2013
0.553 0.03 hfscheck Sun Feb 8 07:51:49 2013
0.003 0.00 cp.20130208070906 Sun Feb 8 07:14:52 2013

248 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

0.744 0.03 cp.20130207072952 Sat Feb 7 07:30:06 2013

0.725 0.03 cp.20130205070905 Thu Feb 5 08:04:25 2013
283.895 12.97 Total blocks used by dpn

create_newconfigs
The create_newconfigs command reads the values from a config_info file, and configures
the utility node in that module accordingly.
The create_newconfigs command and config_info reside in the /usr/local/avamar/src
directory. You should run create_newconfigs from that location.

cron_env_wrapper
The cron_env_wrapper command sets the environment for running Avamar cron jobs. This
includes setting the PATH environment variable and starting an ssh-agent.
This command must be run as user dpn. This program attempts to load the dpnid
OpenSSH key from the dpn user .ssh directory. This command fails if it is run as a different
user.

Synopsis
cron_env_wrapper CRONJOB [--debug] [--help] [--log=FILE]

Options
The following options are available for the cron_env_wrapper command.

Table 175 Command options for the cron_env_wrapper command

Option Description

CRONJOB Specifies which cron job to run. Valid Avamar cron jobs are:
• 10minute_cron_run
• 5minute_cron_run
• cp_cron
• evening_cron_run
• gc_cron
• hfscheck_cron
• morning_cron_run

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits.

--log=FILE Logs to this FILE.

create_newconfigs 249
EMC CONFIDENTIAL
Command Reference

dbcreate_mds
The dbcreate_mds command creates and initializes a metadata search database on an
access node. It creates the /data01/mds_data and /data01/mds_log directories, and
initializes the metadata search database (mdsdb).



Beginning with version 3.7, this command has been deprecated in favor of mds_ctl.

Synopsis
dbcreate_mds [--force] [--nocreatedb]

Options
The following options are available for the dbcreate_mds command.

Table 176 Command options for the dbcreate_mds command

Option Description

--force The dbcreate_mds command always warns if an existing metadata search

database is detected. However, supplying --force creates and initializes a new
metadata search database even if an existing metadata search database is
detected. This is not the default setting.

Note: Supplying --force completely overwrites any data in an existing metadata

search database. You are not given an opportunity to reconsider this action once
the command is invoked.

--nocreatedb If supplied, Avamar system administrators can create the symbolic links that link
metadata search to axionfs without effecting an existing metadata search
database. This is not the default setting.
You should only run the dbcreate_mds --nocreatedb command if you have
already run dbcreate_mds, and subsequently axionfs is installed on the access
node.

dbload.sh
The dbload.sh shell script loads the copy of the MCS database created by dbdump.sh.

250 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

dbmaint.sh
The dbmaint.sh shell script performs maintenance on PostgreSQL databases.

Synopsis
dbmaint.sh [--db={on | off | auto}] [--dbname={emdb | mcdb | mdsdb}]
[--mcs] [--script=FILE] [--server]

Options
The following options are available for the dbmaint.sh shell script.

Table 177 Command options for the dbmaint.sh shell script

Option Description

--db= {on | off | auto} Controls database state after maintenance is performed. One of
the following:
• auto—Leaves database in same state as when maintenance
started. This is the default setting.
• off—Shuts down database on exit.
• on—Leaves database running on exit.

--dbname= Specifies which database to process. One of the following:

{emdb | mcdb | mdsdb}
• emdb—Process Avamar Enterprise Manager server database.
• mcdb—Process MCS database.
• mdsdb—Process metadata search database.

--mcs Allows dbmaint.sh to run while MCS is running, otherwise

dbmaint.sh can only be run while the MCS is stopped.

--script=FILE If FILE is a .sql file, then it is processed as a database script.

Otherwise, it is processed as a shell script. No script is executed if
this option is not specified.
.sql files are located in lib/sql; shell scripts are located in
/usr/local/avamar/bin.

--server Allows dbmaint.sh to run while the server is running.

Scripts
The dbmaint.sh shell script accepts one and only one of the following script files with the
--script=FILE option.

Table 178 Script files for the dbmaint.sh shell script (page 1 of 2)

Script Description

db_count.sql Returns total number of records in all MCS database tables.

dbcreate.sql Creates the MCS database tables.

dbcreateuser.sql Creates MCS database users.

dbdropviews.sql Removes MCS database views.

dbdump.sh Creates a portable copy of the MCS database.

dbinitdatasets.sql Loads default dataset data.

dbinitevents.sql Loads default event definitions.

dbmaint.sh 251
EMC CONFIDENTIAL
Command Reference

Table 178 Script files for the dbmaint.sh shell script (page 2 of 2)

Script Description

dbinitgroups.sql Loads default group definitions.

dbinitretpolicies.sql Loads default retention policy definitions.

dbinitschedules.sql Loads default schedule definitions.

dbmaint.sql Frees unused hard drive space by running an SQL vacuum command
against the mcdb.

dbviews.sql Creates MCS database views.

ec_update.sql Forces an upgrade of the event catalog by resetting the version numbers.

show_versions.sql Returns schema version.

Notes
This shell script added in version 1.2. It supersedes and obsoletes mcdbmaint.sh and
mcdbsql.sh.

dbpurge.sh
The dbpurge.sh shell script manually purges unused data from and reclaims tablespace in
the MCS PostgreSQL database (mcdb).



You should only purge data if it is no longer needed for future report generation. If the data
is needed, extract it to another storage device (database, archive), and then purge it from
the MCS database.

Operational data tables typically do not grow very large in size and only grow in direct
proportion to the management of clients, groups, schedules, retention policies and event
profiles.
However, other report data tables can grow very large over time and should be purged to
avoid accumulation of old data:
◆ The activities table (mcdb.activities) increases in size after each backup and restore
request is processed.
◆ The events table (mcdb.events) can increase in size every second, depending on
system loading and system events.
◆ The node utilization (mcdb.sv_node_util) and node capacity (mcdb.sv_node_space)
tables increase in size every 10 minutes.

Synopsis
dbpurge.sh --from=YYYY-MM-DD --to=YYYY-MM-DD {--all | --v_activities |
--v_events | --v_node_space | --v_node_util}

252 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Options
The following options are available for the dbpurge.sh shell script.

Table 179 Command options for the dbpurge.sh shell script

Option Description

--from=YYYY-MM-DD Used with --to=YYYY-MM-DD to define a range of dates for the purge
operation. This option is required.

--to=YYYY-MM-DD Used with --from=YYYY-MM-DD to define a range of dates for the purge
operation. This option is required.

--all Purges the activities (mcdb.activities), events (mcdb.events), node

capacity (mcdb.sv_node_space) and node utilization (mcdb.sv_node_util)
tables.

--v_activities Purges the activities table (mcdb.activities).

--v_events Purges the events table (mcdb.events).

--v_node_space Purges the node capacity table (mcdb.sv_node_space).

--v_node_util Purges the node utilization table (mcdb.sv_node_util).

Examples
The following command returns the size (count) of the tables distributed by dates, which
can be used to determine which tables and date ranges to purge:
/usr/local/avamar/bin/dbmaint.sh --mcs --script=db_v_count.sql

The following command purges the activities (mcdb.activities), events (mcdb.events),

node capacity (mcdb.sv_node_space) and node utilization (mcdb.sv_node_util) tables of
all data from September 16, 2013 (2013-09-16) to September 20, 2013 (2013-09-20):
dbpurge.sh --from=2013-09-16 --to=2013-09-20 --all

dbpurge.sh 253
EMC CONFIDENTIAL
Command Reference

dbUpdateActivitiesExt.pl
The dbUpdateActivitiesExt.pl Perl script updates the mcdb activities_ext table.
An Avamar server requires updating by running this script if it was upgraded to version
3.5.0 or if after upgrading to version 3.5.0, the Avamar server is rolled back to a point
before the 3.5.0 upgrade.
The dbUpdateActivitiesExt.pl executable file is located in /usr/local/avamar/lib/sql.

decommission.node
The decommission.node command decommissions the specified node.

Synopsis
decommission.node [--help] [--pollrate=SECS] [--timeout=MIN]
[--verbose] [--wait] NODE

Options
The following options are available for the decommission.node command.

Table 180 Command options for the decommission.node command

Option Description

--help Shows help, then exits.

--pollrate=SECS Sets the delay between polls when waiting for completion. The default
setting is 30 seconds.

--timeout=MIN Specifies the maximum inactive time period in minutes (MINS) before
interpreting inactivity as program failure. The default timeout setting is 60
minutes.

--verbose Provides maximum information.

--wait Waits until node decommission completes. This is the default.

NODE Specifies the logical node ID to decommission. This parameter is required.

254 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

delete-snapups
The delete-snapups command writes a script to stdout, which when run, deletes any
backups stored on the Avamar server with a creation date before the specified date.

Synopsis
delete-snapups [--after=DATE] [--before=DATE] [--domain=CLIENT-DOMAIN]
[--help] [--include_mc_backups] [CLIENT-PATH ...]

Options
The following options are available for the delete-snapups command.

Table 181 Command options for the delete-snapups command

Option Description

--after=DATE If supplied, all backups created after this date are eligible to be
deleted. The default DATE setting is June 1, 1999 00:00:00.

--before=DATE If supplied, all backups created before this date are eligible to be
deleted. The default DATE setting is two weeks ago.

--domain=CLIENT-DOMAIN If supplied, all clients within the specified CLIENT-DOMAIN are

processed.

--help Shows help, then exits.

--include_mc_backups If supplied, all clients within the special MC_BACKUPS domain are
also processed. Because MC_BACKUPS is a special system domain,
the default behavior is to not process these clients unless this
option is explicitly supplied.

CLIENT-PATH Specifies a valid Avamar client path (for example,

/clients/MyClient). Additional client paths can be delimited with
white space.
Client paths must always terminate with a valid Avamar client name.
You cannot specify a client domain in this manner. Use --domain to
process all clients within a particular domain.
If not supplied, all clients are processed. This is the default setting.

Notes
Consider the following notes for the delete-snapups command:
◆ This command deletes backups but does not update the MCS database. This causes
the total bytes used value, which is used by the server licensing mechanism, to be
incorrect. Therefore, EMC strongly suggests that you only use this command if
instructed to do so by EMC Customer Support. Contact EMC Customer Support for
additional information.
◆ After deleting backups with this command, you should immediately run
dbUpdateactivitiesExt.pl to update the MCS database. If you do not do this, the
server’s total bytes used value is incorrect, which adversely affects server licensing
(you are deleting backups, which would normally free up additional storage capacity,
but the licensing mechanism is unaware that you have done so).

delete-snapups 255
EMC CONFIDENTIAL
Command Reference

◆ The DATE specifier can be any date string acceptable to date(1). For GNU date(1),
which on Linux is /bin/date, DATE can be just about any common date string,
including such phrases as “2 weeks ago.”

Examples
To create a default output script (one that deletes any backup stored in /clients with a
creation date older than two weeks from today’s date) with the user-defined name
del-old-backups, type:
delete-snapups /clients > del-old-backups

To restrict command execution to specific client area (/clients/engineering in this

example) and change the time period to three weeks ago, type the following on a single
command line:
delete-snapups --before='3 weeks ago' /clients/engineering >
del-old-backups

After creating a script with the desired backup deletion parameters, type the following to
delete the backups from the Avamar server:
/bin/sh -x ./del-old-backups

256 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

disktest.pl
The disktest.pl Perl script tests Avamar server hard disk performance.



Do not run the disktest.pl command on an operational Avamar server. Loss of data might
result.

Synopsis
disktest.pl [--clean] [--debug] [--fileext=EXTENSION]
[--filesize=SIZE] [--help] [--iterations=NUM] [--minimumseek=NUM]
[--numdirs=NUM] [--numfiles=NUM] [--numlevels=NUM]
[--pattern_seq=PATTERN] [--prompt] [--readsize=SIZE] [--seeks=NUM]
[--seeksperfile=NUM] [--style=PATTERN] [--targetdir=PATH]

Options
The following options are available for the disktest.pl Perl script.

Table 182 Command options for the disktest.pl Perl script (page 1 of 2)

Option Description

--clean Removes created files.

--debug Enables debugging messages.

--fileext=EXTENSION Specifies the file extension. The default extension is ZZZ.

--filesize=SIZE Specifies the SIZE of files in bytes. The default setting is 100K.

--help Shows help, then exits.

--iterations=NUM Specifies the number (NUM) of iterations.

--minimumseek=NUM Minimum number (NUM) of seek. The default setting is 1000.

--numdirs=NUM Specifies the number (NUM) of directories to create per level. The
default setting is 2.

--numfiles=NUM Specifies the number (NUM) of files to create per level. The default
setting is 10.

--numlevels=NUM Specifies the number (NUM) of subdirectories to process. The default

depth is 2 subdirectories.

--pattern_seq=PATTERN Specifies the PATTERN sequence of characters as a simple string (for

example abcdefg) or as numeric string (for example, 97,98,99 or
0x30,0x31).

--prompt Enables prompt to continue.

--readsize=SIZE Specifies the number of bytes to read. The default setting is 400.

--seeks=NUM Specifies the number (NUM) of files to seek. The default setting is
100.

--seeksperfile=NUM Specifies the number (NUM) of seeks per file. The default setting is
100.

disktest.pl 257
EMC CONFIDENTIAL
Command Reference

Table 182 Command options for the disktest.pl Perl script (page 2 of 2)

Option Description

--style=PATTERN Specifies the PATTERN to use: alt or abc. The default setting is alt.

--targetdir=PATH Specifies the target directory for files. The default setting is
/tmp/targetdir.

dpn.pm
The dpn.pm file is a Perl module used by many of the Perl scripts in the dpnutils package.

dpncron.pm
The dpncron.pm file is a Perl module used by cp_cron, gc_cron, and hfscheck_cron.

dpnctl
The dpnctl command performs three functions:
◆ Implements unattended automated shutdowns and restarts of single-node servers.
◆ Simplifies shutdowns and restarts on all Avamar servers.

Synopsis
dpnctl {{{disable | enable| start | status | stop} [SUBSYSTEM]} | help}

[--check_software_raid_status] [--config=FILE] [--debug]

[--ems_password=PASSWORD] [--ems_shutdown] [--ems_user=ID]
[--event_notification_timeout=SEC] [--force_ems_restore]
[--force_mcs_restore] [--force_rollback]
[--force_version_record_update] [--help] [--hfsport=PORT]
[--ignore_lock] [--ignore_node_type]
[--ignore_software_raid_status] [--ignoresysconfig]
[--initialize_connectemc] [--mcs_password=PASSWORD]
[--mcs_user=USER-ID] [--nodedb=FILE] [--nointeractive_questions]
[--now] [--override_interactive_update_requirement]
[--require_clean_gsan] [--update] [--use_status_dpn] [--verbose]
[--xml]

Commands
Supply one and only one of the following commands on each command line for dpnctl.

Table 183 Commands for the dpnctl command (page 1 of 2)

Option Description

disable Disables automated server shutdowns and restarts.

enable Enables automated server shutdowns and restarts.

help Shows help, then exits. Same as supplying the --help option.

258 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 183 Commands for the dpnctl command (page 2 of 2)

Option Description

start [SUBSYSTEM] Starts server subsystems. Valid SUBSYSTEM codes are:

• all—Start all server subsystems (axionfs, ems, gsan, mcs, and
scheduler (sched)). This is the default setting.
• axionfs—Only start Avamar virtual file system (axionfs) subsystem.
• dtlt—Only start desktop/laptop services.
• ems—Only start EMS subsystem.
• gsan—Only start storage (gsan) subsystem.
• maint—Only start maintenance subsystem.
• mcs—Only start MCS and scheduler (sched) subsystems.
• sched—Only start scheduler (sched) subsystem.

status [SUBSYSTEM] Shows status of server subsystems. Valid SUBSYSTEM codes are:
• all—Show status of all server subsystems (axionfs, ems, gsan, mcs
and scheduler (sched)). This is the default setting.
• axionfs—Only show status of Avamar virtual file system (axionfs)
subsystem.
• dtlt—Only show status of desktop/laptop services.
• ems—Only show status of EMS subsystem.
• enable—Show whether automated server shutdowns and restarts
is enabled.
• gsan—Only show status of storage (gsan) subsystem.
• maint—Only show status of maintenance subsystem.
• mcs—Only show status of MCS and scheduler (sched) subsystems.
• sched—Only show status of scheduler (sched) subsystem.

stop [SUBSYSTEM] Stops server subsystems. Valid SUBSYSTEM codes are:

• all—Stop all server subsystems (axionfs, ems, gsan, mcs and
scheduler (sched). This is the default setting.
• axionfs—Only stop Avamar virtual file system (axionfs) subsystem.
• dtlt—Only stop desktop/laptop services.
• ems—Only stop EMS subsystem.
• gsan—Only stop storage (gsan) subsystem.
• maint—Only stop maintenance subsystem.
• mcs—Only stop MCS and scheduler (sched) subsystems.
• sched—Only stop scheduler (sched) subsystem.

Options
The following options are available for the dpnctl command.

Table 184 Command options for the dpnctl command (page 1 of 4)

Option Description

--check_software_raid_status Performs a check for software RAID issues

before starting storage (gsan) subsystem.

--config=FILE Specifies the configuration FILE location.

Supplying --config=- (equal sign and dash)
reads XML configuration data from stdin.

--debug Shows example session information but

does not perform the specified actions.

dpnctl 259
EMC CONFIDENTIAL
Command Reference

Table 184 Command options for the dpnctl command (page 2 of 4)

Option Description

--event_notification_timeout=SEC Specifies the timeout in seconds (SEC) for

event notification. Specify zero (0) for no
timeout. The default setting is 1800
seconds.

--ems_password=PASSWORD Specifies the alternative EMS password.

--ems_shutdown Used with stop to force a shutdown of the

EMS. This is the default condition.
If neither --ems_shutdown nor
--noems_shutdown is supplied and dpnctl
is operating in an interactive context
(unattended automated server shutdowns
are not enabled), then an interactive
prompt appears, asking whether to shut
down this instance of the EMS.

--ems_user=ID Specifies the alternative EMS user ID.

--force_ems_restore Used with start to force an EMS restore

before restarting.

--force_mcs_restore Used with start to force an MCS restore

before restarting.

--force_rollback Used with start to force a rollback before

restarting.

--force_version_record_update Used with start to force an update of the

version record.
This option added in version 4.0.

--help Shows help, then exits. Same as supplying

the help command.

--hfsport=PORT Specifies the data PORT to use for

communications between the Hash File
System (HFS) and the MCS when MCS
restores are performed. The default data
port is 27000.

--ignore_lock Ignores lock file on startup.

--ignore_node_type Bypasses node type checking. The default

behavior is to exit without comment when
dpnctl is run on a multi-node server in a
non-interactive context.

--ignore_software_raid_status Ignores software RAID issues that might

exist before starting storage (gsan)
subsystem.

--ignoresysconfig Bypasses node compatibility checks.

This option added in version 6.0.

260 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 184 Command options for the dpnctl command (page 3 of 4)

Option Description

--initialize_connectemc Used with start to read a specified

configuration file and pass values from
attributes specific to ConnectEMC to
avsetup_connectemc.pl and
/opt/connectemc/connectemc.
Use of --initialize_connectemc has no effect
unless dpnctl is running in an update
context.
The default setting is
--noinitialize_connectemc.

--mcs_password=PASSWORD Specifies the MCS password.

--mcs_user=ID Specifies the MCS user ID. The default

setting is root.

--nodedb=FILE Specifies the full path to a valid probe.xml

file.
The default setting is
/usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nointeractive_questions If supplied, dpnctl behaves as though it

were executing in a non-interactive context.
This is not the default setting.

--now Used with stop command to perform an

immediate system shutdown without
waiting for completion of active backup
sessions.

--override_interactive_update_requirement If supplied, allows dpnctl start to continue

when a server software update is indicated
in a non-interactive context.

--require_clean_gsan If suppled, causes dpnctl start to exit with

an error message if it encounters data on
the server (that is, if server is not clean).
This option added in version 4.1.

dpnctl 261
EMC CONFIDENTIAL
Command Reference

Table 184 Command options for the dpnctl command (page 4 of 4)

Option Description

--update Supplying --update forces dpnctl to operate

in an update context; supplying --noupdate
inhibits dpnctl from operating in an update
context.
If a newer version dpnmcs software
package is detected during a server
software upgrade, then dpnctl determines
that this is an update context and
propagates the correct version gsan binary
to all storage nodes.
In an update context, dpnctl might invoke
one or more of the following commands:
• mcserver.sh --update (unless an MCS
data restore has occurred)
• avsetup_mccli
• avsetup_webstart
• avsetup_ems
• emserver.sh --init (once only)
• website create-cfg
• website init
• website restart
• service lm restart
• avmaint config
lmaddr=UTILITY-NODE-IP-ADDR

--use_status_dpn Used with status command to force use of

the older status.dpn command, instead of
opstatus.dpn.

--verbose Provides maximum information.

--xml Used with the status command to format

output in XML.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 185 Deprecated command options for the dpnctl command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Notes
Consider the following notes for the dpnctl program:
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable typically stores the
path to a directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the
default probe.xml location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.

262 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

◆ The dpnctl command does not presently handle the first-time-ever startup case. When
starting up a system for the first time, do not use dpnctl but instead, use the
documented procedures for first-time startup.
◆ If the dpn user's crontab is not installed, dpnctl status might still report that
maintenance cron jobs are enabled (that they are not suspended). If maintenance
cron jobs are not running, check that the dpn user's crontab is installed.
◆ If garbage collection is active while applying dpnctl stop, then the read-only status of
gsan (0000+0000+0000) might cause complaints during administrator server
shutdown.
◆ Support for uninstalling individual features added in version 6.0.

Environment variables
The dpnctl program uses the following environment variables.

Table 186 Environment variables used by the dpnctl command

Environment variable Description

$PATH Executable locations.

$PERL5LIB Perl 5 library directory for XML::Parser.

$SYSPROBEDIR Parent directory for probe.xml file.

Files
The dpnctl program uses the following files.

Table 187 Files used by the dpnctl command

Environment variable Description

/usr/local/avamar/etc/usersettings.cfg Client settings file.

/usr/local/avamar/lib/mcclimcs.xml MCCLI default options file.

/usr/local/avamar/lib/mcserver.xml MCS preferences file.

/usr/local/avamar/var/dpn-auto-start.DISABLE Inhibits automatic startup when present (used

by enable and disable commands).

/usr/local/avamar/var/dpnctl.lck Lock file.

/usr/local/avamar/var/log/dpnctl.log Log file (when --log is used).

This log file is automatically rotated when it
reaches 1 MB in size; up to eight rotated dpnctl
log files are retained in
/usr/local/avamar/var/log/.

probe.xml

Passwords
For default MCS user root, the client settings file is consulted if no password is supplied by
way of command line or configuration file.
MCS user and password information must be available to perform start, stop, or status
operations on schedules; or to perform rollback and restart operations.

dpnctl 263
EMC CONFIDENTIAL
Command Reference

Rollbacks and restores

If the storage server (formerly known as GSAN) did not shut down cleanly, then upon
restart, dpnctl applies an automatic rollback to the most recent checkpoint, followed by an
automatic restore of MCS data.
The --force_rollback option implies --force_mcs_restore; the --force_mcs_restore option
does not imply --force_rollback.
Running dpnctl start --force_rollback presents interactive menus and guides you through
the rollback process. These interactive menus and prompts only appear when dpnctl is
run in an interactive context, when --force_rollback is supplied or the storage server
(formerly known as GSAN) reports that it was not shut down cleanly.
The dpnctl program makes no attempt to restore the utility node client settings file
following an automatic rollback. Operations can fail if the root password in the client
settings file is invalid for a checkpoint. If necessary, intervene manually to correct the
client settings file before restarting.
For an MCS restore operation, the client settings file is examined if no --hfsport=PORT
option is supplied by way of command line or configuration document. The default data
port for communications between the Hash File System (HFS) and the MCS is 27000.

Getting server status in XML format

The following command returns server status in XML format:
dpnctl status --xml 2>/dev/null
<dpnctl-status>
<identification>
<host name="avamar-1.example.com"/>
<gsan name="avamar-1.example.com"/>
</identification>
<component>
<gsan status="ready"/>
<mcs status="up"/>
<ems status="up"/>
<sched status="up"/>
<axionfs status="up"/>
<maint status="enabled"/>
<unattended-startup status="enabled"/>
</component>
<aggregate status="up"/>
<upgradeable status="yes"/>
</dpnctl-status>

If the storage server (formerly known as GSAN) is running, then a

<gsan name="SYSTEM-NAME"/> element is present as a child element under
<identification>.
The <aggregate status= “up”> element is present if both the storage server (formerly
known as GSAN) and MCS are running. The <aggregate status= “down”> element is present
otherwise.
The <upgradeable status= “yes”> element is present if both the storage server (formerly
known as GSAN) and MCS return statuses of ready and up, respectively. The
<upgradeable status= “no” reason=“EXPLANATORY-TEXT”> element is present otherwise.
The determination as to whether the storage server or MCS is “up” does not take into
account stripe status or a read-only system condition.

264 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

The storage server is defined to be up if opstatus.dpn exits with status 0 and without
printing an ERROR or FATAL message.
The MCS is defined to be up if mcserver.sh --ping exits with status 0 and without printing
an ERROR or FATAL message.

Configuration file notes

Valid configuration files must be plain text files (created with a UNIX text editor such as vi
or Emacs) conforming to the following XML Document Type Definition (DTD):
<!ELEMENT dpnctl(include | options | passthrough | password)*>
<!ELEMENT include EMPTY>
<!ATTLIST include path CDATA #REQUIRED>
<!ELEMENT options EMPTY>
<!ATTLIST options debug (true | false) #IMPLIED
ems_shutdown (true | false) #IMPLIED
event_notification_timeout CDATA #IMPLIED
force_ems_restore (true | false) #IMPLIED
force_mcs_restore (true | false) #IMPLIED
force_rollback (true | false) #IMPLIED
hfsport CDATA #IMPLIED
ignore_lock (true | false) #IMPLIED
ignore_node_type (true | false) #IMPLIED
now (true | false) #IMPLIED
path CDATA #IMPLIED
probedir CDATA #IMPLIED
verbose (true | false) #IMPLIED
xml (true | false) #IMPLIED>
<!ELEMENT password EMPTY>
<!ATTLIST password class CDATA #REQUIRED
user CDATA #REQUIRED
value CDATA #REQUIRED>
<!ELEMENT passthrough EMPTY>
<!ATTLIST passthrough context (restore | start | stop | update) #REQUIRED
program CDATA #REQUIRED
options CDATA #REQUIRED>

Example configuration document:

<dpnctl>
<options verbose="true"/>
<password class="mcs" user="root" value="PASSWORD"/>
<passthrough program="restart.dpn"
context="start"
options="--delay"/>
</dpnctl>

Pass-through feature
The dpnctl pass-through feature allows you to persistently customize which options are
passed through to the other programs dpnctl invokes.
To use the pass-through feature:
1. Create a configuration file that contains the custom pass-through settings.
2. Invoke dpnctl with the --config=FILE option, which forces dpnctl to read that
configuration FILE and use those pass-through settings.

dpnctl 265
EMC CONFIDENTIAL
Command Reference

Configuration file
To create a valid configuration file, use a UNIX text editor such as vi or Emacs to create a
plain text file with a meaningful name in a convenient directory.
/usr/local/avamar/dpnctl.cnf is used as an example configuration filename and path for
the remainder of this topic.
For each pass-though command, you must define an operational context (start, stop,
restore, or update) and a valid program that dpnctl is known to invoke in that operational
context.
The following table lists valid programs that can have pass-through options defined for
them in each operational context:

Table 188 Valid programs that allow pass-through options

Context Program Command

start emserver.sh emserver.sh --start [PASS-THROUGH-OPTIONS]

mcserver.sh mcserver.sh --start [PASS-THROUGH-OPTIONS]

restart.dpn restart.dpn [PASS-THROUGH-OPTIONS]

rollback.dpn rollback.dpn --cptag=CP-ID [PASS-THROUGH-OPTIONS]

stop emserver.sh emserver.sh --stop [PASS-THROUGH-OPTIONS]

mcserver.sh mcserver.sh --stop [PASS-THROUGH-OPTIONS]

shutdown.dpn shutdown.dpn [PASS-THROUGH-OPTIONS]

restore mcserver.sh mcserver.sh --restore --id=USER-ID --hfsport=PORT

--hfsaddr=IP-ADDR --password=PASSWORD
[PASS-THROUGH-OPTIONS]

emserver.sh emserver.sh --restore --id=USER-ID --hfsport=PORT

--hfsaddr=IP-ADDR --password=PASSWORD
[PASS-THROUGH-OPTIONS]

update mcserver.sh mcserver.sh --update [PASS-THROUGH-OPTIONS]

The structure of the configuration file is XML. The <passthrough> elements are used to
define operational context, program and one or more command line options that are
passed to that program in that operational context.

Practical example
Consider the following example entry in /usr/local/avamar/dpnctl.cnf:
<dpnctl>
<passthrough program="restart.dpn"
context="start"
options="--delay"/>
</dpnctl>

This configuration file entry passes through the --delay command line option to the
restart.dpn program each time dpnctl start is invoked with the
--config=/usr/local/avamar/dpnctl.cnf option.
Invoking dpnctl start without the --config=/usr/local/avamar/dpnctl.cnf option bypasses
any pass-through settings stored in that configuration file.

266 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Setting up unattended automated server shutdowns and restarts

To enable unattended automated server shutdowns and restarts on single-node servers,
perform the following:
1. Open a command shell and log in using one of the following methods:
• To log in to a single-node server, log in to the server as admin.
• To log in to a multi-node server, log in to the utility node as admin.
2. Switch user to root by typing:
su -

3. Type the following command:

dpnctl enable

4. Switch back to admin by typing:

exit

This performs the necessary system setup operations, including installing the init.d
startup script and running chkconfig.

dpnctl 267
EMC CONFIDENTIAL
Command Reference

dpnfsctl
The dpnfsctl command directly controls the Avamar File System (AvFS).
Documentation for this command is provided for reference purposes only. The dpnfsctl
program is typically invoked programmatically by dpnctl and should not be run directly
from the command line.

Synopsis
dpnfsctl {help | start | status | stop} [--debug] [--help] [--verbose]

Commands
Supply one and only one of the following commands on each command line for dpnfsctl.

Table 189 Commands for the dpnfsctl command

Command Description

help Shows help, then exits. Same as supplying the --help option.

start Starts Avamar File System (AvFS).

status Shows status of Avamar File System (AvFS).

stop Stops Avamar File System (AvFS).

Options
The following options are available for the dpnfsctl command.

Table 190 Command options for the dpnfsctl command

Option Description

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits. Same as supplying the help command.

--verbose Provides maximum information.

Environment variables
The dpnfsctl command uses the following environment variable.

Table 191 Environment variables used by the dpnfsctl command

Environment variable Description

$PATH Executable locations

268 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

dpnnetutil
The dpnnetutil command assists in configuring Avamar server network configurations. Use
the dpnnetutil program in pre-production environments to configure network settings for
multi-node and single-node servers. You can also use the dpnnetutil program in a
production environment to change network settings for a single-node server.



Do not use the dpnnetutil program to change network settings for a multi-node server in a
production environment.

Synopsis
dpnnetutil [--broadcast] [--help]

Options
The following options are available for the dpnnetutil command.

Table 192 Command options for the dpnnetutil command

Option Description

--broadcast If supplied, dpnnetutil performs a broadcast ping on eth0, the results of which
provide a pool of initial candidate node IP addresses.
The first 38 nodes to respond within a short window of time are added to the pool,
excluding the first and last addresses of the subnet.
Explicitly supplying --broadcast option implies that the person running this
program knows that this is a multi-node server configuration. Therefore,
interactive prompting for server type is bypassed.

--help Shows help, then exits.

Notes
Consider the following notes for the dpnnetutil command:
◆ This command added in version 3.7.1.
◆ The dpnnetutil command must be run as root. It also requires the dpnid OpenSSH key
to perform operations as root on a multi-node system.

Environment variables
The dpnnetutil command uses the following environment variable.

Table 193 Environment variables used by the dpnnetutil command

Environment variable Description

$SYSPROBEDIR Parent directory for probe.xml file.

dpnnetutil 269
EMC CONFIDENTIAL
Command Reference

Log files
All log files are located in /usr/local/avamar/var/log/.

Table 194 Log files for the dpnnetutil command

Location Filename Description

utility node dpnnetutil.log This is a detailed master log file for dpnnetutil.

dpnnetutilbg.out This file contains a progress summary for the

non-interactive background job, dpnnetutilbg.

all nodes dpnnetutilbgaux-stdout-stderr.log This file contains a progress summary for the
non-interactive per-node background helper job,
dpnnetutilbgaux, which is responsible for
making configuration changes on each node.

dpnnetutilbgaux.log This file contains detailed log information from

the non-interactive per-node background helper
job, dpnnetutilbgaux.

Files modified
The files in the following table are modified by dpnnetutil.

Table 195 Files modified by the dpnnetutil command (page 1 of 2)

Update
Filename type Attributes updated Description

/etc/hosts Full List of addresses and Avamar server node

hostnames address/hostname
mappings

/etc/sysconfig/network Partial HOSTNAME=HOSTNAME Hostname

GATEWAY=IP-ADDRESS The default network

gateway IP address

NETWORKING=yes Enable networking

/etc/sysconfig/network-scripts/ Partial DEVICE=eth0 Network interface

ifcfg-eth0 name

BOOTPROTO=static Boot protocol

IPADDR=IP-ADDRESS IP address for

interface eth0

NETMASK=NETWORK-MASK Network mask for

interface eth0

ONBOOT=yes Enable network

interface at boot time

270 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 195 Files modified by the dpnnetutil command (page 2 of 2)

Update
Filename type Attributes updated Description

/etc/resolv.conf Full nameserver IP-ADDRESS Primary and

secondary DNS
resolving name server
addresses

search DOMAIN-NAME Search domain for

unqualified
hostnames

domain IP-ADDRESS Name of parent

domain

/usr/local/avamar/etc/ Partial node type=NODE-TYPE Node type (if one of

node.cfg the supported node
types)

/usr/local/avamar/var/ Full Module ID, utility node, Addresses for node

probe.xml storage node list types supported by
the current probe.xml
file format

Single-node server processing flow pre-production

This topic provides a high-level processing overview of a dpnnetutil session on a
single-node server.
1. Prompt for timezone setting:
Please select a time zone for the system from this menu:
2. Prompt for server configuration:
Is this a single-node server?
Yes: Continue.
No: Configure a multi-node server using the instructions in “Multi-node server
processing flow pre-production” on page 272.
3. Prompts for configuring the single-node server:
a. Please enter the new IP address for the system single-node server interface bond0:
b. Please enter the network mask for the system single-node server interface bond0:
c. Please enter the new hostname (without domain name) for the system single-node
server.
d. Please enter the domain name for the system single-node server.
e. Please enter the IP address of the primary DNS resolver for the system single-node
server.
f. Please enter the IP address of the secondary DNS resolver for the system
single-node server.
4. Prompt for user confirmation:
Accept settings and proceed to fix up the network configurations?

dpnnetutil 271
EMC CONFIDENTIAL
Command Reference

Yes: Proceed.
No: Quit.
The dpnnetutil program writes the configuration details to the
/usr/local/avamar/probe.xml file.
5. Use the nodedb print command to view the contents of probe.xml.

Multi-node server processing flow pre-production

This topic provides a high-level processing overview of a dpnnetutil session on a
multi-node server. This topic assumes that the --broadcast option was supplied on the
command line that invoked dpnnetutil because that is expected to be the normal way
dpnnetutil is invoked.
1. Prompt for timezone setting:
Please select a time zone for the system from this menu:
2. Prompt for server configuration:
Is this a single-node server?
Yes: Configure a single-node server using the instructions in “Single-node server
processing flow pre-production” on page 271.
No: Continue.
3. Prompt for a NAT address of the multi-node server:
Please enter an NAT address of SERVER that these clients will use (enter blank to
continue):
where SERVER is the multi-node server hostname.
4. Prompt for the domain names of the multi-node server:
a. Please enter the domain name for SERVER. You may modify this later for individual
nodes.
b. Do any of the nodes require a domain different than DOMAIN?
5. Prompt for primary and secondary DNS resolvers:
a. Please enter the IP address of the primary DNS resolver for SERVER. You may
modify this later for individual nodes.
b. Do any of the nodes require a primary DNS resolver different than IP-ADDRESS?
c. Please enter the IP address of the secondary DNS resolver for SERVER. You may
modify this later for individual nodes.
d. Do any of the nodes require a secondary DNS resolver different than IP-ADDRESS?
6. Prompt for the network gateway:
a. Please enter the network gateway address for SERVER. You may modify this later
for individual nodes.
b. Do any of the nodes require a default gateway different than IP-ADDRESS?
7. Prompt for the network mask:

272 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

a. Please enter the network mask for SERVER. You may modify this later for individual
nodes.
b. Do any of the nodes require a network mask different than IP-ADDRESS?
c. The default bonded interface is created from interfaces:eth0,eth1.
8. Prompt for configuring the utility node:
a. Please enter the new IP address for the system utility node interface bond0:
b. Please enter the new hostname (without domain name) for the system utility node.
c. Please enter an ssh reachable hostname or IP address for the system storage node
0 (Enter blank to return):
9. Prompt for configuring storage nodes:
a. Please enter the new IP addresses for the system storage node 0 interface bond0.
b. Please select initial NAT addresses:
c. Please enter the NAT address corresponding to IP-ADDRESS for interface bond0 on
this storage node: (Enter blank to skip)
d. Please enter the new hostname (without domain name) for the system storage
node 0.
e. Do you want to add a new storage node?



Multi-node servers must have at least one storage node.

10. Prompt for configuring optional (access, accelerator, and spare) nodes:
a. Please enter the new IP address for the OPTIONAL node 0 interface bond0.
where OPTIONAL is either an access, accelerator or spare node.
b. Please select initial NAT addresses:
c. Please enter the NAT address corresponding to IP-ADDRESS for interface bond0 on
this OPTIONAL node: (Enter blank to skip)
d. Please enter the new hostname (without domain name) for the OPTIONAL node.
11. Prompt for user confirmation:
Accept settings and proceed to fix up the network configurations?
Yes: Proceed.
No: Quit.

Single-node server processing flow post-production

This topic provides a high-level processing overview of a dpnnetutil session on a a
production single-node server.
1. Prompt for creating a checkpoint:
Do you want to create a checkpoint?

dpnnetutil 273
EMC CONFIDENTIAL
Command Reference

2. Prompt for creating a bonded interface:

Do you want to create a bonded interface bond0 for this node?
3. Prompt for making configuration changes to the IP address, network mask, hostname,
domain name, primary DNS resolver and secondary DNS resolver:
a. Please enter the new IP address for the system single-node server interface bond0:
b. Please enter the network mask for the system single-node server interface bond0:
c. Please enter the new hostname (without domain name) for the system single-node
server.
d. Please enter the domain name for the system single-node server.
e. Please enter the IP address of the primary DNS resolver for the system single-node
server.
f. Please enter the IP address of the secondary DNS resolver for the system
single-node server.
4. Prompt for user confirmation:
Accept settings and proceed to fix up the network configurations?
Yes: Proceed.
No: Quit.

Troubleshooting information
The following table describes how to recover from common problems encountered when
running dpnnetutil on a single-node server in a production environment.

274 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 196 Troubleshooting information for the dpnnetutil command (page 1 of 2)

Error or symptom Description or remedy

Maintenance cron jobs (cp_cron, An unresponsive maintenance cron job may cause a delay
gc_cron, hfscheck_cron, or repl_cron) in the dpnnetutil program’s attempt to shut down the
may have started automatically, but Avamar server subsystems.
are now unresponsive because the To address this issue:
Avamar server subsystems are down. 1. Identify the unresponsive maintenance cron jobs by
typing:
ps auxww | grep cron

2. Stop unresponsive cron jobs by typing:

kill -TERM process-id

To help prevent maintenance cron job hangs, perform the

following after shutting down the Avamar server
subsystems and before running dpnnetutil:
1. Save the dpn user’s crontab.
2. Remove the dpn user’s crontab.
Example:
su -
crontab -l -u dpn >
/usr/local/avamar/var/dpn_crontab.YYYY-MM-DD
crontab -r -u dpn

To restore the dpn user's crontab after dpnnetutil

completes, type:
crontab -u dpn
/usr/local/avamar/var/dpn_crontab.YYYY-MM-DD

Saving and later restoring the dpn user's crontab helps

ensure that any site customizations to the dpn user's
crontab are saved.

Mistyped IP addresses. If the /etc/hosts file contains mistyped IP addresses,

when dpnnetutil runs, it creates incorrect /etc/hosts files.
If a node is off the network because of an incorrect IP
address, bring the node back onto the network by running
/usr/sbin/netconfig on the node.

Nodes are offline. The dpnnetutil program cannot detect nodes that are
offline.
Verify that all nodes are online before running dpnnetutil.

Nodes with the wrong root The dpnnetutil program requires a root mapall operations
authorizations. to work properly with the dpnid key loaded. If root mapall
operations do not work, then the network reconfiguration
background tasks might hang on problematic nodes.
To test root authorizations, use the following commands:
su -
ssh-agent bash
ssh-add ~dpn/.ssh/dpnid
export SYSPROBEUSER=root
mapall --all date

Use dpnnetutil only for nodes that respond to the root

mapall operation.

dpnnetutil 275
EMC CONFIDENTIAL
Command Reference

Table 196 Troubleshooting information for the dpnnetutil command (page 2 of 2)

Error or symptom Description or remedy

After changing an IP address or After changing an IP address or default network gateway

default network gateway address address:
network connection problems exist 1. Ensure that the network infrastructure (switches and
between components such as: firewalls) are configured for the correct Virtual LAN
• Nodes (VLAN).
• Clients and the Avamar server
2. Ensure that access lists for the network infrastructure
• A replication source and its target
have been properly updated.

Warnings about changes to the main The dpnnetutil program does not necessarily preserve the
host appear in the gsan log files when original order of storage nodes in the probe.xml file.
the Avamar system is restarted. Especially, if you specified the --broadcast option.
The change to the order of the storage nodes in probe.xml
should not cause problems. However, to modify the order
of the storage nodes:
• Manually edit probe.xml
• Revert to the backed up version of probe.xml
(/usr/local/avamar/var/probe.xml.dpnnetutilbg_save)

276 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

dpnsummary
The dpnsummary command returns summary information about data stored in the Avamar
server and statistical data for each client backup.

Synopsis
dpnsummary [--days=NUM] [--help] [--hfsaddr=AVAMARSERVER]
[--id=USER@AUTH] [--password=PASSWORD]

Options
The following options are available for the dpnsummary command.

Table 197 Command options for the dpnsummary command

Option Description

--days=NUM Shows information for this past number (NUM) of days.

If not supplied, dpnsummary shows information since the server
was last started.

--help Shows full online help (commands, options and full descriptions),
then exits.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS).
This value is typically recorded in a configuration file. It can also be
set by way of an environment variable or on the command line with
each transaction. The default address is localhost (127.0.0.1).

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication
domain is “avamar.”
For example: jdoe@avamar.

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

Files
The dpnsummary command creates the following files, where AVAMARSERVER is the
Avamar server hostname as defined in DNS, and YYYY-MMM-DD-HHMM is a time stamp
comprised of a four-digit year (YYYY), three-character month (MMM), two-digit day of the
month (DD), and four-digit time of day (HHMM):
◆ AVAMARSERVER-YYYY-MMM-DD-HHMM-1.log
The .log file contains dpnsummary program session (application log) information.
◆ AVAMARSERVER-YYYY-MMM-DD-HHMM-1.raw
The .raw file contains the actual data collected by dpnsummary.
◆ AVAMARSERVER-YYYY-MMM-DD-HHMM-1.trim
The .trim file contains a subset of the information in the .raw file. The subset of
information is derived by removing periodic backup status messages, which typically
occur every 30 seconds.

dpnsummary 277
EMC CONFIDENTIAL
Command Reference

◆ AVAMARSERVER-YYYY-MMM-DD-HHMM-1.csv
The .csv file presents the data in a format that can be readily imported into
spreadsheet applications for analysis and presentation. Each .csv file record, or row, is
a client backup.
The following table describes the .csv file attributes in the order they appear as
columns from left to right in the .csv file.

Table 198 File attributes in the dpnsummary .csv file (page 1 of 2)

Attribute Description

Host Client hostname as defined in DNS. This is the client that is backing up data to the
Avamar server.

StartValue UNIX time stamp for this operation.

OS Client operating system.

StartTime Date and time this backup was initiated.

Root Starting location (top level directory) in the client file system for this backup.

Seconds Duration in seconds of the client backup.

NumFiles Total number of files examined during this backup.

NumModFiles Total number of modified files stored during this backup.

ModNotSent Total number of modified file bytes not sent to the server due to data
deduplication (this unique sub-file “chunk” already exists on the server).
For example, if during a backup, there was only one changed file that was 100 MB
in size, this would be indicated with NumModFiles=1. Furthermore, if because of
sub-file level data deduplication, only 20 MB of the 100 MB was sent to the server
for storage, then ModNotSent = 80 MB x 1024 KB/MB x 1024 B/KB, and ModSent
= 20 MB x 1024 KB/MB x 1024 B/KB.
This value is of interest in evaluating data deduplication efficiency because this
provides a direct comparison between how much data is sent across the network
during an Avamar backup versus how much data is backed up using standard tape
incremental backup. More generally, it provides a direct indication of how efficient
Avamar’s sub-file data deduplication is versus backing up entire changed files.

ModSent Total number of modified file bytes sent to the server during this backup.

TotalBytes Total number of file bytes examined during this backup.

PcntCommon Data deduplication percentage during this backup. This is derived by way of the
following formula:
100 - (TotalBytes/ModSent)

Overhead Number of bytes COMPOSITE and DIRELEMs used to store data.

This is the amount of non-file data sent across from the client to the server, and
includes such things as indexing information, requests from the client to the
server regarding presence of specific data chunks, ACLs, directory information and
message headers. On any relatively active file system, this is generally a very
small percentage of the file data that is sent to the server.

WorkOrderID Unique identifier for that backup.

For scheduled backups, the backup name is created as follows:
SCHEDULE_NAME-GROUP_NAME-UNIX_TIME_IN_MS

For on-demand backups initiated by way of the Back Up Group Now command on
the Policy window, the backup name is created as follows:
GROUP_NAME-UNIX_TIME_IN_MS

278 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 198 File attributes in the dpnsummary .csv file (page 2 of 2)

Attribute Description

ClientVer Avamar client software version.

Operation One of the following:

• avtarbackup
• avtarrestore
• replsrc
• repldest

Status Final status of that client backup. One of the following:

• DONE—Backup completed, even though it might have had errors, such as
errors associated with open files, and so forth
• RUNNING—Backup is in progress
• TERMINATED—Backup did not complete either because it failed or because the
backup was cancelled
A backup with a status of TERMINATED is immediately eligible to have the data
cleaned up on the server by way of garbage collection and there is no record of the
backup in either the Backup, Restore and Manage window.

SessionID Unique identifier for that client session.

dpnsummary 279
EMC CONFIDENTIAL
Command Reference

dpn-time-config
The dpn-time-config command generates ntp.conf or step-tickers files for Avamar nodes.
Documentation for this script is provided for reference purposes only. The dpn-time-config
program is typically invoked programmatically by mktime and should not be run directly
from the command line.

Synopsis
dpn-time-config KEY=VALUE [--debug] [--has-utility-node] [--help]
[--ips] [--single-node] [--verbose]

Options
The following table lists supported KEY=VALUE pairs for the dpn-time-config command.

Table 199 KEY=VALUE pairs for the dpn-time-config command

KEY=VALUE pair Description

args=FILE Accepts arguments from this FILE ('-' for stdin).

here_admin=IP Specifies the IP address of this Avamar server administrator node.

here_services=IP Specifies the IP address of this Avamar server utility (services) node.

here=SUBNET Specifies this Avamar server IP address or subnet (for example,

10.0.42.0/24).

herenode_zero=IP Specifies the IP address of this Avamar server storage node zero.

herenode=IP Specifies the IP address of any Avamar server storage node.

module_zero=SUBNET Specifies the Avamar server module IP address or subnet that

contains the utility or administrator node.

peer_admin=IP Specifies the IP address of a peer Avamar server administrator node.

peer_services=IP Specifies the IP address of a peer Avamar server utility (services)

node.

peer=SUBNET Specifies a peer Avamar server address or subnet (for example,

10.0.43.0/24).

peernode_zero=IP Specifies the IP address of a peer Avamar server storage node zero.

peernode=IP Specifies the IP address of any peer Avamar server storage node.

server=IP IPv4 address or timezone (selects public servers). Valid timezone

values are:
• alaska—Alaska Time (UTC -9, -8 DST)
• central—U.S. Central Time (UTC -6, -5 DST)
• eastern—U.S. Eastern Time (UTC -5, -4 DST)
• mountain—U.S. Mountain Time (UTC -7, -6 DST)
• pacific—U.S. Pacific Time (UTC -8, -7 DST)

type=TYPE Specifies the TYPE of node to be configured. Valid values are:

• data—Configure for storage nodes
• mcs—Configure for utility node
• services—Configure for utility node
The default type is services node.

280 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

The following options are available for the dpn-time-config command.

Table 200 Command options for the dpn-time-config command

Option Description

KEY=VALUE See the supported pairs in the previous table.

--debug Shows example session information but does not perform the
specified actions.

--has-utility-node Configure for a combined administrator and services node (that is, a
utility node).

--help Shows help, then exits.

--ips Print only the time server IP addresses (for step-tickers).

--single-node Configure for a single-node Avamar server.

--verbose Provides maximum information.

Notes
Consider the following notes for the dpn-time-config command:
◆ In subnet specifications, both net widths and net masks are accepted (for example,
10.0.42.0/24 or 10.0.42.0/255.255.255.0)
◆ Configuration philosophies:
• Do specify customer premises time servers
• Only specify public time servers if fewer than two customer premises time servers
are available
• Never add public time servers to storage nodes

Examples
The following examples use this bash shell script to generate a set of ntp.conf files and
step-tickers files suitable for each different type of node in each module:
#!/bin/bash
prog=dpn-time-config
mkfiles() { for type in services mcs data ; do
${prog} type=$type $2 >ntp.conf.$type-node-$1
${prog} -ips type=$type $2 >step-tickers.$type-node-$1
done
}

Example 1—Use customer premises time servers:

SERVERS="server=10.0.254.19 server=192.168.100.3 server=192.168.200.3"
mkfiles "dpn00" "$SERVERS here=10.0.42.0/24 peer=10.0.43.0/24"
mkfiles "dpn01" "$SERVERS here=10.0.43.0/24 peer=10.0.42.0/24"

Example 2—No customer premises time servers; use public time servers in the U.S. Pacific
timezone:
SERVERS="server=pacific"
mkfiles "dpn00" "$SERVERS here=10.0.42.0/24 peer=10.0.43.0/24"
mkfiles "dpn01" "$SERVERS here=10.0.43.0/24 peer=10.0.42.0/24"

dpn-time-config 281
EMC CONFIDENTIAL
Command Reference

Example 3—No customer premises time servers and no public time servers (use internal
servers only):
mkfiles "dpn00" "here=10.0.42.0/24 peer=10.0.43.0/24"
mkfiles "dpn01" "here=10.0.43.0/24 peer=10.0.42.0/24"

dt and dtsh
The dt command continuously writes data to node hard drives for testing purposes. The
dtsh shell script invokes the dt program with special parameters.

Synopsis
dt -dir=PATH [-bs=SIZE] [-error] [{-f=NUM | -files=NUM | -p=NUM}]
[-fs=SIZE] [{-gb | -mb}] [-pass=NUM] [-pat=NUM] [-ran] [-rexit]
[-rpass=NUM] [-verbose] [-wpass=NUM]

Options
The following options are available for the dt command.

Table 201 Command options for the dt command

Option Description

-bs=SIZE Size of each file block. The default setting is 1 MB.

-dir=PATH Base directory to write files in. Required.

-error dt exits when an error is detected. The default setting is off.

-f=NUM | -files=NUM | -p=NUM Number (NUM) of files to write. The default setting is 1.

-fs=SIZE SIZE of each file. The default setting is 1 GB.

-gb File size is in gigabytes. This is the default.

-mb File size is in MB.

-pass=NUM Number (NUM) of passes to run. The default setting is 1.

-pat=NUM Number (NUM) of patterns to run. The default setting is 14.

-ran Write random data. Only used to generate data, there is no

random data read/compare.

-rexit Exits after first pass when in random mode

-rpass=NUM Number (NUM) of read passes to run. The default setting is

1.

-verbose Enables progress information, which was formerly displayed

by default. The default behavior is to run more silently. dt
now shows a final status message at the end.

-wpass=NUM Number (NUM) of write passes to run. The default setting is

1.

282 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Notes
The dt program should be copied onto every node using mapall copy dt.
A dtsh script, which launches dt on each partition, should be created next, as follows:
dtgen:

!/bin/sh
# Create 4 1GB files of random data
./dt -dir=/data01 -f=4 -ran -pass=1 &
./dt -dir=/data02 -f=4 -ran -pass=1 &
./dt -dir=/data03 -f=4 -ran -pass=1 &
./dt -dir=/data04 -f=4 -ran -pass=1 &
exit 0
dtsh:
#!/bin/sh
# run the disk tester for 4 passes
./dt -dir=/data01 -f=50 -pass=4
./dt -dir=/data02 -f=60 -pass=4
./dt -dir=/data03 -f=60 -pass=4
./dt -dir=/data04 -f=60 -pass=4
exit 0

The dtgen program should be copied onto every node using mapall copy dtgen. You can
then run dt on all the nodes by using mapall --bg ../dtgen.
The dt program creates a working directory QA in each of the -dir parameters specified. dt
creates a logfile in each of the working directories, it looks something like:
admin@node-10-0-53-10:/data01/QA/>: cat node_10_0_53_10__data01_dt.log
Wed Jan 29 19:49:40 2013 hostname=node-10-0-53-10
(node-10-0-53-10.local.avamar.com)
Wed Jan 29 19:49:40 2013 -dir=/data01
Wed Jan 29 19:49:40 2013 -patterns=1
Wed Jan 29 19:49:40 2013 -pass=1
Wed Jan 29 19:49:40 2013 -f=4
Wed Jan 29 19:49:40 2013 -bs=1048576 (KB:1024 mb:1048576
gb:1073741824) Wed Jan 29 19:49:40 2013 -fs=1073741824 Wed Jan 29
19:49:40 2013 Seed = 34464415 Wed Jan 29 19:49:40 2013 pattern=0 Wed
Jan 29 19:49:40 2013 filename=dt.0 Wed Jan 29 19:51:34 2013
filename=dt.0 (W:7659 G:3500) Wed Jan 29 19:51:34 2013 filename=dt.1
Wed Jan 29 19:53:32 2013 filename=dt.1 (W:7672 G:3601) Wed Jan 29
19:53:32 2013 filename=dt.2 Wed Jan 29 19:55:28 2013 filename=dt.2
(W:7697 G:3507) Wed Jan 29 19:55:28 2013 filename=dt.3 Wed Jan 29
19:57:15 2013 filename=dt.3 (W:6979 G:3269) Wed Jan 29 19:57:15 2013
58.6904 MB / Second written (1073741824 4 W:30007 G:13877) Note there
are number prefixed with W:, G:, R: and C: T:

where:
◆ W is the write time in ticks.
◆ G is the data generation time in ticks.
◆ R is the read time in ticks.
◆ C is the compare time in ticks.
◆ T is the total time in ticks.
You should remove the /data0?/QA/dt.* files when dt is finished. For example:
mapall --bg --all rm "/data0?/QA/dt.*"

dt and dtsh 283

EMC CONFIDENTIAL
Command Reference

dump_accounts
The dump_accounts command returns information from the account stripe for each
specified path.
The data that is output from this command is voluminous and should be redirected to a
file. This file can be used as input for the load_accounts program to reload dumped
information into a dpn. This program is primarily used as a development tool.

Synopsis
dump_accounts --hfsaddr=AVAMARSERVER --id=root -ap=PASSWORD
CLIENT-PATH

Options
The following options are available for the dump_accounts command.

Table 202 Command options for the dump_accounts command

Option Description

--ap=PASSWORD Authenticate using PASSWORD.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS).

--id=root Run as root.

CLIENT-PATH Specifies a valid Avamar client path (for example,

/clients/MyClient). Additional client paths can be delimited with
white space.

Notes
Typically, --hfsaddr=AVAMARSERVER is set in a configuration file on the utility node.
Therefore, this option is not normally required on the command line.

284 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

dumpmaintlogs
The dumpmaintlogs command shows server maintenance logs to standard out to assist
with troubleshooting.

Synopsis
dumpmaintlogs [--days=NUM] [--types={cp | gc | hfscheck}]

Options
The following options are available for the dumpmaintlogs command.

Table 203 Command options for the dumpmaintlogs command

Option Description

--days=NUM Specifies the number (NUM) of days for which to print log
files.

--types={cp | gc | hfscheck} Specifies which logs to print. One of the following:

• cp—Checkpoint logs
• gc—Garbage collection logs
• hfscheck—Checkpoint validation (HFS check) logs
If not supplied, checkpoint, garbage collection and
checkpoint validation (HFS check) logs are printed.

Notes
This command added in version 5.0.

dumpmaintlogs 285
EMC CONFIDENTIAL
Command Reference

emserver.sh
The emserver.sh shell script configures the EMS.

Synopsis
emserver.sh {--changelocalap | --flush | --help | --init | --ping
| --renameserver | --restart | --restore | --start | --status
| --stop | --testwebapp}

[--ap=PASSWORD] [--flushfile=FILENAME] [--flushtype=local]

[--hfsaddr=AVAMARSERVER] [--hfsport=PORT] [--id=USER-ID]
[--label=LABEL] [--labelnum=NUM] [--mchostname=HOSTNAME]
[--mcport=PORT] [--mcuserap=PASSWORD]
[--restoretype={new-system | rename-system}] [--rootap=PASSWORD]
[--update] [{--uselocalmcs | --nouselocalmcs}] [--version] [--xml]

Commands
Supply one and only one of the following commands on each command line for
emserver.sh.

Table 204 Commands for the emserver.sh shell script

Command Description

--changelocalap EMC internal use only.

Changes the stored password for the local Avamar server.

--flush Backs up (flushes) EMS data.

--help Shows full online help (commands, options and full descriptions), then exits.

--init Initializes the EMS.

--ping Performs a check (ping) to determine if the EMS is listening.

--renameserver EMC internal use only.

Changes the hostname and IP address of the authenticating Avamar server.

--restart Shuts down all EMS services and restarts them. Each restart is logged.

--restore Restores EMS from a previous flush.

--start Starts the MCS and logs the action.

--status Returns status of each EMS service and any available performance statistics.

--stop Stops the EMS services. Each shutdown is logged.

--testwebapp Provides status of the Apache Tomcat service, which is installed along with
the EMS.

286 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Options
The following options are available for the emserver.sh shell script.

Table 205 Command options for the emserver.sh shell script (page 1 of 2)

Option Description

--ap=PASSWORD Specifies the password for --id=USER-ID.

--flushfile=FILENAME Specifies a local flush file.

--flushtype=local Restores EMS state from a local flush.

--hfsaddr=AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified

hostname (as defined in DNS) from which to from which to restore
the EMS.

--hfsport=PORT Used with --init, --renameserver, or --restore to directly specify

which Avamar server data port to use for user authentication or
restore.
Supplying this option bypasses the corresponding interactive
prompt.
This setting is ignored if EMS authenticates using the local MCS.

--id=USER-ID Specifies an alternate user account (USER-ID) to perform restore.

--label=LABEL Specifies the flush label name from which to restore the EMS.

--labelnum=NUM Specifies the flush sequence number (NUM) from which to restore
the EMS.

--mchostname=HOSTNAME Used with --init or --renameserver to directly specify which MCS

hostname or IP address to use for user authentication.
Supplying this option bypasses the corresponding interactive
prompt.
This setting is ignored if EMS authenticates using the local MCS.

--mcport=PORT Used with --init or --renameserver to directly specify which MCS data
port to use for user authentication.
Supplying this option bypasses the corresponding interactive
prompt.
This setting is ignored if EMS authenticates using the local MCS.

--mcuserap=PASSWORD Used with --init or --renameserver to directly specify the MCUser

account PASSWORD on the authenticating MCS.
Supplying this option bypasses the corresponding interactive
prompt.
This setting is ignored if EMS authenticates using the local MCS.

--restoretype= Used with --restore to specify the type of restore operation.

{new-system
| rename-system} If --restoretype is not supplied, a normal (non-disaster recovery)
restore is performed.
Use --restoretype=new-system to support system upgrades and
disaster recovery in cases where a source Avamar server has been
completely replicated to a destination server, and the destination
server is brought online to replace the old source server, or if you
are using the source Avamar server as a “swing box.”
Use --restoretype=rename-system when the Avamar server
hostname or IP address has been changed.

emserver.sh 287
EMC CONFIDENTIAL
Command Reference

Table 205 Command options for the emserver.sh shell script (page 2 of 2)

Option Description

--rootap=PASSWORD Used with --init or --renameserver to directly specify the root

account PASSWORD on the authenticating MCS.
Supplying this option bypasses the corresponding interactive
prompt.
This setting is ignored if EMS authenticates using the local MCS.

--update Updates EMS datastore and preferences following a software

upgrade.

--uselocalmcs Used with --init or --renameserver to bypass the corresponding

interactive prompt and specify that the EMS should authenticate
locally.

--version Shows version, then exits.

--xml Used with --status to output an XML document instead of the

standard --status output.

emwebapp.sh
The emwebapp.sh shell script starts and stops the Apache Tomcat service with the JVM
parameter to enable the JVM to allocate more memory.

Synopsis
emwebapp.sh {--error | --help | --restart | --run | --start | --stop |
--test | --update}

Commands
Supply one and only one of the following commands on each command line for
emwebapp.sh.

Table 206 Commands for the emwebapp.sh shell script

Command Description

--error EMC internal use only.

--help Shows online help, then exits.

--restart Performs a stop, then a start. Equivalent to running emwebapp.sh --stop, then
emwebapp.sh --start.

--run EMC internal use only.

--start Starts the Apache Tomcat service.

--stop Stops the Apache Tomcat service.

--test Provides status of the Apache Tomcat service.

--update Forces a configuration update.

This command added in version 4.0.

Notes
The emwebapp.sh shell script must be run as root.

288 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

errchk
The errchk command that scans a series of log files created by the operating system and
Avamar server software and creates a time stamped plain text log file, which can be sent
to EMC Customer Support for examination.
The errchk program does not attempt to assess the server health. It is merely a filtering
tool. Therefore, the generated log file must be examined by EMC Customer Support to
determine if there are issues that require correction or additional investigation.
No user data that has been backed up from client systems is included in the errchk output
file.

Output
The errchk program generates a text file with a time/date stamp in the current working
directory. The output log filename has the format errchk-YYYY-MM-DD-HHMM.txt.
Each errchk log file can potentially contain the following kinds of entries:
◆ Operating system kernel and I/O errors for all nodes retrieved from /var/log/messages
files
◆ Internal Avamar server errors retrieved from gsan.log files
◆ Errors from cron jobs run on utility node
◆ Check of node state, access mode and loadavg on all storage nodes
◆ All Avamar server stripes that are not ONLINE
◆ All checkpoints and whether they have been hfschecked
◆ Full NODELIST data for each server node

Notes
Consider the following notes for the errchk program:
◆ Any kernel and I/O errors retrieved from /var/log/messages files are probably reason
for concern. In particular, hard drive or DMA drive errors probably indicate hardware
trouble.
◆ Any Avamar server errors retrieved from gsan.log files should be reported to EMC
Customer Support. While not all errors are serious, they should be reviewed by EMC
Customer Support. Environmental conditions such as temporary network outages can
generate server errors that are temporary and have no lasting impact after the
situation is corrected.
◆ Scrutinize any errors from cron jobs run on the utility node. This typically indicates that
a regular maintenance process (checkpoint, daily data integrity check and garbage
collection) might not have run correctly. These should be reported to EMC Customer
Support.
◆ Scrutinize the check of node state, access mode and loadavg on all storage nodes.
Verify that all nodes are ONLINE, all access modes are normal and all loadavgs are 2
or less. If any nodes are OFFLINE or the access mode is anything other than normal,
contact EMC Customer Support.

errchk 289
EMC CONFIDENTIAL
Command Reference

◆ Scrutinize the list of all Avamar server stripes that are not ONLINE. If any stripes are
designated OFFLINE or OFFLINE_MEDIA_ERROR, contact EMC Customer Support. If
stripes are MIGRATING, then a node data migration operation is being performed.
◆ Scrutinize the list of checkpoints and verify that the last checkpoint was created within
the last 12 hours and that at least one checkpoint passed a daily data integrity check
within the last 24 hours.

Example
errchk
Creating errchk-2013-03-19-1207.txt...
Searching /var/log/messages files
Searching GSAN log files
Searching MC log files
Searching cron job log files
Checking node status
Checking stripe status
Getting list of checkpoints
Getting full nodelist
Done: 13492 errchk-2013-03-19-1207.txt

evening_cron_run
The evening_cron_run program runs the evening cron job. It invokes cp_cron and gc_cron,
and is itself intended to be invoked by cron_env_wrapper.



Beginning with version 5.0, this command has been deprecated.

To run this script directly from a command shell, type the following:
cron_env_wrapper evening_cron_run

This command must be run as user dpn. This program attempts to load the dpnid
OpenSSH key from the dpn user .ssh directory. This command fails if it is run as a different
user.

290 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

expire-snapups
The expire-snapups command writes a script to stdout, which when run, changes backup
expiration dates.
By default, backups are selected if the backups have creation times later than 90 days
before the time at which the program is run.

Synopsis
expire-snapups [--after=DATE] [--before=DATE] [--days=NUM]
[--domain=DOMAIN] [--help] [--include_mc_backups]
[--replicate --dstserver=SERVER --dstid=USER@PATH
--dstpassword=PASSWORD [--dstdomain=DOMAIN]] [CLIENT-PATH ...]

Options
The following options are available for the expire-snapups command.

Table 207 Command options for the expire-snapups command (page 1 of 2)

Option Description

--after=DATE If supplied, all backups created after this date are eligible to be
expired. The default DATE setting is 90 days ago.

--before=DATE If supplied, all backups created before this date are eligible to be
expired. The default DATE setting is now (the time at which
expire-snapups is invoked).

--days=NUM Specifies the backup expiration date and time as the number (NUM)
of whole days from today. The default setting is 90 days from the
initial backup creation date.

--domain=DOMAIN If supplied, all clients within the specified client DOMAIN are
processed.
If not supplied, all clients are processed.

--help Shows help, then exits.

--include_mc_backups If supplied, all clients within the special MC_BACKUPS domain are
also processed. Because MC_BACKUPS is a special system domain,
the default behavior is to not process these clients unless this option
is explicitly supplied.

expire-snapups 291
EMC CONFIDENTIAL
Command Reference

Table 207 Command options for the expire-snapups command (page 2 of 2)

Option Description

--replicate If supplied, processes backups on the replication target server

specified by the following options:
• --dstserver=SERVER—Specifies a fully qualified DNS name or IP
address of the destination Avamar server (SERVER). This option is
required with --replicate.
• --dstid=USER@PATH—Authenticate on the destination Avamar
server as this Avamar user ID (account name) at this domain. USER
is the Avamar username, and PATH is the Avamar server domain.
For example, supplying --dstid=admin@/REPLICATE/avamar-1,
specifies that the admin user account in the destination server
/REPLICATE/avamar-1 domain should be used to authenticate this
replication session.
This is useful for allowing selective replication on a
domain-by-domain basis.
This option is required with --replicate.
• --dstpassword=PASSWORD—PASSWORD for the --dstid user
account. This option is required with --replicate.
• --dstdomain=DOMAIN—If supplied, all clients within the specified
client DOMAIN on the replication target server are processed. If not
supplied, all clients on the replication target server are processed.

CLIENT-PATH Specifies a valid Avamar client path (for example, /clients/MyClient).

Additional client paths can be delimited with white space.
Client paths must always terminate with a valid Avamar client name.
You cannot specify a client domain in this manner. Use --domain to
process all clients within a particular domain.
If not supplied, all clients are processed. This is the default setting.

Notes
The DATE specifier can be any date string acceptable to date(1). For GNU date(1), which on
Linux is /bin/date, DATE can be just about any common date string, including such
phrases as “2 weeks ago.”

292 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

gathergsankeydata
The gathergsankeydata command gathers essential server information and writes it to an
output file, which is then used to generate a server license key file.
The gathergsankeydata command can be run interactively or non-interactively.
Non-interactive mode is primarily used to support use of this program by other utilities.

Synopsis
gathergsankeydata [--account_id=CUSTOMER-ID]
[--asset_reference_id=ASSET-ID] [--interactive]
[--internet_domain=INTERNET-DOMAIN] [--output=PATH] [--run]

Options
The following options are available for the gathergsankeydata command.

Table 208 Command options for the gathergsankeydata command

Option Description

--account_id=CUSTOMER-ID Specifies the numeric CUSTOMER-ID, which is found

on each EMC Purchase Order Confirmation.

--asset_reference_id=ASSET-ID Specifies the system asset reference ID, which is

found on each EMC Purchase Order Confirmation.

--interactive Specifies whether to run gathergsankeydata

interactively (default) or non-interactively.

--internet_domain=INTERNET-DOMAIN Specifies the Internet domain for the account.

--output=FILE Directory path and filename of output FILE. The

default setting is gsankeydata.xml. Use dash (-) for
stdout.

--run Specifies run (default) or dry-run modes.

Files
The gathergsankeydata command uses the following files.

Table 209 Files used by the gathergsankeydata command

File Description

TOP/var/probe.xml Static node information

TOP/var/mail.log Email log file

gathergsankeydata 293
EMC CONFIDENTIAL
Command Reference

gcblitz
The gcblitz command enables the maximum amount of Avamar storage to be reclaimed in
the minimum amount of time. This is accomplished by running multiple garbage collection
passes in immediate succession.

Synopsis
gcblitz [--buffer=PERCENT] [--debug] [--gcs=NUM] [--help]
[--iterations=NUM] [--keepcp=NUM] [--log] [--logdir=PATH]
[--logfile=FILE] [--logname=FILE] [--nohfscheck] [--norefcheck]
[--quiet] [--show] [--sleep=SEC] [--thresholds=NUM] [--verbose]
[--version] [--yes]

Options
The following options are available for the gcblitz command.

Table 210 Command options for the gcblitz command (page 1 of 2)

Option Description

--buffer=PERCENT Specifies the buffer percentage (that is, the percentage, PERCENT, below
first stop threshold at which to set the full threshold). The default setting is
mid-way between read-only and first stop.

--debug Shows example session information but does not perform the specified
actions.

--gcs=NUM Specifies the maximum number (NUM) of garbage collection passes to

perform. The default setting is 10000.

--help Shows help, then exits.

--iterations=NUM Specifies the maximum number (NUM) of iterations to run this command.
The default setting is 1000.

--keepcp=NUM Specifies the number (NUM) of checkpoints to keep. The default setting is
3.

--log If supplied, logging is enabled. The default setting is to enable logging.

--logdir=PATH Specifies the log file location (PATH). The default setting is
/usr/local/avamar/var.

--logfile=FILE Specifies the log filename with a path. The default setting is
/usr/local/avamar/var/gcblitz_DATE_TIME.log, where DATE and TIME are a
calendar date and timestamp, respectively.

--logname=FILE Specifies the log filename without a path. The default setting is
gcblitz_DATE_TIME.log, where DATE and TIME are a calendar date and
timestamp, respectively.

--nohfscheck Does not perform hfscheck after each checkpoint creation This is not the
default.

--norefcheck No not check references during garbage collections. This is not the default.

--quiet Suppresses all output and input. This is not the default.

--show If supplied, shows but does not perform the actions.This is not the default.

--sleep=SEC Specifies the number of seconds (SEC) to sleep gc, hfscheck, or cp

processes.

294 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 210 Command options for the gcblitz command (page 2 of 2)

Option Description

--thresholds=NUM Specifies the warning, read-only, and stop thresholds. The default settings
vary by model.

--verbose Provides maximum information.

--version Shows version, then exits.

--yes Automatically answers yes to all prompts. This is not the default.

Notes
Full output is always written to the log file if logging is enabled.

gcblitz 295
EMC CONFIDENTIAL
Command Reference

gc_cron
Garbage collection cron job. The gc_cron program is intended to be run as a cron job that
performs garbage collection.



Beginning with version 5.0, this command has been deprecated in favor of avmaint
garbagecollect.

Synopsis
gc_cron [--convcount=NUM] [--conversion] [--convtime=SEC] [--full]
[--gccount=NUM] [--killbackups=SEC] [--limitadjust={+ | -}LIMIT]
[--passes=NUM] [--pollrate=SEC] [--refcheck]
[--throttlelevel=PERCENT] [--timeout=SEC] [--usehistory]

Options
The following options are available for the gc_cron command.

Table 211 Command options for the gc_cron command (page 1 of 2)

Option Description

--convcount=NUM Specifies the maximum number (NUM) of stripes that are

converted on each node following this gc_cron session.

--conversion Specifies whether to convert pre-3.5 data stripes to version 3.5

data stripes. The default setting is true.

--convtime=SEC Specifies the maximum amount of time that avmaint conversion is

allowed to run following each gc_cron session.

--full Specifies the kind of status to be obtained and displayed.

--gccount=NUM Specifies the number (NUM) of index stripes per node to garbage
collection. The default setting is 16.

--killbackups=SEC If supplied, any backups in progress are forcibly stopped after

waiting the specified number of seconds (SEC).
If not supplied or set to zero, backups are not forcibly stopped.
This option added in version 4.0.

--limitadjust= Used with --usehistory to increase or decrease computed garbage

{+ | -}LIMIT collection quota by LIMIT percent. The default setting is zero (0).
For example, if history computes that NN GB should be garbage
collected, then using --limitadjust=+50 increases that amount to
NN + (NN*50%) GB. Alternatively, supplying --limitadjust=-25
decreases that amount to NN - (NN*25%) GB.
This option added in version 4.1.

--passes=NUM Specifies the maximum number (NUM) of garbage collection

passes. The default setting is 100 passes.

--pollrate=SEC Specifies the interval in seconds (SEC) at which the server is

polled for garbage collection status. The default setting is 60
seconds.

--refcheck Forces check of composite references during garbage collection or

HFS check, respectively.

296 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 211 Command options for the gc_cron command (page 2 of 2)

Option Description

--throttlelevel=PERCENT Specifies the throttling percentage (PERCENT). This value reduces

the garbage collection operation’s system resource (CPU, disk,
bandwidth, and so forth) usage by this percentage. The default
setting is zero (that is, no throttling), which means that the
garbage collection operation’s system resource usage is
potentially 100%).
This option added in version 4.0.

--timeout=SEC Specifies the maximum number of seconds (SEC) garbage

collection process is allowed to run. The default setting is 3600
seconds (1 hour).

--usehistory Enables or disables garbage collection history feature, which

limits the amount of garbage collection performed to an amount
that frees up at least as much space as has been used by the daily
average of all backups over the last several days. The default
setting is true.
This option added in version 4.1.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 212 Deprecated command options for the gc_cron command

Option Description

--killsnapups=SEC This option added in version 4.0, and deprecated in version 5.0 in favor of
--killbackups.
If supplied, any backups in progress are forcibly stopped after waiting the
specified number of seconds (SEC).
If not supplied or set to zero, backups are not forcibly stopped.

Notes
Consider the following notes for the gc_cron command:
◆ You must run gc_cron as user dpn.
◆ Beginning with version 4.0, if gc_cron is forcibly terminated by an external signal (for
example, using the kill command), it stops garbage collection on the storage server
(also known as GSAN).
◆ The gc_cron program initiates a stripe conversion session by invoking avmaint
conversion on exit and passing in the --convcount and --convtime options.

gc_cron 297
EMC CONFIDENTIAL
Command Reference

gc_report
The gc_report command is used to evaluate and summarize information in the garbage
collection logs.

Synopsis
gc_report [--logfile=FILE] [--help] [--summary] [--suppress]
[--version] [--zero]

Options
The following options are available for the gc_report command.

Table 213 Command options for the gc_report command

Option Description

--logfile=FILE Specifies an altenative log file to process.

--help Shows help, then exits.

--summary If supplied, do not show detailed report.

--suppress If supplied, suppress any entries where zero bytes were freed.

--version Shows version, then exits.

--zero If supplied, only show results when zero bytes were freed.

Notes
Consider the following notes for the gc_report command:
◆ Grand total results at the end of some summaries are only calculations for the output
that was specified. If --zero is supplied, the results only reflect the sums and averages
of what was freed in all zero sessions. If --suppress is supplied, the grand total sums
and averages only reflect what was freed under those circumstances.
◆ The detailed summary is purely raw data that remains untouched regardless of --zero
or --suppress.

Example
gc_report
GARBAGE COLLECT GENERAL SUMMARY
/usr/local/avamar/var/cron/gc.log:
DATE #PASSES AVG BYTES FREED TOTAL BYTES FREED
2013/03/22-22:07:59 3 5,073,338,666 15,220,015,998
2013/03/23-10:08:21 3 4,264,684,525 12,794,053,575
2013/03/24-10:09:14 7 1,447,075,233 10,129,526,633
2013/03/26-10:06:25 57 138,388,837 7,888,163,702

298 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

gen-ssl-cert
The gen-ssl-cert command installs a temporary Apache web server SSL cert and restarts
the web server.

Synopsis
gen-ssl-cert [--debug] [--help] [--verbose]

Options
The following options are available for the gen-ssl-cert command.

Table 214 Command options for the gen-ssl-cert command

Option Description

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits.

--verbose Provides maximum information.

Notes
Consider the following notes for the gen-ssl-cert command:
◆ You must run the gen-ssl-cert as root.
◆ Original files are backed up and saved as:
• /etc/httpd/conf/ssl.crt/server.crt.orig
• /etc/httpd/conf/ssl.key/server.key.orig

gen-ssl-cert 299
EMC CONFIDENTIAL
Command Reference

gethostbyname
The gethostbyname command shows name resolution in the same way that programs
using gethostbyname() and gethostbyaddr() libc functions do.

Synopsis
gethostbyname HOST-NAME

Notes
This command is primarily intended for use by EMC personnel only.

Examples
The following command returns all hostnames resolving to ntp.
gethostbyname ntp
gethostbyname(ntp) => 192.168.100.3, 192.168.100.5, 192.168.100.7
gethostbyaddr(192.168.100.3) => vortex.example.com
gethostbyaddr(192.168.100.5) => central.example.com
gethostbyaddr(192.168.100.7) => epicenter.example.com

The following command returns all hostnames resolving to “mail.”

gethostbyname mail
gethostbyname(mail) => 192.168.100.3
gethostbyaddr(192.168.100.3) => vortex.example.com

300 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

getlogs
The getlogs command gathers important log files from all server nodes and writes them to
local utility node directories where they can be viewed and analyzed to support
maintenance and troubleshooting activities.
The precise mechanism for accomplishing this is:
1. The getlogs program copies getnodelogs to each node in the system and runs it.
2. The getnodelogs program gathers the important log files from that node and
compresses them into a single tar file (nodelogs.tgz).
3. The getlogs program creates a master tar file on the utility node, which contains the
individual nodelogs.tgz.
The getlogs program accepts an optional filename (FILE). If not supplied, the default
filename, logs.DATE.tar is used, where DATE is an eight character date code (YYYYMMDD)
and six-character timestamp (HHMMSS).

Synopsis
getlogs [--server={today | yesterday | week | restart | NUM-DAYS}]
[--verbose] [FILE]

Options
The following options are available for the getlogs command.

Table 215 Command options for the getlogs command

Option Description

--server={today | yesterday Controls how much of the gsan logs should be

| week | restart | NUM-DAYS} downloaded. One of the following:
• today—Download the previous 24 hours worth of
server log files.
• yesterday—Download the previous 48 hours worth of
server log files.
• week—Download the previous 168 hours worth of
server log files.
• restart—Download all gsan log files since the last
restart.
• NUM-DAYS—Download this number of days
(NUM-DAYS) worth of server log files.
If --server is not supplied, all server log files are
downloaded.

--verbose Provides maximum information.

getnodelogs
The getnodelogs command is invoked by getlogs which copies it to each node in the
system. When run locally from each node, getnodelogs gathers the important log files
from that node and compresses them into a single tar file, nodelogs.tgz.

getlogs 301
EMC CONFIDENTIAL
Command Reference

getsnapupstats
The getsnapupstats command invokes avmgr and avtar to return a list of backups that
were successfully performed on the specified host, then downloads the backup statistics
from the server into a local working directory. The script then creates a compressed tar file
(.tgz) that contains all of the statistics. This binary file can then be sent to EMC Customer
Support for examination.
No user data that has been backed up from client systems is included in getsnapupstats
data.
The following data is collected for each backup.

Table 216 Data collected by the getsnapupstats command

Value Description

archive_info Original avtar command line.

filestats Statistics on the top 500 files.

groups List of group IDs.

machine.xml Client machine characteristics (Windows only).

mbr0.bin Master boot record (Windows only).

mounts List of mount points.

partitiontables.xml Partition table (Windows only).

smartdata.xml SMART hard drive data (Windows only).

statsfile Progress reports sent to server every 30 seconds.

users List of user IDs.

vbr0-0.bin Volume boot record (Windows only).

volumes.xml List of volumes (Windows only).

workorder Original workorder provided by MCS.

All files are plain text files.

Synopsis
getsnapupstats --path=LOCATION [--id=USER@AUTH]
[{--ap=PASSWORD | --password=PASSWORD}] [OPTIONS] [--max=n]

Options
The following options are available for the getsnapupstats command.

Table 217 Command options for the getsnapupstats command (page 1 of 2)

Option Description

--path=LOCATION Specifies a hierarchical LOCATION on the Avamar server. This option is

relative to the current home location, unless a slash (/) is used as a
prefix to the path designation, in which case an absolute path is
assumed.

302 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 217 Command options for the getsnapupstats command (page 2 of 2)

Option Description

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the authentication system
used by that user. The default internal authentication domain is
“avamar.”
For example: jdoe@avamar.

--ap=PASSWORD | PASSWORD for the --id=USER@AUTH account.

--password=PASSWORD

OPTIONS avmgr or avtar options. These options are passed directly to avmgr
and avtar without interpretation.

--max=n Optional flag to specify the maximum number of backups to examine.

Backups are examined in most recent to least recent order.
For example, supplying --max=10 returns statistics for the ten most
recent backups.
The default behavior is to return all backup statistics for the HOST.

Output
The getsnapupstats program creates a local directory based on the client hostname
supplied with --path, then creates a compressed tar file (.tgz) containing everything in the
local directory. You should delete this working directory after running the program.

Example
getsnapupstats --path=/clients/my-client --id=root --ap=*****
Restoring my-client/10:avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=10 --target=my-client/10
Restoring my-client/9: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=9 --target=my-client/9
Restoring my-client/8: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=8 --target=my-client/8
Restoring my-client/7: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=7 --target=my-client/7
Restoring my-client/6: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=6 --target=my-client/6
Restoring my-client/5: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=5 --target=my-client/5
Restoring my-client/4: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=4 --target=my-client/4
Restoring my-client/3: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=3 --target=my-client/3
Restoring my-client/2: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=2 --target=my-client/2
Restoring my-client/1: avtar -x --quiet --keep-old=false --path=/clients/my-client
--id=root --ap=***** --internal .system_info --labelnum=1 --target=my-client/1

Creating my-client.tgz:tar cfz my-client.tgz my-client

my-client.tgz created. You may delete the local temporary directory 'my-client'.

getsnapupstats 303
EMC CONFIDENTIAL
Command Reference

health_check.pl
The health_check.pl Perl script returns a status report for the Avamar server. The
health_check.pl Perl script displays a summary that contains status for the following:
◆ Subsystem summary
◆ Per-node GSAN
◆ Checkpoint
◆ Checkpoint validation (hfscheck)
◆ Garbage collection
◆ Key configuration parameters
◆ Per-node storage capacity
◆ Per-node time server
Starting with Avamar 4.1 the dpnugprep package contains a new version of
health_check.pl. This version of health_check.pl runs either directly from the command
line or as a subprogram of avupos.
The health_check.pl Perl script requires login to the admin user in an ssh-agent context
with either the dpnid or admin_key loaded.

Synopsis
su - admin
ssh-agent bash
ssh-add ~/.ssh/dpnid
health_check.pl [--help] [--log=PATH] [--norequire_sched_up]
[--norequire_unattended_startup]

Options
The following options are available for the health_check.pl Perl script.

Table 218 Command options for the health_check.pl Perl script

Option Description

--help Shows help, then exits.

--log=PATH Specifies a logfile PATH.

--norequire_sched_up Bypasses the check to determine if the scheduler is

running.
The default setting is to check the running status of the
scheduler.

--norequire_unattended_startup Bypasses the check to determine if unattended startup is

enabled on a single-node server.
The default setting is to check the status of unattended
startup on a single-node server.

Notes
Consider the following notes for the health_check.pl Perl script:
◆ The health_check.pl Perl script is located in /usr/local/avamar/bin/.
◆ Run health_check.pl before and after performing a manual upgrade.
◆ This Perl script added in version 4.0.1.

304 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Output
The following excerpt is an example of the output from the health_check.pl program:
===========================================
==== Health Check Summary ====
===========================================
Logfile: /tmp/health.20130312-1405
Total Number of Errors: 3
Errors to be reviewed:
20130312-1405.49: ERROR: Last hfscheck was not successful! (errcode=4004)
20130312-1405.49: ERROR: Garbage collecting less than 10GB per pass! (averaging 3.79 GB)
20130312-1405.51: ERROR: Error(s) found in err.log file.
Please review /tmp/health.20130312-1405 for more info.

The Health Check Summary also includes status for the dpnctl program. The following
output illustrates status for dpnctl:
dpnctl: INFO: gsan status: ready
dpnctl: INFO: MCS status: up.
dpnctl: INFO: EMS status: up.
dpnctl: INFO: Scheduler status: up.
dpnctl: INFO: Maintenance operations status: enabled.
dpnctl: INFO: Unattended startup status: disabled.

health_check.pl 305
EMC CONFIDENTIAL
Command Reference

hfscheck_cron
The hfscheck_cron program is primarily intended to be run as a cron job to start an HFS
check. However, hfscheck_cron can also be run directly to perform an on-demand HFS
check or create a list of valid checkpoints in the system.



Beginning with version 5.0, this command has been deprecated in favor of avmaint
hfscheck.

Synopsis
hfscheck_cron [--checkdata=PERCENT] [--checkpoint=CP-ID]
[--checkpoints=FILE] [--cleanup] [--concurrentdatastripes=NUM]
[--concurrentindexstripes=NUM] [--concurrentparitystripes=NUM]
[--full] [--gccount=NUM] [--metadata] [--modified=NUM] [--oldstyle]
[--refcheck] [--rolling] [--scheduleconffile=FILE] [--suspend]
[--throttle] [--useschedule] [--xmlperline=NUM]

Options
The following options are available for the hfscheck_cron command.

Table 219 Command options for the hfscheck_cron command (page 1 of 3)

Option Description

--checkdata=PERCENT If a rolling HFS check is specified, this percentage

(PERCENT) of data stripes is checked.
If the number of modified stripes is less than this value,
the oldest unchecked stripes are selected up to this limit.
If more than this number of modified stripes is checked, no
unmodified stripes are selected.
Therefore, the default value of 0 only checks modified
stripes.
A value of 100 converts the check into a full check.
The default setting is zero (0).
This option added in version 5.0.

--checkpoint=CP-ID Specifies which checkpoint should be processed. If

supplied, HFS check is performed on this checkpoint CP-ID.
If not supplied, HFS check is performed on the most recent
unvalidated checkpoint file.

--checkpoints=FILE Specifies the location and filename for the checkpoints

listing file. The default location is
/usr/local/avamar/var/checkpoints.xml.

--cleanup If supplied, all temporary working directories and files are

removed when the HFS check completes. This is the
default setting.
Supplying --nocleanup preserves these directories and can
be used to recover the HFS check log files.

--concurrentdatastripes=NUM Specifies the maximum number of data stripes that are

simultaneously processed on a single node during an
index sweep. The higher the value, the more concurrent
work is being performed. The default setting is 0 (one per
disk).

306 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 219 Command options for the hfscheck_cron command (page 2 of 3)

Option Description

--concurrentindexstripes=NUM Specifies the maximum number of index stripes that are

simultaneously processed on a single node during an
index sweep. The higher the value, the more concurrent
work is being performed. The default setting is 2.

--concurrentparitystripes=NUM Specifies the maximum number of parity stripes that are

simultaneously processed on a single node during a parity
sweep. The higher the value, the more concurrent work is
being performed. The default setting is 0 (one per disk).

--full Performs a full HFS check.

This option added in version 4.0.

--gccount=NUM Specifies the maximum number of index stripes per node

that are to be reference checked. The default setting is 16.

--metadata Performs a metadata-only HFS check.

This option added in version 4.0.

--modified=NUM Used with --checkdata=PERCENT to specify the number of

data stripes that are checked. NUM must be one of the
following:
• 0—Any modification causes a stripe to be marked as
modified.
• 1—Only modified stripe data portions causes a stripe to
be marked as modified.
• 2—Identifies data stripes that have only had their chunk
ID list changed and skips all further checks. This
improves HFS check performance by ignoring data
chunks that have been marked for deletion by garbage
collection. This is the default setting. This setting added
in version 5.0.4.
• nn—Two-digit integer.
This option added in version 5.0.

--oldstyle Reverts the command behavior to earlier versions. In

particular, only info codes 4003 (success) and 4004
(failure) are used. The new behavior reserves code 4003
for a full successful check, code 4004 for any observed
failure and code 4006 for successful partial, single or
reduced checks.
This option also affects the display of the terminating
cplist command.
This option added in version 3.7.1.

--refcheck Performs a refcheck-only HFS check.

This option was deprecated for versions 3.5 through 4.0 in
favor of --checks. Beginning with version 4.0, it is again
valid.

--rolling Performs a rolling HFS check.

This option added in version 5.0.

--scheduleconffile=FILE Use the specified configuration FILE to schedule

hfscheck_cron operations. The default hfscheck_cron
schedule file is
/usr/local/avamar/var/hfsscheduleconf.xml.
This option added in version 4.0.

hfscheck_cron 307
EMC CONFIDENTIAL
Command Reference

Table 219 Command options for the hfscheck_cron command (page 3 of 3)

Option Description

--suspend Specifies that dispatchers should be suspended during

HFS check start up (at the same time that server access
mode is set to read-only). This is not the default setting.

--throttle If supplied, throttling is used to conserve resources during

the specified HFS check. This is the default setting.
This option added in version 5.0.

--useschedule Allows for the use of the schedule configuration file with
HFS check. The default setting is false.
This option is ignored if --full, --metadata, or --refcheck is
also supplied.
This option added in version 4.0.

--xmlperline=NUM Controls number (NUM) of XML attributes per line.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 220 Deprecated command options for the hfscheck_cron command (page 1 of 2)

Option Description

--autorepair This option added in version 5.0 and deprecated in version 6.0.
Enables auto-repair if errors detected. This is the default setting,
but occasionally it might be of use to suppress the evaluation
phase of a rolling HFS check, particularly when testing.

--checks=DESCRIPTOR Deprecated in version 5.0. Supplying this option in a version 5.0 or

later context returns an error.
DESCRIPTOR must be a valid enabling descriptor string that
describes which checks are to be performed on which stripe
classes.
Stripe classes can be any or all of the following:
• h—HFS stripes
• p—Persistent stripes
• u—Accounting stripes
Checks can be any or all of the following:
• a—Atomic data sweeps
• c—Composite data sweeps
• p—Parity checks
• r—Reference checking
For example, the descriptor hpu+acpr Is equivalent to the default
behavior (perform all checks on all stripe classes).
You can also constrain an HFS check to only process a percentage
of the total stripes by prefixing a desired processing percentage
(as an integer between 1 and 99). For example: 50:hpu.
The default setting is 0 (process 100% of eligible stripes).

--checknode=MODULE.NODE Deprecated in version 5.0. Supplying this option in a version 5.0 or

later context returns an error.
Enables single-node HFS check on this MODULE.NODE.

308 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 220 Deprecated command options for the hfscheck_cron command (page 2 of 2)

Option Description

--deadline=MIN Deprecated in version 5.0. Supplying this option in a version 5.0 or

later context returns an error.
Specifies the HFS check deadline in minutes (MIN). The default
setting is zero (no deadline).

--parity This option added in version 4.0 and deprecated in version 5.0.
Overrides the default schedule for the day to perform a parity-only
HFS check. Functionally equivalent to --checks=0:hpu+p.
Cannot be combined with --checks.

--keepmin This option added in version 4.0 and deprecated in version 5.0.
Enables the keep minimal checkpoints feature for this session.

--throttlelevel=NUM Deprecated in version 5.0 in favor of --throttle.

Specifies the amount of throttled resources (measured as a
percentage of CPU capacity) that can be allocated to other tasks.
For example, a setting of 20 begins throttling once CPU usage
exceeds 80%. Values in excess of 100 are treated as 100%
(maximum throttling); a value of zero specifies that no throttling is
to be performed.
If a deadline is specified, the throttle level indicates a maximum
allowable throttle level, and the throttle level starts at half this
value.
The default setting is 20 if no deadline is specified; 40 if deadline
is specified.

Notes
Consider the following notes for the the hfscheck_cron command:
◆ You must run the hfscheck_cron command as user dpn.
◆ If a schedule configuration file is not present as specified by the
--scheduleconffile=FILE option or the file contains errors, hfscheck_cron runs a full
HFS check.

Input file
You can only specify one checktype for any given day of the week. If an entry is missing for
one or more days, then hfscheck_cron runs a full HFS check.
Multiple checktypes for the same day of the week are considered errors. This invalidates
the schedule configuration file and halts HFS checks until a valid schedule configuration
file is present as specified by the --scheduleconffile=FILE option. However, hfscheck_cron
still runs a full HFS check when it is invoked on the command line even if the schedule
configuration file is invalid.
The schedule configuration file must conform to the following format:
<hfscheckactivitylist>
<hfscheckactivity checks="full" dayofweek="Saturday"/>
<hfscheckactivity checks="metadata" dayofweek="Monday"/>
<hfscheckactivity checks="rolling" dayofweek="Tuesday"/>
<hfscheckactivity checks="rolling+metadata" dayofweek="Wednesday"/>
<hfscheckactivity checks="metadata" dayofweek="Thursday"/>
<hfscheckactivity checks="rolling" dayofweek="Friday"/>
</hfscheckactivitylist>

hfscheck_cron 309
EMC CONFIDENTIAL
Command Reference

The syntax for specifying a rolling HFS check is “rolling[:PERCENT:MODIFIED],” where

PERCENT is an optional checkdata value for the rolling HFS check, and MODIFIED is an
optional associated modified value.

Output
A description of hfscheck_cron output is available in “avmaint hfscheckstatus” on
page 114.

hfscheck_kill
The hfscheck_kill command gracefully terminates a currently running hfscheck process.

Synopsis
hfscheck_kill [--ap=PASSWORD] [--bindir=PATH] [--duplog] [--error]
[--flagfile=FILE] [--hfsaddr=AVAMARSERVER] [--help]
[--id=USER@AUTH] [--infomsgs] [--logfile=FILE] [--mcserver]
[--n | --norun] [--nodedb=FILE] [--nodes=NODE-LIST] [--override]
[--password=PASSWORD] [--ping_only] [--pswd=PASSWORD]
[--q | --quiet] [--run] [--runasanyuser] [--savesysinfo]
[--server=AVAMARSERVER] [--timestamps] [--user=USER-ID]
[--v | --verbose] [--vardir=DIR]

Options
The following options are available for the hfscheck_kill command.

Table 221 Command options for the hfscheck_kill command (page 1 of 2)

Option Description

--ap=PASSWORD Specifies the PASSWORD for the --id account. Same as --password
and --pswd.

--bindir=PATH Sets the directory containing Avamar binary files. This directory is
specified during Avamar client installation. The default setting is
/usr/local/avamar/bin.

--duplog If supplied, causes script output to be written to standard output

even if the output is also written to a log file.

--error Generates error when execution fails.

--flagfile=FILE Specifies the FILE containing a list of options and values that are
processed by this program as if they were included on the command
line. The default setting is /usr/local/avamar/etc/usersettings.cfg.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS). Same as --server; --server takes precedence.

--help Shows help, then exits.

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication
domain is “avamar.”
For example: jdoe@avamar.

--infomsgs Writes informational text messages, such as hfscheck_kill - starting

termination of hfscheck_cron job, to the server log.

310 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 221 Command options for the hfscheck_kill command (page 2 of 2)

Option Description

--logfile=FILE Enables information logging to this FILE. If no FILE value is supplied,

default log file (avagent.log) is used.

--mcserver Runs the mccli event command, which is used to access and
manage event codes on the Avamar server. The EMC Avamar
Management Console Command Line Interface (MCCLI) Programmer
Guide provides additional information about the mccli event
command.

--n | --norun Lists but does not execute commands.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.

--nodes=NODE-LIST Specifies which nodes are affected.

Requires physical MODULE.NODE designations as defined in
probe.xml.

--override Forces script run even if jobs have been suspended.

--password=PASSWORD Specifies the PASSWORD for the --id account. Same as --ap and
--pswd.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

--pswd=PASSWORD Specifies the PASSWORD for the --id account. Same as --ap and
--password.

--q | --quiet Runs quietly.

--run Executes all commands (opposite of --n or --norun).

--runasanyuser If supplied, this program can be run by any user.

--savesysinfo If supplied, special storage server (GSAN) cleanliness tests are run.
This is the default setting.

--server=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS). Same as --hfsaddr; --server takes precedence.

--timestamps Shows local time in terms in YYYYMMDD-HHMMSS format, where:

• YYYY is the calendar year
• MM is the calendar month
• DD is the calendar day
• HH is hours
• MM is minutes
SS is seconds

--user=USER-ID Specifies the alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--v | --verbose Provides maximum information.

--vardir=DIR Specifies the local cache directory. The default setting is

/usr/local/avamar/var if it exists, otherwise /tmp.

hfscheck_kill 311
EMC CONFIDENTIAL
Command Reference

hfsclean
The hfsclean command deletes all data currently stored in the Avamar server. It is used by
restart.dpn, start.dpn, and start.nodes.
Documentation for this script is provided for reference purposes only. Do not run hfsclean
directly from the command line.

hfssetup
The hfssetup command creates the /usr/local/avamar/etc/avamar.cfg file. This file is a
configuration file for the web services.
Documentation for this script is provided for reference purposes only. Do not run hfssetup
directly from the command line.

312 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

initacnt
The initacnt command is run once during Avamar server initialization. It creates base
administrative user accounts and default directories in the Avamar server.

Synopsis
initacnt [--error] [--help] [--hfsaddr=AVAMARSERVER] [--n | --norun]
[--nodedb=FILE] [--nodes=NODE-LIST] [--password=PASSWORD]
[--ping_only] [--q | --quiet] [--repl_password=PASSWORD] [--run]
[--server=AVAMARSERVER] [--user=USER-ID] [--vardir=DIR]
[--v | --verbose]

Options
The following options are available for the initacnt command.

Table 222 Command options for the initacnt command

Option Description

--error Generates error when execution fails.

--help Shows help, then exits.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as

defined in DNS). Same as --server; --server takes precedence.

--n | --norun Lists but does not execute commands.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nodes=NODE-LIST Specifies which nodes are affected.

Requires physical MODULE.NODE designations as defined in
probe.xml.

--password=PASSWORD Specifies the PASSWORD for the --user account.

--ping_only Only performs ICMP ping. The default timeout is 25 seconds.

--q | --quiet Runs quietly.

--repl_password=PASSWORD Specifies the PASSWORD for the replication user account.

--run Executes all commands (opposite of --n or --norun).

--server=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as

defined in DNS). Same as --hfsaddr; --server takes precedence.

--user=USER-ID Specifies the alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--vardir=DIR Specifies the local cache directory. The default setting is

/usr/local/avamar/var if it exists, otherwise /tmp.

--v | --verbose Provides maximum information.

initacnt 313
EMC CONFIDENTIAL
Command Reference

initialize_connectemc
The initialize_connectemc command initializes ConnectEMC by using attribute/value
pairs from the avupsw (upgrade.conf) or the avqinstall (install.conf) configuration file.

Synopsis
initialize_connectemc --config=PATH

Options
The following option is available for the initialize_connectemc command.

Table 223 Command options for the initialize_connectemc command

Option Description

--config=PATH Specify the path to configuration file that contains attribute/value pairs.

Notes
This command added in version 6.0.

314 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

java_update.sh
The java_update.sh shell script updates the Java Runtime Environment (JRE) version used
by certain functions.

Synopsis
java_update.sh {client | ems | mccli | mds | server} [JRE-DIR]

Commands
The following commands are available for the java_update.sh shell script.

Table 224 Commands for the java_update.sh shell script

Command Description

client Update JRE used by the Administrator client scripts.

ems Update JRE used by Avamar Enterprise Manager server (EMS).

mccli Update JRE used by Avamar Management Console Command Line Interface (MCCLI).

mds Update JRE used by the Metadata Search (MDS) feature.

server Update JRE used by the MCS scripts.

Options
The following option is available for the java_update.sh command.

Table 225 Command options for the java_update.sh shell script

Option Description

JRE-DIR JRE root directory (for example, /usr/java/jre1.5.0_12).

If not supplied, java_update.sh searches for the latest installed JRE and provides that
root directory as the default value.

java_update.sh 315
EMC CONFIDENTIAL
Command Reference

java_update_avi.sh
The java_update_avi.sh shell script is used to update the AvInstaller configuration to use
the newest version of Java installed on the system.
The script does not produce any output.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
java_update_avi.sh

lm
The lm process is the Avamar login manager. This process provides access to external
authentication databases, which allows Avamar to use pre-existing username and
password information for Avamar authentication. Without the login manager, Avamar can
only use its internal authentication mechanism.
When requests from an Avamar client specify the use of an external authentication
domain, Avamar redirects login messages to the external domain by way of the lm
processes. The external domain returns status to the login manager. An lm process is
expected to be running on each utility node.
The login manager requires multiple configuration files to operate properly, and must be
restarted after any change to the configuration files.

Synopsis
lm [--debug] [--encrypt={ssl | tcp}]
[--encrypt-strength={cleartext | high | medium}] [--flagfile=FILE]
[--help] [--helpx] [--helpxml] [--memman=NAME]
[--memmantrigger=NAME] [--port=PORT] [--sysdir=PATH]
[--timeout=SEC] [--uflagsdebug] [--usage] [--verbose] [--version]

Options
The following options are available for the lm command.

Table 226 Command options for the lm command (page 1 of 2)

Option Description

--debug Prevents login manager from entering background mode and

automatically enables verbose messaging.

--encrypt={ssl | tcp} Sets the encryption type to one of the following:

• ssl—Use Secure Sockets Layer encryption.
• tcp—Do not use SSL. This is the default setting.

--encrypt-strength= Sets the encryption strength to one of the following:

{cleartext | medium
| high} • cleartext—Corresponds to the NULL-SHA cipher.
• high—Corresponds to the AES256-SHA cipher. This is the default
setting.
• medium—Corresponds to the AES128-SHA cipher.
Supplying any other value defaults to high setting.

316 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 226 Command options for the lm command (page 2 of 2)

Option Description

--flagfile=FILE Specifies the FILE containing a list of options and values that are
processed by this program as if they were included on the
command line. The default setting is
/usr/local/avamar/etc/usersettings.cfg.

--help Shows full online help (commands, options and full descriptions),
then exits.

--helpx Shows full online help for this program, including extended flags,
then exits.

--helpxml Shows full online help for this program in xml format, then exits.

--memman=MODE EMC internal use only. Memory debugging MODE.

--memmantrigger=MODE EMC internal use only. Extra memory debugging MODE.

--port=PORT Specifies an alternate data PORT for login manager communication.

The default setting is 700 (which requires operating system root
privileges).

--sysdir=PATH PATH to the directory containing Avamar server files. The default
setting is /etc/avamar.

--timeout=SEC Time limit in seconds (SEC) applied to each login attempt. The
default setting is 10 seconds.

--uflagsdebug Specifies flag parsing debug mode.

--usage Shows abbreviated online help (commands and options only, no

descriptions), then exits.

--verbose Provides maximum information.

--version Shows version, then exits.

Notes
Consider the following notes for the lm command:
◆ The lm process is typically activated during system startup. The process automatically
runs in the background unless debug mode is asserted.
◆ You must run the lm process as root.

lm 317
EMC CONFIDENTIAL
Command Reference

load_accounts
The load_accounts command reads one or more files previously generated by
dump_accounts, then creates the clients, domains, accounts, and users described in the
file on the specified Avamar server. This program is primarily used as a development tool.

Synopsis
load_accounts [-ap=PASSWORD] [--debug] [--hfsaddr=AVAMARSERVER]
[--id=root] [--showonly] FILE1 [, FILE2, ... ]

Options
The following options are available for the load_accounts command.

Table 227 Command options for the load_accounts command

Option Description

--ap=PASSWORD Authenticate using PASSWORD.

--debug Enable debug mode.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS).

--id=root Run as root.

--showonly Show only, do not run.

FILE1 [, FILE2, ... ] One or more files previously generated by dump_accounts.

Separate multiple entries with a comma (,).

Notes
Typically, --hfsaddr=AVAMARSERVER is set in a configuration file on the utility node.
Therefore, this option is not normally required on the command line.

318 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

logmrg
The logmrg command can only be run after getlogs. It parses gsan.log files in
MODULE.NODE subdirectories created by getlogs and creates a unified log file that is
sorted by date and time. The output goes to stdout and can be redirected to a file.

Synopsis
logmrg [--duration=HOURS] [--error] [--help] [--last=NUM]
[--logdir=PATH] [--logfile=NAME] [--logout=LOCATION]
[--n | --norun] [--nodedb=FILE] [--nodes=NODE-LIST] [--ping_only]
[--q | --quiet] [--run] [--start=DATETIME] [--tmpdir=PATH]
[--user=USER-ID] [--v | --verbose]

Options
The following options are available for the logmrg command.

Table 228 Command options for the logmrg command

Option Description

--duration=HOURS Used with --start to merge logs for number of HOURS after the start time.

--error Generates error when execution fails.

--help Shows help, then exits.

--last=NUM Merges logs for most current number (NUM) of hours.

--logdir=PATH Specifies a PATH to a directory containing the log directories. The default
setting is this current working directory (./).

--logfile=NAME Specifies the NAME of the log files on which to operate. The default setting
is gsan.log.

--logout=LOCATION Specifies the LOCATION to store the merged output. The default setting is
stdout.

--n | --norun Lists but does not execute commands.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.

--nodes=NODE-LIST Specifies which nodes are affected.

Requires physical MODULE.NODE designations as defined in probe.xml.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

--q | --quiet Runs quietly.

--run Executes all commands (opposite of --n or --norun).

--start=DATETIME Starts merging logs beginning at the specified date and time (DATETIME).
You can truncate this value to the desired resolution.
If time is present, it must follow a dash (-).

--tmpdir=PATH Specifies a PATH to a temporary working directory.

The default setting is /tmp.

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--v | --verbose Provides maximum information (default).

logmrg 319
EMC CONFIDENTIAL
Command Reference

mapall
The mapall command runs the same command on all of the nodes in the Avamar server. It
uses probe.xml to resolve MODULE.NODE designations into IP addresses.
The mapall program affects only nodes that are running. The probe.xml file specifies the
running status of a node by the connected attribute setting. True means a node is running
and false means it is not running.

Synopsis
mapall [--all] [--all+] [--allow_legacy] [--bg] [--capture]
[--checkpointdir=DIR] [--debug] [--error] [--givestatus] [--help]
[--hfsdir=PATH] [--id] [--nodedb=FILE] [--nodes=NODELIST]
[--parallel] [--ping_only] [--q | --quiet] [--user=USER-ID]
[--v | --verbose] ’COMMAND’ [; ’COMMAND2’ ; ...]

COMMAND can be any valid operating system command on the remote system.
Commands that contain wildcards or pipes (*, ?, |) must be enclosed within single quotes
('*'). Multiple commands can be entered if separated by semicolons. Single quotes must
be used in this case as well.

Options
The following options are available for the mapall command.

Table 229 Command options for the mapall command (page 1 of 2)

Option Description

--all Runs COMMAND on all nodes (utility and storage) on the server. If not
supplied, COMMAND runs only on the storage nodes.

--all+ Runs COMMAND on all utility, storage and optional nodes on the server.
This option added in version 5.0.

--allow_legacy Supports the use of probe.out if probe.xml cannot be found.

Also used with --probedir or --probefile to specify a custom location for
a legacy probe.out file.
This option added in version 5.0.

--bg Runs COMMAND in the background and does not wait for it to complete.

--capture If --capture is not supplied, COMMAND output is interleaved.

--checkpointdir=DIR Specifies the directory (DIR) where the data is located on each /data0?
mount. The default location is 'cur'.

--debug Enables extended debugging information (for example, which nodes

map to which IP addresses).

--error Does not continue if error occurs. The default behavior is to terminate
script session after an error occurs.

--givestatus

--help Shows help, then exits.

--hfsdir=PATH Specifies the root location where the /data0? data mounts are located
on the storage nodes. The default setting is '/'.

--id Prints node ID before COMMAND is run on each node.

320 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 229 Command options for the mapall command (page 2 of 2)

Option Description

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nodes=NODELIST Runs COMMAND on these nodes. The following shortcuts are

supported:
• #.#—all storage nodes in all modules
• #.s—all utility nodes
• #.access—all access nodes
• #.accelerator—all accelerator nodes
• #.spare—all spare nodes
• #.m—administrator node (deprecated)
For example: 1.# is all storage nodes on module-1,
0.2,1.5 is nodes 0.2 and 1.5, #.s,#.m,#.# is all utility and storage
nodes.
The default setting is #.#.
If running Avamar versions before 5.0, do not specify #.access,
#.accelerator or #.spare optional nodes). The probe.out file does not
support optional nodes.

--parallel Runs COMMAND on each node at the same time.

--ping_only Checks node connectivity using an ICMP ping test. By default, the
mapall program runs an ICMP ping test.
Use --noping_only to run an ssh connectivity check after a successful
ICMP ping test.
Use --ping_only with a closely spaced series of mapall operations to
optimize speed.
This option added in version 5.0.

--q | --quiet Disables all messages (status and warnings).

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).
Typically, --user=USER-ID is used to specify that mapall be run as root,
dpn or admin users.
Use of --user requires that the correct authorization exist. In particular,
to perform mapall commands as the root or admin user, you must load
the dpnid private key into the ssh-agent context. The admin_key only
allows for performing mapall commands as the admin user.

--v | --verbose Provides maximum information.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 230 Deprecated command options for the mapall command

Option Description

--mcs Deprecated in version 5.0.

--probedir=PATH Deprecated in version 5.0.

--probefile=PATH Deprecated in version 5.0.

mapall 321
EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the mapall command:
◆ Before Avamar 5.0, the mapall program used probe.out to resolve MODULE.NODE
designations into IP addresses. Beginning with Avamar 5.0, the mapall program uses
the probe.xml file to resolve MODULE.NODE designations into actual IP addresses. If
the mapall program cannot find the probe.xml file, it attempts to use a legacy
probe.out file.
◆ The SYSPROBEDIR environment variable typically stores the path to a directory
containing a valid probe.xml file. If SYSPROBEDIR is not set, the default probe.xml
location (/usr/local/avamar/var/) is used.
◆ This command reads a default operating system user ID from the SYSPROBEUSER
environment variable. If SYSPROBEUSER is not set, then remote commands are run as
user admin.

Examples
The following command uploads the file gsan.out from every storage node and stores it on
the local machine in a group of files named NODE/gsan.out (for example, 0.0/gsan.out
and 0.1/gsan.out, and so forth):
mapall [options] get FILE ...

The following command copies myscript from the local machine to every storage node:
mapall copy myscript

The following command runs the Linux date command on every node:
mapall --all date

The following command returns the number of storage (gsan) processes running on each
node:
mapall --noerror ’ps auxww | grep gsan | grep -v grep | wc -l’

The following commands create a legacy probe.out file in /usr/local:

mapall --allow_legacy --probedir=/usr/local
mapall --allow_legacy --probefile=/usr/local/probe.out
mapall --nodedb=/usr/local

The following commands create a custom file (clear.out) in /usr/local:

mapall --allow_legacy --probedir=/usr/local
mapall --allow_legacy --probefile=/usr/local/clear.out
mapall --nodedb=/usr/local

322 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

mcdbmaint.sh
The mcdbmaint.sh shell script performs maintenance on the MCS PostgreSQL database
(mcdb).



Beginning with version 1.2.1, this command has been deprecated in favor of dbmaint.sh.

It performs the same functions as mcdbsql.sh. The only difference is that mcdbmaint.sh
requires the MCS to be stopped before it can be run; mcdbsql.sh can be run when the MCS
is running.

Synopsis
mcdbmaint.sh {db_1.000_to_1.001.sql | db_count.sql | dbcreate.sql |
dbmaint.sql | ec_update.sql | show_version s.sql}

Options
The mcdbmaint.sh shell script accepts one and only one of the following .sgl files as a
command line option.

Table 231 Options for the mcdbmaint.sh shell script

Option Description

db_1.000_to_1.001.sql Updates the mcdb schema from version 1.000 to version 1.001.
Other similar files might also be present in /usr/local/avamar/bin.
These files would perform a similar upgrade from or to a different
mcdb schema version.

db_count.sql Returns total number of records in all mcdb tables.

dbcreate.sql Creates the mcdb tables.

dbmaint.sql Frees unused hard drive space by running an SQL vacuum command
against the mcdb.

ec_update.sql Forces an upgrade of the event catalog by resetting the version

numbers.

show_version s.sql Returns schema version.

Notes
Consider the following notes for the mcdbmaint.sh shell script:
◆ The mcdbmaint.sh script can only be invoked when the MCS is stopped.
◆ When invoked, mcdbmaint.sh performs the following:
1. Stops the PostgreSQL (if it is running) to ensure a consistent database.
2. Starts the database.
3. Runs the PostgreSQL commands in the specified file.

mcdbmaint.sh 323
EMC CONFIDENTIAL
Command Reference

mcdbsql.sh
The mcdbsql.sh shell script performs maintenance on the MCS PostgreSQL database
(mcdb).



Beginning with version 1.2, this command has been deprecated in favor of dbmaint.sh.

It performs the same functions as mcdbmaint.sh. The only difference is that

mcdbmaint.sh requires the MCS to be stopped before it can be run; mcdbsql.sh can be
run when the MCS is running.

Synopsis
mcdbsql.sh {db_1.000_to_1.001.sql | db_count.sql | dbcreate.sql |
dbmaint.sql | ec_update.sql | show_version s.sql}

Options
The mcdbsql.sh shell script accepts one and only one of the following .sgl files as a
command line option.

Table 232 Options for the mcdbsql.sh shell script

Option Description

db_1.000_to_1.001.sql Updates the mcdb schema from version 1.000 to version 1.001.
Other similar files might also be present in /usr/local/avamar/bin.
These files would perform a similar upgrade from or to a different
mcdb schema version.

db_count.sql Returns total number of records in all mcdb tables.

dbcreate.sql Creates the mcdb tables.

dbmaint.sql Frees unused hard drive space by running an SQL vacuum command
against the mcdb.

ec_update.sql Forces an upgrade of the event catalog by resetting the version

numbers.

show_version s.sql Returns schema version.

Notes
When invoked, mcdbsql.sh performs the following:
1. Stops the PostgreSQL (if it is running) to ensure a consistent database.
2. Starts the database.
3. Runs the PostgreSQL commands in the specified file.

324 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

mcconfigfirewall_snmp
The mcconfigfirewall_snmp shell script configures the firewall on a SuSE Linux Enterprise
Server (SLES) to allow SNMP packets.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
mcconfigfirewall_snmp

Notes
Configuration settings are stored in /etc/firewall.base and /etc/hosts.allow.

mcddrcopy_sshkey
The mcddrcopy_sshkey shell script is used to copy the Data Domain system SSH
public/private key files from the generated output location to the location required for
their use. This script is not normally run directly, instead it is called from the
mcddrsetup_sshkey script.
This script must be run as root.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
mcddrcopy_sshkey

Notes
Information about generated files, and locations, permissions, and ownership is available
in “mcddrsetup_sshkey” on page 326.

mcddrcreate_sshkey
The mcddrcreate_sshkey shell script is used to generate the Data Domain system SSH
public/private key files. This script is not normally run directly, instead it is called from the
mcddrsetup_sshkey script.
This script must be run as user admin.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
mcddrcreate_sshkey

Notes
Information about generated files, and locations, permissions, and ownership is available
in “mcddrsetup_sshkey” on page 326.

mcconfigfirewall_snmp 325
EMC CONFIDENTIAL
Command Reference

mcddrsetup_sshkey
The mcddrsetup_sshkey shell script is used to set up the Data Domain system SSH
public/private key files.
This script must be run as user admin.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
mcddrsetup_sshkey

Notes
The files ddr_key and ddr_key.pub are generated in /home/admin/.ssh/ and then copied
to /usr/local/avamar/lib/.
In /usr/local/avamar/lib/ the permissions and assigned owner/group for the files must
be as shown in the following long list (ll) example, run as root:
# ll ddr_key*
-r--r----- 1 root admin 883 Mar 2 09:45 ddr_key
-rw-r--r-- 1 root admin 237 Mar 2 09:45 ddr_key.pub

Before rerunning mcddrsetup_sshkey to generate new versions of the two output files,
delete ddr_key and ddr_key.pub from the following directories:
/home/admin/.ssh/
/usr/local/avamar/lib/

326 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

mcddrsnmp
The mcddrsnmp shell script is used to start, stop, restart, and check the status of the Data
Domain SNMP Manager.
This script must be run as user admin.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
mcddrsnmp {start | stop | restart | --status } [--verbose]

Commands
The following commands are available for the mcddrsnmp shell script.

Table 233 Commands for the mcddrsnmp shell script

Command Description

start Starts the Data Domain SNMP Manager.

stop Stops the Data Domain SNMP Manager.

restart Restarts the Data Domain SNMP Manager.

--status Displays the status of the Data Domain SNMP Manager.

Options
The following options are available for the mcddrsnmp shell script.

Table 234 Command options for the mcddrsnmp shell script

Option Description

--verbose Display all available information.

mcddrsnmp 327
EMC CONFIDENTIAL
Command Reference

mcfeature
The mcfeature command reports which optional features are installed, configured, or
running on the MCS.

Synopsis
mcfeature FEATURE CHECK

Options
The following options are available for the mcfeature command.

Table 235 Command options for the mcfeature command

Option Description

FEATURE One of the following values:

• connectemc—ConnectEMC.
• mds—Metadata search.

CHECK One of the following values:

• installed—Checks whether the feature is installed.
• configured—Checks whether the feature is configured.
• running—Checks whether the feature is running.

Notes
This command added in version 4.1.

328 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

mcflush.pl
The mcflush.pl Perl script is used to flush the AvInstaller database, avidb.
This script is not normally invoked by itself. It is normally a helper script called by
avidbmaint.pl --flush.
The default location for this script is the /usr/local/avamar/bin directory.

Synopsis
mcflush.pl [--help] [--dbport PORT] [--dbdumpfile FILE]
[--flushtarget DIR] [--flushexclude DIR1[,DIR2,...]]
[--flushlabel LABEL] [--flushlogfile LOGFILE] [--flushpath CLIENT]

Options
The following options are available for the mcflush.pl Perl script.

Table 236 Command options for the mcflush.pl Perl script

Option Description

--help Displays help.

--dbport PORT (Required) Specifies database port as PORT.

--dbdumpfile FILE (Required) Specifies database dumpfile as FILE.

--flushtarget DIR (Required) Specifies DIR as the target to backup.

--flushexclude (Required) Specifies comma-separated list DIR1[,DIR2,...] as

DIR1[,DIR2,...] directories to exclude from the backup.

--flushlabel LABEL Labels the backup as LABEL.

--flushlogfile LOGFILE (Required) Specifies LOGFILE as the file name for avtar log.

--flushpath CLIENT (Required) Specifies CLIENT as the Avamar client to receive the
backup.

mcflush.pl 329
EMC CONFIDENTIAL
Command Reference

mcgui.bat
The mcgui.bat DOS batch file launches the Avamar Administrator graphical management
console on Windows platforms. Any options supplied on the command line populate
graphical Login dialog box fields.
The default location for this script is the C:\Program Files\avs\bin folder.

Synopsis
mcgui.bat [-domain DOMAIN] [-mcsaddr AVAMARSERVER]
[-mcspasswd PASSWORD] [-mcsuserid USER-ID]

Options
The following options are available for the mcgui.bat DOS batch file.

Table 237 Command options for the mcgui.bat DOS batch file

Option Description

-domain DOMAIN Specifies the top-level client domain for this Avamar Administrator
session. The default setting is root (/).

-mcsaddr AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified hostname

(as defined in DNS).

-mcspasswd PASSWORD Specifies the PASSWORD for the -mcsuserid account.

-mcsuserid USER-ID Specifies the Avamar administrative user account (USER-ID) to use to
launch the Avamar Administrator graphical management console.

330 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

mcgui.sh
The mcgui.sh shell script launches the Avamar Administrator graphical management
console on Linux platforms. Any options supplied on the command line populate
graphical Login dialog box fields.
The default location for this script is the client /usr/local/avamar/bin directory.

Synopsis
mcgui.sh [-domain DOMAIN] [-mcsaddr AVAMARSERVER]
[-mcspasswd PASSWORD] [-mcsuserid USER-ID]

Options
The following options are available for the mcgui.sh shell script.

Table 238 Command options for the mcgui.sh shell script

Option Description

-domain DOMAIN Specifies the top-level client domain for this Avamar Administrator
session. The default setting is root (/).

-mcsaddr AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified hostname

(as defined in DNS).

-mcspasswd PASSWORD Specifies the PASSWORD for the -mcsuserid account.

-mcsuserid USER-ID Specifies the Avamar administrative user account (USER-ID) to use to
launch the Avamar Administrator graphical management console.

mcgui.sh 331
EMC CONFIDENTIAL
Command Reference

mcgui_login.bat
The mcgui_login.bat DOS batch file launches the Avamar Administrator graphical
management console from a Windows command line, a script or from within another
Windows application.

Synopsis
mcgui_login.bat JRE-DIR MCS-USER-ID MCS-PSSWD DOMAIN MCS-ADDR

Options
Supply all of the following command line options in the exact order shown in the synopsis
and in the following table.

Table 239 Command options for the mcgui_login.bat DOS batch file

Option Description

JRE-DIR Specifies the location of the Sun Java installation.

MCS-USER-ID Specifies the Avamar administrative user account (MCS-USER-ID) to use to log in
to Avamar Administrator.

MCS-PSSWD Specifies the MCS-USER-ID password.

DOMAIN Specifies the MCS-USER-ID account domain. This should be root

(‘/’) unless you are managing subdomains. The EMC Avamar Administration
Guide provides additional information.
MCS-ADDR Specifies the MCS network name or IP address.

Notes
Consider the following notes for the mcgui_login.bat DOS batch file:
◆ The script is part of the Avamar Administrator Windows installer. The default location
is C:\Program Files\avs\administrator\bin.
◆ If the command fails, mcgui_login.bat also outputs to stdout the one (1) numeric
return code follow by an event code and event text summary. For example:
1,22801,User login failure.

Return codes
The mcgui_login.bat DOS batch file always returns one of the following numeric codes.

Table 240 Return codes for the mcgui_login.bat DOS batch file

Code Description

0 Command succeeded.

1 Command failed.

332 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Event codes
The following event codes are returned by the mcgui_login.bat DOS batch file.

Table 241 Event codes for the mcgui_login.bat DOS batch file

Code Value Description

21007 GUI_INTERNAL Internal Administrator client error.

21008 GUI_VERSION_MISMATCH Version mismatch.

21009 GUI_INVALID_PORT Invalid port (version 3.1.0 only).

22801 SEC_LOGIN_FAILURE User login failure.

23001 CLI_MISSING_REQUIRE_ARGS CLI command is missing required arguments.

23996 CLI_CONNECT_FAILURE CLI failed to connect to MCS.

Examples
In all of the following examples, MCS-USER-ID must be the actual Avamar administrative
user account, MCS-PSSWD is the login password for that account, and avamar-1 is an
example MCS name as defined in DNS.
The following example shows how to call mcgui_login.bat from within another script. The
return value of zero (0) shows that the command successfully completed.
cd C:\Program Files\avs\administrator
call bin\mcgui_login.bat c:\jre1.5.0 MCS-USER-ID MCS-PSSWD / avamar-1
echo %ErrorLevel%
0

The following example shows how to execute mcgui_login.bat from a Windows command
prompt. The return value of one (1) and the error code information shows that the
command did not successfully complete because of a user login failure.
bin\mcgui_login.bat c:\jre1.5.0 MCS-USER-ID MCS-PSSWD / avamar-1
1,22801,User login failure.

mcgui_login.bat 333
EMC CONFIDENTIAL
Command Reference

mcserver.sh
The mcserver.sh shell script performs maintenance of the MCS.

Synopsis
mcserver.sh {--flush [NAME] | --help | --init | --installcron | --ping
| --publishevent --code=NUM --message=TEXT | --restart | --restore
| --start | --status | --stop | --update}

[--ap=PASSWORD] [--flushfile=FILE] [--flushtype=local] [--force]

[--hfsaddr=AVAMARSERVER] [--hfsport=PORT] [--id=USER-ID]
[--label=NAME] [--labelnum=NUM] [--local_hfsaddr=IP-ADDR]
[--mcuserap=PASSWORD] [--newhfsaddr=IP-ADDR] [--newhfsport=PORT]
[--noinstallcron] [--password=PASSWORD] [--restoretype={new-system
| rename-system}] [--rmi_address=ADDRESS] [--rootap=PASSWORD]
[--server=AVAMARSERVER] [--test] [--xml]

Commands
Supply one and only one of the following commands on each command line for the
mcserver.sh shell script.

Table 242 Commands for the mcserver.sh shell script (page 1 of 2)

Command Description

--flush [NAME] Backs up (flushes) MCS data.

If NAME is supplied, that name is applied to the current backup.
The MCS automatically flushes 26 times per day (hourly and before each
system checkpoint).

--help Shows full online help (commands, options and full descriptions), then
exits.

--init Initializes the MCS.

Note: Re-initializing a running MCS is highly destructive. It completely

overwrites any custom preference settings stored in the live mcserver.xml
file and reverts the system state to the default settings. There is no way to
recover custom preference settings once they have been overwritten.

--installcron Installs the dpn user crontab file.

The MCS must already be running in order for command to successfully
complete.

--ping Performs a check (ping) to determine if the MCS is listening.

--publishevent Force publishes an event with the specified numeric code and message
--code=NUM text.
--message=TEXT
The --code and --message options specify the numeric event code and
event code message text, respectively; they must be supplied.

--restart Shuts down all administrator services except the PostgreSQL database
(mcdb) and restarts them. Each restart is logged.

--restore Replaces all MCS data with data from the last flush (backup).
If either --labelnum=NUM or --label=NAME is supplied, data from that
backup is used for the restore.
The MCS must be in a stopped state to do a restore.

--start Starts the MCS and logs the action.

334 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 242 Commands for the mcserver.sh shell script (page 2 of 2)

Command Description

--status Returns status of each administrator service and any available performance
statistics.

--stop Shuts down the administrator services and PostgreSQL database (mcdb).
Each stop is logged.

--update Upgrades database schema.

mcserver.sh --update can only be run when the MCS is not running and it
can start up and shut down the database as needed to perform the
upgrade.

Options
The following options are available for the mcserver.sh shell script.

Table 243 Command options for the mcserver.sh shell script (page 1 of 2)

Option Description

--ap=PASSWORD Used with --restore to specify the password for the user account
identified by --id flag.

--flushfile=FILE Used with --restore to specify a local flush FILE.

--flushtype=local Used with --flush and --restore commands to create or restore

from a local MCS flush file, respectively.
The mcserver.sh --flush --flushtype=local command generates a
gzipped tar file with all the same files that normally get backed
up during a normal (avtar) MCS flush. This tar file can be used to
restore the MCS system state for troubleshooting and diagnostic
purposes.

--force EMC internal use only.

Used with --init, --restore, and --update to bypass user prompts
(force execution without regard for user inputs).

--hfsaddr=AVAMARSERVER Used with --restore to specify which AVAMARSERVER IP address

or fully qualified hostname (as defined in DNS) is restored.
Same as --server=AVAMARSERVER.

--hfsport=PORT Used with --restore to restore from the Avamar server at this data
PORT.

--id=USER-ID Used with --restore to specify an alternate user account

(USER-ID); that is another user account besides the default
MCuser account.

--label=NAME Used with --flush to specify a descriptive label identifying the

contents of the flush.
Used with --restore to specify which existing MCS backup (flush)
should be used for the restore operation.

--labelnum=NUM Used with --restore to specify which existing MCS backup (flush)
should be used for the restore operation.

--local_hfsaddr=IP-ADDR Used with --restoretype=new-system to specify a new local Hash

File System (HFS) IP address (IP-ADDR) that is used to store MCS
preferences.

--mcuserap=PASSWORD Used with --restore to specify a new Avamar MCUser password.

mcserver.sh 335
EMC CONFIDENTIAL
Command Reference

Table 243 Command options for the mcserver.sh shell script (page 2 of 2)

Option Description

--newhfsaddr=IP-ADDR Used with --restoretype=new-system to specify a new HFS IP

address (IP-ADDR) that is used to store MCS preferences.

--newhfsport=PORT Used with --restoretype=new-system to specify a new data PORT

that is used to store MCS preferences.

--noinstallcron Used with --start to specify that dpn user crontab should not be
installed. This is not the default setting.

--password=PASSWORD Used to specify MCUser password when performing a restore.

--restoretype= Used with --restore to specify the type of restore operation.

{new-system |
rename-system} If --restoretype is not supplied, a normal (non-disaster recovery)
restore is performed.
--restoretype=new-system is used to support system upgrades
and disaster recovery in cases where a source Avamar server has
been completely replicated to a destination server, and the
destination server is brought online to replace the old source
server, or if you are using the source Avamar server as a “swing
box.”
--restoretype=rename-system when the Avamar server hostname
or IP address has been changed.
If --restoretype is used with the --force option, the rmi_address
from the mcserver.xml file will be used, to guarantee that the
rmi_address that was present before the restore is also present
after the restore.

--rmi_address=ADDRESS ADDRESS IP address or fully qualified hostname (as defined in

DNS) of the RMI server.
Used with --restoretype=new-system. If this option is set,
mcserver.sh will use the value in this option, after validating, as
the new rmi_address.
Without this option, mcserver.sh will prompt the user to select an
address for the RMI server based on the settings in the
mcserver.xml, enter a new address, or use the local host as the
RMI server.

--rootap=PASSWORD Used with --restore to specify a new root password.

--server=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as

defined in DNS).
Same as --hfsaddr=AVAMARSERVER.

--test Returns MCS status (up or down).

--xml Used with --status to output an XML document instead of the

standard --status output.

Notes
Consider the following notes for the mcserver.sh shell script:
◆ When an Avamar server has been populated with backups and MCS data (for example,
group definitions, schedules, datasets, and so forth) from an existing system as part
of a disaster recovery or upgrade operation (that is, the server has been the target of a
root-to-root replication), it is especially important to restore the MCS state from the
latest replicated flush; not from a local MCS flush. Failure to do so causes replicated
MCS data to be lost.

336 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

◆ The mcserver.sh program incorporates logic that automatically examines the list of
flushes and selects that most recent one that is not from the local MCS. If no flushes
from a replicated system are found, the following error message appears and the
restore operation is terminated:
ERROR: No flushes from replicated Avamar server available. Make sure
the source Avamar server has successfully replicated to
MyServer.example.com.

◆ If a flush is specified using the --label or --labelnum options, then mcserver.sh also
verifies whether this is a replicated flush. If it is not, the following error message
appears and the restore operation is terminated:
ERROR: The specified flush labelnum = 273 is not from the replicated
Avamar server. You must restore a flush from the replicated Avamar
server.

◆ When performing a normal restore (that is, when not specifying

--restoretype=new-system), the list of backups is similarly examined, and the most
recent flush from the local MCS is used. If a flush is specified using the --label or
--labelnum options, then that flush is examined to determine if it works for whatever
type of flush was specified. When performing a normal restore, if there are no flushes
from the local MCS, the following message appears:
WARNING: There are no flushes available for MyServer.example.com. Did
you want to perform a "new-system" restore type Y/N?

If the specified flush is not from a local MCS, the following message appears:
WARNING: The flush you have selected to restore was replicated from
a different Avamar server. Did you want to perform a "new-system"
restore type Y/N?

In either case, if you choose Y, a new-system restore is performed. If N is chosen, the

restore operation is terminated.

Examples
To perform a local MCS flush using the default local flush filename and location
(var/mc/server_flush/mcflush.YYYYMMDD.hhmmss), type:
mcserver.sh --flush --flushtype=local

The following information appears in the command shell:

check.mcs passed
=== PASS === check.mcs PASSED OVERALL (poststart)
Flushing MCS...
MCS flushed to local file: var/mc/server_flush/mcflush.20130117.111101

To restore the MCS system state from the latest local flush file, type:
mcserver.sh --restore --flushtype=local

To restore the MCS system state from a local flush file (mcflush.20130117.111101 in this
example), type the following on a single command line:
mcserver.sh --restore --flushtype=local
--flushfile=mcflush.20130117111101

mcserver.sh 337
EMC CONFIDENTIAL
Command Reference

mcsmon_run
The mcsmon_run command runs monmcs on the utility node.
This command must be run as user dpn. This program attempts to load the dpnid
OpenSSH key from the dpn user .ssh directory. This command fails if it is run as a different
user.

mcsnmp
The mcsnmp command is used to start and stop the SNMPSubAgent.

Synopsis
mcsnmp {start | stop} [--verbose]

Commands
The following commands are available for the mcsnmp command.

Table 244 Commands for the mcsnmp command

Command Description

start Starts the SNMPSubAgent.

stop Stops the SNMPSubAgent.

Options
The following option is available for the mcsnmp command.

Table 245 Command options for the mcsnmp command

Option Description

--verbose Provides maximum information.

mcsnmp_cron
The mcsnmp_cron command is primarily intended to be run as a cron job to periodically
restart the snmpd process and Avamar SNMP sub-agent.
Documentation for this script is provided for reference purposes only. Do not run
mcsnmp_cron directly from the command line.

338 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

mds_ctl
The mds_ctl command performs maintenance of the metadata search database. It is
installed on the access node as part of the dpnmetadatadb rpm installation and requires
no additional setup.

Synopsis
mds_ctl [--createlinks] [--dump] [--dumpfile=FILE] [--help] [--init]
[--load] [--start] [--stop] [--update] [--version]

Options
The following options are available for the mds_ctl command.

Table 246 Command options for the mds_ctl command

Option Description

--createlinks Creates links to enable access to axionfs.

--dump Dumps the metadata search database to a file.

--dumpfile=FILE Used with --dump to specify location of output file for the dump.
Used with --load to specify which dump file to load.

--help Shows help, then exits.

--init Initialize the metadata search database.

--load Load the metadata search database from a file.

--start Start postgres for the metadata search database.

--stop Stop postgres for the metadata search database.

--update Update the metadata search database and preferences following an access
node software upgrade.

--version Shows version, then exits.

Notes
After installing any new version of the dpnmetadatadb rpm on an access node, run
mds_ctl --update as user admin to perform any necessary updates.

metadata_cron
The metadata_cron command is primarily intended to be run as a cron job to perform
indexing of the metadata search database (mdsdb) at regular intervals.

mds_ctl 339
EMC CONFIDENTIAL
Command Reference

mktime
The mktime command creates ntp.conf and step-tickers files for Avamar servers.
Documentation for this script is provided for reference purposes only. The mktime
program is typically invoked programmatically by asktime, and should not be run directly
from the command line.

Synopsis
mktime [--configdir=DIR] [--debug] [--has-utility-node] [--help]
[--mcs-zero-only] [--module-zero=id] [--nodedb=FILE]
[--single-node] [--verbose]

Options
The following options are available for the mktime command.

Table 247 Command options for the mktime command

Option Description

--configdir=dir Specifies the output directory (DIR) for time configuration files. The
default location is /usr/local/avamar/var/time-config-files.

--debug Shows example session information but does not perform the
specified actions.

--has-utility-node Generates a configuration for a combined 0.s/0.m node.

--help Shows help, then exits.

--mcs-zero-only Specifies that only the MCS in module zero be used.

--module-zero=ID Specifies the ID of module zero in a multi-node system.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--single-node Generates single-node configuration.

--verbose Provides maximum information.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 248 Deprecated command options for the mktime command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

340 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the mktime command:
◆ The mktime program must be customized for each site, either by running asktime, or
by manually editing a copy with a text editor such as vi or emacs. Instructions for
manual modifications can be found at the top of the script.
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable, typically stores the
path to a directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the
default probe.xml location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.
◆ The mktime program also uses the SYSPROBEDIR environment variable to determine
where to place output files. This location can be overridden using the --configdir=DIR
option.

Files
Files produced:
◆ ${configdir}/mktime.out
◆ ${configdir}/ntp.conf*
◆ ${configdir}/step-tickers*
where ${configdir} is one of the following, in order of decreasing precedence:
1. Specified by --configdir=DIR
2. ${SYSPROBEDIR} /time-config-files
3. /usr/local/avamar/var/time-config-files
After running this script, run timedist, to install these files on the system, using
SYSPROBEUSER=root or SYSPROBEUSER=dpn. Be sure to load the dpnid OpenSSH keys
first. The asktime program, does this automatically.

mktime 341
EMC CONFIDENTIAL
Command Reference

modify-snapups
The modify-snapups command writes a script to stdout, which when run, either changes
backup expiration dates or deletes any backups stored on the Avamar server with a
creation date before the specified date.

Synopsis
modify-snapups --mode={delete | expire} [--after=DATE] [--before=DATE]
[--days=NUM] [--domain=CLIENT-DOMAIN] [--help]
[--include_mc_backups] [CLIENT-PATH ...]

Commands
Supply one and only one of the following commands on each command line for the
modify-snapups command.

Table 249 Commands for the modify-snapups command

Command Description

--mode={delete | expire} If --mode=delete is supplied, a script is written to stdout that

deletes any backups stored on the Avamar server with a creation
date before the date specified by --before=DATE.
If --mode=expire is supplied, a script is written to stdout that
changes backup expiration dates.

Options
The following options are available for the modify-snapups command.

Table 250 Command options for the modify-snapups command (page 1 of 2)

Option Description

--after=DATE If supplied with --mode=delete, all backups created after this date
are eligible to be deleted. The default DATE setting in this mode is
June 1, 1999 00:00:00.
If supplied with --mode=expire, all backups created after this date
are eligible to be expired. The default DATE setting in this mode is
90 days ago.

--before=DATE If supplied with --mode=delete, all backups created before this date
are eligible to be deleted. The default DATE setting in this mode is
two weeks ago.
If supplied with --mode=expire, all backups created before this date
are eligible to be expired. The default DATE setting in this mode is
now (the time at which modify-snapups is invoked).

--days=NUM Used with the --mode=expire command to specify the new backup
expiration date and time as the number (NUM) of whole days from
today. The default setting is 90 days from the initial backup creation
date.

--domain=CLIENT-DOMAIN If supplied, all clients within the specified CLIENT-DOMAIN are

processed.

--help Shows help, then exits.

Specifying --mode=delete --help or --mode=expire --help provides
context-sensitive help for those modes.

342 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 250 Command options for the modify-snapups command (page 2 of 2)

Option Description

--include_mc_backups If supplied, all clients within the special MC_BACKUPS domain are
also processed. Because MC_BACKUPS is a special system domain,
the default behavior is to not process these clients unless this
option is explicitly supplied.

CLIENT-PATH Specifies a valid Avamar client path (for example,

/clients/MyClient). Additional client paths can be delimited with
white space.
Client paths must always terminate with a valid Avamar client name.
You cannot specify a client domain in this manner. Use --domain to
process all clients within a particular domain.
If not supplied, all clients are processed. This is the default setting.

Notes
Consider the following notes for the modify-snapups command:
◆ This command modifies backups but does not update the MCS database. This might
cause the total bytes used value, which is used by the server licensing mechanism, to
be incorrect. Therefore, EMC strongly suggests that you only use this command if
instructed to do so by EMC Customer Support. Contact EMC Customer Support for
additional information.
◆ The DATE specifier can be any date string acceptable to date(1). For GNU date(1),
which on Linux is /bin/date, DATE can be just about any common date string,
including such phrases as “2 weeks ago.”
◆ Invoking modify-snapups --mode=delete is the same as running the delete-snapups
program.
◆ Invoking modify-snapups --mode=expire is the same as running the expire-snapups
program.

Examples
To create a default output script (one that deletes any backup stored
/clients with a creation date older than two weeks from today’s date) with the
user-defined name del-old-backups, type:
modify-snapups --mode=delete /clients > del-old-backups

To restrict program execution to specific client area (/clients/engineering in this example)

and change the time period to three weeks ago, type the following on a single command
line:
modify-snapups --mode=delete --before='3 weeks ago'
/clients/engineering > del-old-backups

After creating a script with the desired backup deletion parameters, type the following to
delete the backups from the Avamar server:
/bin/sh -x ./del-old-backups

modify-snapups 343
EMC CONFIDENTIAL
Command Reference

mondo
The mondo command monitors server disk operations.

Synopsis
mondo [--debug] [--dryrun] [--help] [--raw] [--verbose] [--xml]

Options
The following options are available for the mondo command.

Table 251 Command options for mondo command

Option Description

--dryrun Shows example session information but does not perform the specified actions.

--debug Shows debugging information.

--help Shows help, then exits.

--raw When --xml is specified, do not include XML headers.

--verbose Provides maximum information.

--xml Format output in XML.

monmcs
The monmcs command obtains MCS status by running mcserver.sh --status.

Synopsis
monmcs [--mail]

Options
The following option is available for the monmcs command.

Table 252 Command options for the monmcs command

Option Description

--mail If --mail is supplied, suspicious status issues cause mail to be sent to the admin user on
the utility node.

344 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

monthly_cron_run
The monthly_cron_run command is intended to be run as a cron job at monthly intervals.
It is intended to be invoked by cron_env_wrapper.



Beginning with version 5.0, this command has been deprecated.

Synopsis
monthly_cron_run [--debug] [--help]

Options
The following options are available for the monthly_cron_run command.

Table 253 Command options for monthly_cron_run command

Option Description

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits.

morning_cron_run
The morning_cron_run command runs the morning cron job. morning_cron_run calls
cp_cron, gc_cron, and hfscheck_cron, and is intended to be invoked by
cron_env_wrapper.



Beginning with version 5.0, this command has been deprecated.

To run this script directly from a command shell, type the following:
cron_env_wrapper morning_cron_run

This command must be run as user dpn. This program attempts to load the dpnid
OpenSSH key from the dpn user .ssh directory. This command fails if it is run as a different
user.

monthly_cron_run 345
EMC CONFIDENTIAL
Command Reference

msgbrokerctl.pl
The msgbrokerctl.pl Perl script performs start, stop, and configuration tasks for the
RabbitMQ message broker, which is used by Backup & Recovery Manager (BRM).

Synopsis
msgbrokerctl.pl {--cassetup | --help | --setup | --start | --stop}
[--brmhost=ADDRESS] [--brmpass=PASSWORD] [--brmport=PORT]
[--brmuser=USER]

Options
The following options are available for the msgbrokerctl.pl command.

Table 254 Command options for the msgbrokerctl.pl command

Option Description

--brmhost=ADDRESS Used with -- setup to specify the BRM message broker hostname or
address. Default is localhost.

--brmpass=PASSWORD Used with -- setup to specify the password for the --brmuser user
account.

--brmport=PORT Used with -- setup to specify an alternate BRM message broker data
port. Default setting is port 5671.

--brmuser=USER Used with -- setup to specify the BRM user account for calling BRM
certificate services.

--cassetup Configures RabbitMQ message broker for single sign-on.

--help Shows help, then exits.

--setup Configures RabbitMQ message broker.

--skipcas Used with -- setup to skip single sign-on configuration.

--start Starts RabbitMQ message broker.

--stop Stops RabbitMQ message broker.

346 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

nodedb
The nodedb program creates and maintains a node resource database, which stores
information about server nodes and their network interfaces.
The default name and location of the node resource database file is
/usr/local/avamar/var/probe.xml.
Individual nodedb program commands add, delete, update, or display objects in the node
resource database. For example, the nodedb add if command adds a network interface to
the node resource database. Each command has its own options. However, all commands
can use any of the global options listed elsewhere in this topic.
Because the nodedb command confines its operations solely to the node resource
database file, consider using a more comprehensive tool such as dpnnetutil, which also
updates other system files, before using nodedb.
In Avamar 5.0 and later versions, the probe.xml file, replaces the probe.out file.

Synopsis
nodedb {add node | add if | create | delete if | delete module
| delete nat | delete node | print | update if | update module
| update node}

[--help] [--legacy_path=PATH] [--nolegacy] [--path=PATH]

Commands
Supply one and only one of the following commands with nodedb.

Table 255 Commands for the nodedb command

Command Description

add if Adds a network interface.

add node Adds a node.

create Creates a probe.xml file.

delete if Deletes a network interface.

delete module Deletes an entire module.

delete nat Deletes Network Address Translation (NAT) entries from all network interfaces.

delete node Deletes a node.

print Shows the database or selected portions.

update if Updates a network interface.

update module Updates a module.

update node Updates a node.

nodedb 347
EMC CONFIDENTIAL
Command Reference

Global options
The following global options are available for the nodedb command.

Table 256 Global options for nodedb commands

Option Description

--help Shows help, then exits. Use a command with --help to view
context-specific help.

--legacy_path=PATH Specifies the full PATH of the legacy node resource database file
(probe.out).
The default setting is /usr/local/avamar/var.
When the --path=PATH option is specified, the probe.out file is placed
into the same parent directory as the new node resource database file
(probe.xml).

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nolegacy Updates the legacy node resource database (probe.out) after updating
the new node resource database (probe.xml).
The default setting is --legacy, except when using nodedb create.
Until the node resource database contains enough entries, use the
--nolegacy option. If there is insufficient information in the node resource
database to support updating the legacy node resource database,
nodedb returns an error.
Most commands that update the node resource database support the
--legacy option.

--path=PATH Specifies the full PATH of the node resource database file to be created,
updated or displayed.
The default setting is /usr/local/avamar/var.

Environment variables
The nodedb command uses the following environment variables.

Table 257 Environment variables used by the nodedb command

Environment variable Description

$SYSNODEDB Path of the node resource database file. This file need not be named
probe.xml.

$SYSPROBEDIR Path of a directory containing the probe.xml file.

Search precedence
The nodedb program searches for a node resource database file by using the following
order of precedence:
1. The --path or --nodedb command line options.
2. The value of the environment variable SYSNODEDB.
3. The value of the environment variable SYSPROBEDIR.
4. The current working directory.
5. The default directory, /usr/local/avamar/var.

348 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Use the following command to show which node resource database file is selected:
nodedb print --say

Module and node reference notation

The nodedb program accepts module and physical node numbers as input. Avamar
represents module and node numbers as MODULE.NODE. The following table lists module
and node reference notation:

Table 258 Module and node reference notation

Module/node number Description

0.s Utility node in module 0

0.0 First storage node in module 0

0.# All storage nodes in module 0

#.s All utility nodes in all modules

#.# All storage nodes in all modules

all All utility and storage nodes in all modules

0.all Equivalent to 0.s,0.#

0.all+ All nodes including optional node types in module 0

all+ Equivalent to #.all+

0.access.0 First access node in module 0

0.accelerator.0 First accelerator node in module 0

0.spare.0 First spare node in module 0

0.utility Utility node in module 0 (equivalent to 0.s)

0.storage.0 First storage node in module 0 (equivalent to 0.0)

0.unclassified.0 First unclassified node in module 0

0.access.# All access nodes in module 0

0.accelerator.# All accelerator nodes in module 0

0.spare.# All spare nodes in module 0

0.storage.# All storage nodes in module 0 (equivalent to 0.#)

0.unclassified.# All unclassified nodes in module 0

nodedb 349
EMC CONFIDENTIAL
Command Reference

For nodedb commands that accept multiple nodes as input, specify a comma-delimited
list of nodes. The following table lists examples.

Table 259 Examples of comma-delimited lists of nodes

List of nodes Description

0.0,0.1,0.2 Specifies the first, second, and third storage nodes in module 0.

0.s,0.# Specifies the utility node and all of the storage nodes in module 0.

#.#,-0.1 Specifies all storage nodes except for the second storage node in module 0.

To exclude nodes in a comma-delimited list, prefix the module or node notation with a
minus sign (-). For example, to designate all storage nodes except for the second storage
node in module 0, specify #.#,-0.1.
Apply inclusions or exclusions from left to right. Exclusions apply only to previously
specified sets of nodes. For example, to evaluate the same set of nodes as #.#, specify
-0.1,#.#.

Notes
This command added in version 5.0.

350 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

nodedb add if
The nodedb add if command adds a network interface to an existing node.

Synopsis
nodedb add if --addr=ADDRESS [--allow=USES] [--deny=USES]
[--nat=INITIAL-ADDRESS1=TARGET-ADDRESS1[,...]] [--node=NODE-ID]
--nwgrp=NUM

Command options
The following command options are available for the nodedb add if command.

Table 260 Command options for the nodedb add if command

Option Description

--addr=ADDRESS Specifies the IPv4 address of the network interface.

--allow=USES Specifies the types of uses (functions) allowed by the network

interface:
• all
• backup
• internal
• none

--deny=USES Specifies the types of uses (functions) denied by the network

interface.
• all
• backup
• internal
• none

--nat=INITIAL-ADDRESS1= Specifies an initial contact address and target address for the
TARGET-ADDRESS1[,...] utility node or single-node server. Use a comma-separated list to
specify multiple addresses.

--node=NODE-ID Specifies a node by using its module and physical node number.

--nwgrp=NUM Specifies the network group ID as a positive integer (NUM).

This option added in version 6.0.

Examples
The following examples show how to use the nodedb add if command with options to add
a network interface to node 0.0:
nodedb add if --addr=10.1.2.7 --node=0.0 --nwgrp=1
<network-interface id="1">
<address value="10.1.2.7"/>
</network-interface>

nodedb add if --addr=172.16.1.12 --nat=192.168.100.12=192.168.100.13

--node=0.0 --nwgrp=1
<network-interface id="1">
<address value="172.16.1.12"/>
<nat-address initial="192.168.100.12" target="192.168.100.13"/>
</network-interface>

nodedb add if --addr=10.24.72.16 --node=0.0 --deny=backup --nwgrp=1

<network-interface id="1">

nodedb 351
EMC CONFIDENTIAL
Command Reference

<address value="10.24.72.16"/>
<uses deny="backup"/>
</network-interface>

Notes
This command added in version 5.0.

nodedb add node

The nodedb add node command adds a node and an IP address to probe.xml. Specify the
node by using either the --node=NODE-ID option or the --type=NODE-TYPE option.
The nodedb add node command creates a module and adds it to probe.xml if probe.xml
does not have one.

Synopsis
nodedb add node --addr=ADDRESS [--after | --before | --replace]
[--allow=USES] [--connected=BOOLEAN] [--deny=USES] [--module=INDEX]
[--nat=INITIAL-ADDRESS1=TARGET-ADDRESS1[,...]]
[--node=NODE-ID |--type=NODE-TYPE] --nwgrp=NUM

Command options
The following command options are available for the nodedb add node command.

Table 261 Command options for the nodedb add node command (page 1 of 2)

Option Description

--addr=ADDRESS Specifies the IPv4 address of the network interface.

--after | --before Specifies the placement of a node relative to another node. Use
| --replace this option with the --node=NODE-ID option.
• --after—Places the new node after the specified node.
• --before—Places the new node before the specified node.
• --replace—Replaces the specified node with the new node.

--allow=USES Specifies the types of uses (functions) allowed by the network

interface:
• all
• backup
• internal
• none

--connected=BOOLEAN Specifies a node as available or unavailable by using Boolean

values of true or false.

--deny=USES Specifies the types of uses (functions) denied by the network

interface.
• all
• backup
• internal
• none

--module=INDEX Specifies a module’s index number.

352 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 261 Command options for the nodedb add node command (page 2 of 2)

Option Description

--nat=INITIAL-ADDRESS1= Specifies an initial contact address and target address for the
TARGET-ADDRESS1[,...] utility node or single-node server. Use a comma-separated list to
specify multiple addresses.

--node=NODE-ID Specifies a node by using its module and physical node number.
Use --after | --before | --replace with this option.

--nwgrp=NUM Specifies the network group ID as a positive integer (NUM).

This option added in version 6.0.

--type=NODE-TYPE Specifies a node by using its type:

• utility
• storage
• access
• accelerator
• spare
• single-node server
• unclassified

Examples
To add a single-node server element, type:
nodedb add node --addr=10.1.2.3 --type=single --nolegacy --nwgrp=1

You can specify an abbreviated version of single-node server for the --type attribute.
This command adds the following XML output to the probe.xml file:
<node type="single-node server">
<network-interface id="1">
<address value="10.1.2.3"/>
</network-interface>
</node>

To add a utility node to module 0, type:

nodedb add node --addr=10.1.2.3 --node=0.s --nolegacy --nwgrp=1

This command adds the following XML output to the probe.xml file:
<node type="utility">
<network-interface id="1">
<address value="10.1.2.3"/>
</network-interface>
</node>

To add a storage node at index position 0 to module 0, type:

nodedb add node --addr=10.1.2.4 --allow=backup --node=0.0 --nwgrp=1

The --allow=backup attribute permits backups to the storage node. This command adds
the following XML output to the probe.xml file:
<node type="storage">
<network-interface id="1">
<address value="10.1.2.4"/>
<uses allow="backup"/>
</network-interface>
</node>

nodedb 353
EMC CONFIDENTIAL
Command Reference

To add a spare node at index position 0 to module 0, type:

nodedb add node --addr=10.1.2.5 --connected=false --node=0.spare.0
--nwgrp=1

The --connected=false attribute means the spare node is not connected. This command
adds the following XML output to the probe.xml file:
<node type="spare" connected="false">
<network-interface id="1">
<address value="10.1.2.5"/>
</network-interface>
</node>

To add a storage node with nat-address information at index position 0 to module 0, type
the following command on a single command line:
nodedb add node --addr=10.1.2.4 --nat=192.168.100.12=192.168.100.13
--node=0.0 --nwgrp=1

This command adds the following XML output to the probe.xml file:
<node type="storage">
<network-interface id="1">
<address value="10.1.2.4"/>
<nat-address initial="192.168.100.12" target="192.168.100.13"/>
</network-interface>
</node>

To add a new storage node at index position 1 in module 0, type:

nodedb add node -addr=10.1.2.5 --after --node=0.0 --type=storage
--nwgrp=1

This command adds the following XML output to the probe.xml file:
<node type="storage">
<network-interface id="1">
<address value="10.1.2.5"/>
</network-interface>
</node>

Notes
This command added in version 5.0.

354 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

nodedb create
The nodedb create command creates a probe.xml file at the specified PATH. This
command is optional.

Synopsis
nodedb create [--force] [--legacy [--optional_nodes]]
[--module=NAME[,...]]

Command options
The following command options are available for the nodedb create command.

Table 262 Command options for the nodedb create command

Option Description

--force The --force option overwrites an existing probe.xml file.

The default setting is --noforce.

---legacy The --legacy option creates a probe.out file from a probe.xml file.
[--optional_nodes]
The --optional_nodes option adds addresses of optional nodes as
additional storage node addresses in the probe.out file.
The default setting is --nolegacy.

--module=NAME[,...] Specifies the name of the module.

Examples
To created an empty module element, type:
nodedb create --module="`hostname`"

This command creates an empty module element with the name attribute set to the IP
address of the node on which the command was run:
<module name="avamar01.example.com"/>

To create a probe.out file from the existing node resource database, type:
nodedb create --legacy

Notes
This command added in version 5.0.

nodedb 355
EMC CONFIDENTIAL
Command Reference

nodedb delete if
The nodedb delete if command deletes the network interface by using the specified
address.

Synopsis
nodedb delete if --addr=ADDRESS

Command options
The following command option is available for the nodedb delete if command.

Table 263 Command options for the nodedb delete if command

Option Description

--addr=ADDRESS Specifies the IPv4 address of the network interface.

Example
To delete the network interface assigned to 172.16.1.12, type:
nodedb delete if --addr=172.16.1.12

Notes
This command added in version 5.0.

nodedb delete module

The nodedb delete module command deletes the module at the specified index position.
Index zero (0) is the first module.

Synopsis
nodedb delete module --index=INDEX

Command options
The following command option is available for the nodedb delete module command.

Table 264 Command options for the nodedb delete module command

Option Description

--index=INDEX Specifies a module’s index number.

Example
To delete a module at index 0, type:
nodedb delete module --index=0

Notes
This command added in version 5.0.

356 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

nodedb delete nat

The nodedb delete nat command deletes a specific nat-address element or all nat-address
elements.

Synopsis
nodedb delete nat --nat=INITIAL-ADDRESS[=TARGET-ADDRESS]

Command options
The following command option is available for the nodedb delete nat command.

Table 265 Command options for the nodedb delete nat command

Option Description

--nat=INITIAL-ADDRESS[=TARGET-ADDRESS] Specifies an initial contact address and target

address for the utility node or single-node
server. Use a comma-separated list to specify
multiple addresses.

Example
To delete a nat-address element for IP address 192.168.100.12, type:
nodedb delete nat --nat=192.168.100.12

Notes
This command added in version 5.0.

nodedb delete node

The nodedb delete node command deletes the node element for NODE-ID.

Synopsis
nodedb delete node --node=NODE-ID

Command options
The following command option is available for the nodedb delete node command.

Table 266 Command options for the nodedb delete node command

Option Description

--node=NODE-ID Specifies a node by using its module and physical node number.

Example
To delete a storage node at index position 4 from module 0, type:
nodedb delete node --node=0.4

Notes
This command added in version 5.0.

nodedb 357
EMC CONFIDENTIAL
Command Reference

nodedb print
The nodedb print command displays all or selected parts of the probe.xml file. The default
displays all information.

Synopsis
nodedb print [--nodes=NODELIST [--addr | --nat] [--id]
[--internal |--backup]] [--say]

Command options
The following command options are available for the nodedb print command.

Table 267 Command options for the nodedb print command

Option Description

--nodes=NODELIST Specifies one or more nodes by using MODULE.NODE notation.

Multiple entries require commas.

--say Displays the path of the selected node resource database.

The default setting is --nosay.

Modifiers
The --nodes=NODELIST option can use one or more of the following modifiers.

Table 268 Modifiers for the --nodes=NODELIST option in the nodedb print command

Modifier Description

--addr Shows the network interface address information for the nodes specified by the
--nodes=NODELIST option.

--nat Shows NAT address information for all network interfaces of the node specified by
the --nodes=NODELIST option.

--id Shows physical node number such as 0.s, 0.0 and so forth.

--internal Shows address or NAT address information for network interfaces that allow
internal use.

--backup Shows address or NAT address information for network interfaces that allow
backup use.

Examples
To display all storage nodes, type:
nodedb print --nodes=#.#

To display all nodes that include optional node types in module 0, but exclude utility and
storage nodes in module 0, type:
nodedb print --nodes=0.all+,-0.all

To display the network interface address for all utility and storage nodes in all modules,
type:
nodedb print --nodes=all --addr

358 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

To display the NAT address information for the first and second storage node in module 0,
type:
nodedb print --nodes=0.0,0.1 --nat

To display the network interface and physical node number for all utility, storage and
optional nodes in all modules, type:
nodedb print --nodes=all+ --addr --id

To display the NAT and physical node number for all storage nodes in all modules that
allow backup use, type:
nodedb print --nodes=#.# --nat --backup --id

To display all information in the node resource database (probe.xml), type:

nodedb print

To display all information in the node resource database including the full path and
filename of the node resource database in use, type:
nodedb print --say

Notes
This command added in version 5.0.

nodedb 359
EMC CONFIDENTIAL
Command Reference

nodedb update if
The nodedb update if command updates attributes of a specified network interface.

Synopsis
nodedb update if [--addr=ADDRESS | --nat=TARGET-ADDRESS]
[--new-addr=ADDRESS]
[--new-nat=[INITIAL-ADDRESS1=TARGET-ADDRESS1[,...]]]
[--new-allow=[USES]] [--new-deny=[USES]] [--nwgrp=NUM]

Command options
The following command options are available for the nodedb update if command.

Table 269 Command options for the nodedb update if command

Option Description

--addr=ADDRESS | Specifies the network interface by using either the network

--nat=TARGET-ADDRESS interface address (--addr) or the NAT target address (--nat).

--new-addr=ADDRESS Specifies a new network interface address, which replaces

the current network interface address.

--new-nat=[INITIAL-ADDRESS1= Specifies a new INITIAL-ADDRESS for the network interface.

TARGET-ADDRESS1[,...]]
To delete a single nat-address element (the one
corresponding to the TARGET-ADDRESS), specify:
--new-nat=

To delete all nat-address elements from the network

interface, use the wildcard symbol (#) in place of
INITAIL-ADDRESS or TARGET-ADDRESS. For example:
--new-nat=#

--new-allow=USES Updates the types of uses (functions) allowed by the

network interface:
• all
• backup
• internal
• none
To delete uses for an interface, specify none.

--new-deny=USES Updates the types of uses (functions) denied by the

network interface:
• all
• backup
• internal
• none

--new-nwgrp=NUM Specifies a new network group ID as a positive integer

(NUM).
This option added in version 6.0.

Examples
To update a network interface whose initial NAT target address matches 192.168.100.12
to 192.168.100.14, type:
nodedb update if --nat=192.168.100.12
--new-nat=192.168.100.12=192.168.100.14

360 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

The nat-address/@target attribute value is replaced with 192.168.100.14:

<nat-address initial="192.168.100.12" target="192.168.100.14"/>

To delete a NAT target address that matches 196.168.100.13 from a network interface,
type:
nodedb update if --nat=192.168.100.13 --new-nat=

To delete all nat-address elements for a network interface whose nat-address/@target

attribute value matches 192.168.100.13, type:
nodedb update if --nat=192.168.100.13 --new-nat=#

To remove the uses/@allow attribute from a network interface whose address/@value

attribute matches 10.1.2.3, type:
nodedb update if --addr=10.1.2.3 --new-deny=backup --new-allow=

To update the address/@value attribute for a network interface whose address/@value

attribute matches 10.1.2.3, type:
nodedb update if --addr=10.1.2.3 --new-addr=10.1.2.4

The address/@value attribute updates to 10.1.2.4:

<address value="10.1.2.4"/>

Notes
This command added in version 5.0.

nodedb 361
EMC CONFIDENTIAL
Command Reference

nodedb update module

The nodedb update module command updates the name of the module at the specified
index position, where 0 is the first module.

Synopsis
nodedb update module --index=INDEX --new-name=NAME

Command options
The following command options are available for the nodedb update module command.

Table 270 Command options for the nodedb update module command

Option Description

--index=INDEX Specifies a module’s index number.

--new-name=NAME Specifies a modules new name.

Example
nodedb update module --index=0 --new-name=avamar01

Notes
This command added in version 5.0.

362 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

nodedb update node

The nodedb update node command updates a node from one type to another.

Synopsis
nodedb update node --node=NODE-ID [--new-type=NODE-TYPE]
[--new-connected=BOOLEAN]

Command options
The following command options are available for the nodedb update node command.

Table 271 Command options for the nodedb update node command

Option Description

--node=NODE-ID Specifies a node by using a module and physical node number.

--new-type=NODE-TYPE Specifies the node type:

• utility
• storage
• access
• accelerator
• spare
• single-node server
• unclassified

--new-connected=BOOLEAN Specifies a node as available or unavailable by using Boolean

values “true” or “false.”

Examples
To update spare node 0 in module 0 to a storage node and update its connect status to
true, type:
nodedb update node --node=0.spare.0 --new-type=storage
--new-connected=true

To update the connected status to false for storage node 4 in module 0, type:
nodedb update node --node=0.4 --new-connected=false

Notes
This command added in version 5.0.

nodedb 363
EMC CONFIDENTIAL
Command Reference

nodenumbers
The nodenumbers command generates a table that shows the logical node number,
physical node number, IP address and MAC address of each node in an Avamar server.
The nodenumbers program compares the contents of the probe.out file, to the output of
the avmaint nodelist command. This information is written to both STDOUT (screen) and
to $SYSPROBEDIR/nodenumbers.out.
The nodenumbers program requires that the Avamar server be running to deliver this
information.

Synopsis
nodenumbers [--debug] [--error] [--help] [--hfsaddr=AVAMARSERVER]
[--id=USER@AUTH] [--n | --norun] [--nodedb=FILE] [--nodes=NODELIST]
[--password=PASSWORD] [--ping_only] [--q | --quiet] [--run]
[--user=USER-ID] [--v | --verbose]

Options
The following options are available for the nodenumbers command.

Table 272 Command options for the nodenumbers command

Option Description

--debug Enables debugging messages.

--error Generates error when execution fails.

--help Shows help, then exits.

--hfsaddr=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined

in DNS).

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication
domain is “avamar.”
For example: jdoe@avamar.

--n | --norun Lists but does not execute commands.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nodes=NODELIST Constrains output to a comma-separated LIST of nodes.

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

--q | --quiet Runs quietly.

--run Executes all commands (opposite of --n or --norun).

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--v | --verbose Provides maximum information (default).

364 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 273 Deprecated command options for the nodenumbers command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Notes
Consider the following notes for the nodenumbers command:
◆ This command must be run as user admin.
◆ This program requires a valid probe.out file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable typically stores the
path to a directory containing a valid probe.out file. If SYSPROBEDIR is not set, the
default probe.out location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.

Output
Nodenumbers Utility [v1.6] Thu Oct 9 12:24:59 PDT 2013
Using /usr/local/avamar/var/probe.xml
Running 'avmaint nodelist --hfsaddr=10.0.30.10'.
Appending to /usr/local/avamar/var/nodenumbers.out
HFSCreateTime=1034287466 (Thu Oct 10 22:04:26 2013 UTC)
Avamar probe.xml
Logical Node Physical Node IP Address MAC Address
0.0 0.0 10.0.30.10 00:30:48:51:CF:C8
0.1 0.1 10.0.30.11 00:30:48:51:D5:3F
0.2 0.2 10.0.30.12 00:30:48:51:D3:7E
0.3 0.3 10.0.30.13 00:30:48:51:EB:12
0.4 0.4 10.0.30.14 00:30:48:51:5D:5C
0.5 0.5 10.0.30.15 00:30:48:51:D5:F6
0.6 0.6 10.0.30.16 00:30:48:51:EF:3C
1.0 1.0 10.0.31.10 00:30:48:51:CF:CC
1.1 1.1 10.0.31.11 00:30:48:51:69:4E
1.2 1.2 10.0.31.12 00:30:48:51:D3:1E
1.7 < 1.3 10.0.31.13 00:30:48:51:D1:70
1.8 1.5 < 10.0.31.17 < 00:30:48:51:D1:82
1.9 1.4 < 10.0.31.15 < 00:30:48:51:B9:0F
1.A 1.6 < 10.0.31.18 < 00:30:48:51:E9:6E

Notes:
- "<" means Out of Sequential Order.
- "Physical" means "probe order", not rack location.

nodenumbers 365
EMC CONFIDENTIAL
Command Reference

opstatus.dpn
The opstatus.dpn command returns Avamar server operational status as one of the
following messages or exit codes.

Table 274 Operational status messages

Message Exit code

server up: ITEMS 0

server degraded: ITEMS 1

server down: ITEMS 2

server unresponsive 3

where ITEMS indicates what, if known, is running on the server.

Synopsis
opstatus.dpn [--help] [--quiet]

Options
The following options are available for the opstatus.dpn command.

Table 275 Command options for the opstatus.dpn command

Option Description

--help Shows help, then exits.

--quiet If specified, only exit codes are returned.

Notes
A status of server unresponsive means that opstatus.dpn could not contact the Avamar
server for status. This might mean that there are network problems, or that the server is
not operational on two or more nodes. When this status is returned, it is not possible to
determine with certainty whether the server is operational or not. Further investigation of
the storage nodes is required to make this determination.

366 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

permctl
The permctl command controls Avamar File System (AvFS) object ownership and
permissions.

Synopsis
permctl {check_config | fix | help | status} [--debug] [--dir=PATH]
[--file=PATH] [--help] [--nodes=NODELIST] [--quietly] [--verbose]

Commands
Supply one and only one of the following commands on each permctl command line.

Table 276 Commands for the permctl command

Command Description

check_config Checks configuration files only.

fix Fixes ownership and permissions deviations.

help Shows help, then exits. Same as --help.

status Reports on ownership and permissions deviations without fixing them.

Options
The following options are available for the permctl command.

Table 277 Command options for permctl command

Option Description

--debug Shows example session information but does not perform the specified
actions.

--dir=PATH Specifies the PATH to the configuration directory.

--file=PATH Specifies the PATH to a single file system object.

--help Shows help, then exits.

--nodes=NODELIST Specifies one or more nodes by using MODULE.NODE notation.

Multiple entries require commas.

--quietly When supplied with fix command, does not report on fixed ownership or
permissions.

--verbose Provides maximum information.

permctl 367
EMC CONFIDENTIAL
Command Reference

pingmcs
The pingmcs command pings the MCS.

Synopsis
pingmcs [--mail]

Options
The following option is available for the pingmcs command.

Table 278 Command options for the pingmcs command

Option Description

--mail If --mail is supplied, suspicious status issues cause mail to be sent to the admin user on
the utility node.

probe
The probe command generates a probe.out file, which is used by other utilities to resolve
simple MODULE.NODE designations into actual IP addresses.
Begining with Avamar 5.0, probe.xml replaces probe.out. Instead of using probe to
generate a probe.out file, use nodedb, to generate a probe.xml file.

Synopsis
probe [--admin=IP-ADDR] [--help] [--mcs=IP-ADDR] [--nat] [--nodes=NUM]
[--probedir=PATH] [--single] [--sort={ascending | descending}]
AVAMARSERVER

where AVAMARSERVER is the Avamar server hostname as defined in corporate DNS.

Options
The following options are available for the probe command.

Table 279 Command options for the probe command (page 1 of 2)

Option Description

--admin=IP-ADDR Specifies the MCS IP address (IP-ADDR).

--help Shows help, then exits.

--mcs=IP-ADDR Specifies the MCS IP address (IP-ADDR).

--nat If supplied, Avamar server is configured to use Network Address

Translation (NAT).

--nodes=NUM Specifies the number (NUM) of nodes to probe. The default setting is all.

--probedir=PATH Specifies the directory PATH for output files.

368 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 279 Command options for the probe command (page 2 of 2)

Option Description

--single Creates a probe.out file for a single-node server.

This option must be supplied when running probe on single-node
servers.

--sort={ascending If supplied, sorts stprage node IP addresses in ascending or descending

| descending} order.

Notes
Consider the following notes for the probe command:
◆ This command reads a default operating system user ID from the SYSPROBEUSER
environment variable. If SYSPROBEUSER is not set, then remote commands are run as
user admin.
◆ By default, probe.out is saved in the /usr/local/avamar/var directory. If the
SYSPROBEDIR environment variable is set, then probe.out is saved to that location.
◆ When running probe on a multi-node server, the probe.out file is not correctly
generated if the utility node or any of the storage nodes are not functioning correctly.
Additionally, probe requires a valid DHCP leases file for the storage nodes to correctly
report their IP addresses.
◆ Once a probe.out file is created, it need not be changed unless nodes are added or
removed from the Avamar server.

probeaux
The probeaux command is an auxiliary script used by probe.
Documentation for this script is provided for reference purposes only. Do not run probeaux
directly from the command line.

probeaux 369
EMC CONFIDENTIAL
Command Reference

probedump
The probedump command reports storage node physical node IDs and their
corresponding IP addresses, as found in the probe.out file.
This program does not require that the Avamar server be running.

Synopsis
probedump [--help] [--nodes=NODELIST] [--probedir=PATH]

Options
The following options are available for the probedump command.

Table 280 Command options for the probedump command

Option Description

--help Shows help, then exits.

--nodes=NODELIST Constrains output to a comma-separated LIST of nodes.

--probedir=PATH Specifies a PATH to a directory containing a valid probe.out file.

Notes
This program requires a valid probe.out file to resolve MODULE.NODE designations into
actual IP addresses. The SYSPROBEDIR environment variable typically stores the path to a
directory containing a valid probe.out file. If SYSPROBEDIR is not set, the default probe.out
location (/usr/local/avamar/var/) is used. You can also override this location with the
--probedir=PATH option.

Example output
[probedump v1.2]
Using /usr/local/avamar/var/probe.out
Physical Node IP Address
0.0 10.0.30.10
0.1 10.0.30.11
0.2 10.0.30.12
0.3 10.0.30.13
0.4 10.0.30.14
0.5 10.0.30.15
0.6 10.0.30.16
1.0 10.0.31.10
1.1 10.0.31.11
1.2 10.0.31.12
1.3 10.0.31.13
1.4 10.0.31.15
1.5 10.0.31.17
1.6 10.0.31.18

Note:
- "Physical" means "probe order", not rack location.

370 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

probesingle
The probesingle command generates a probe.out file on single-node servers only. It is
functionally equivalent to running probe --single.

Synopsis
probesingle [--help] [--probedir=PATH] AVAMARSERVER

where AVAMARSERVER is the Avamar server IP address or hostname as defined in

corporate DNS.

Options
The following options are available for the probesingle command.

Table 281 Command options for the probesingle command

Option Description

--help Shows help, then exits.

--probedir=PATH Specifies the directory PATH for output files.

Notes
By default, probe.out is saved in the /usr/local/avamar/var directory. If the SYSPROBEDIR
environment variable is set, then probe.out is saved to that location.

probesingle 371
EMC CONFIDENTIAL
Command Reference

propagate-gsan
The propagate-gsan command copies the correct version gsan binary to all storage nodes
in the system in the same manner as restart.dpn --copy. However, propagate-gsan
accomplishes this without restarting the data server and performs some additional
checks.
Documentation for this command is provided for reference purposes only. The
propagate-gsan program is typically invoked by dpnctl, and should not be run directly
from the command line.

Synopsis
propagate-gsan [--debug] [--exedir=PATH] [--help] [--profiling]
[--verbose]

Options
The following options are available for the propagate-gsan command.

Table 282 Command options for the propagate-gsan command

Option Description

--debug Shows example session information but does not perform the specified
actions.

--exedir=PATH Specifies the full PATH to parent directory of relevant executables.

--help Shows help, then exits.

--profiling If supplied, use profiling version of gsan binary.

--verbose Provides maximum information.

372 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

psregrep
The psregrep command implements specialized regular expression (regex) pattern
matching of UNIX ps command output.
It is primarily used to assist EMC engineering with debugging.

Synopsis
psregrep [--debug] [--help] [--pattern=REGEX] [--verbose]

Options
The following options are available for the psregrep command.

Table 283 Command options for the psregrep command

Option Description

--debug Shows example session information but does not perform the specified
actions.

--help Shows help, then exits. Same as supplying the help command.

--pattern=REGEX Search for this regular expression (REGEX) in ps output.

--verbose Provides maximum information.

psregrep 373
EMC CONFIDENTIAL
Command Reference

pull-checkpoint
The pull-checkpoint command retrieves selected checkpoints tar bundles that were
previously saved using store-checkpoint.

Synopsis
pull-checkpoint [--bump=N] [--debug] [--dryrun] --dst=NODE-LIST
[--dstkey=FILE] [--gunzip] [--help] [--srckey=FILE] --src=NODE
[--verbose]

Options
The following options are available for the pull-checkpoint command.

Table 284 Command options for the pull-checkpoint command

Option Description

--bump=N Increments source partition numbers by N.

--debug Shows example session information but does not perform the specified
actions.

--dryrun Runs auxiliary scripts in debug mode.

--dst=NODE-LIST Specifies the destination Avamar nodes (NODE-LIST). This option is required.

--dstkey=FILE Specifies the path to destination Avamar server OpenSSH dpnid key FILE.

--gunzip Un-gzips compressed tarballs (.tgz files).

--help Shows help, then exits.

--src=NODE Specifies the source Avamar NODE. This option is required.

--srckey=FILE Specifies the path to source Avamar server OpenSSH dpnid key FILE.

--verbose Provides maximum information.

Notes
Consider the following notes for the pull-checkpoint command:
◆ You must load the dpnid OpenSSH key before running this command.
◆ This program requires that source and destination Avamar server nodes have similar
data partitioning schemes (for example, both source and destination servers have
/data01 through /data04 partitions).

Examples
The following example retrieves an available checkpoint bundle from source node 0.0 and
unpacks it on destination nodes 0.2 to 0.6:
pull-checkpoint --dst=0.2,0.3,0.4,0.5,0.6 --src=0.0

The following example retrieves an available checkpoint tar bundle from the specified
single-node server using that server's SSH key:
pull-checkpoint --dst=#.# --src=dpe17 --srckey=$HOME/.ssh/dpe17-dpnid

374 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

rebuild.node
The rebuild.node command rebuilds and restarts a node that has lost some or all of its
content.
First, the new node is restarted with the node ID of the non-operational node. Then,
attempts are made to rebuild that node's content in place. If this is successful, this
process is an effective alternative to attaching a node (with a new node ID), then
decommissioning the old node.

Synopsis
rebuild.node --nodes=MODULE.NODE [--check]
[--checkpoints={all | CP-ID[,CP-ID,...]}] [--clean] [--copy]
[--debug] [--encrypt=METHOD] [--error] [--force] [--help]
[--hfscheck] [--hfsdir=PATH] [--ignoresysconfig] [--kill]
[--lmaddr=HOSTNAME] [--lmport=PORT] [--nodedb=FILE] [--n | --norun]
[--ping_only] [--q | --quiet] [--runlevel={admin | fullaccess}]
[--savesysinfo] [--scanfile=PATH] [--sslport=PORT]
[--systemname=NAME] [--tag=MODULE.NODE] [--user=USER-ID]
[--usealtlogdir] [--usercheck] [--v | --verbose] [--wait]

Options
The following options are available for the rebuild.node command.

Table 285 Command options for the rebuild.node command (page 1 of 3)

Option Description

--nodes=MODULE.NODE Node descriptor, where MODULE.NODE is the physical node,

discussed in
You can specify only one node on each rebuild.node command line.
This option is required. If omitted, the program does not run.

--check Runs check.dpn. This is the default setting.

--checkpoints= Used with --clean to completely remove one or more specified

{all | checkpoints (CP-IDs) or all checkpoints from the specified node.
CP-ID[,CP-ID,...]}
This option added in version 4.1.

--clean If this option is not supplied (default behavior), rebuild.node checks

storage nodes for any existing data and ensures that it is not
overwritten (cleaned).
However, to rebuild with a clean storage node (all existing data
removed), supply the --clean option.

--copy Copies files to the storage nodes. This is the default setting.

--debug Shows example session information but does not perform the
specified actions.

--encrypt=METHOD Sets the encryption METHOD. Valid settings are:

• proprietary—No encryption.
• ssl:AES128-SHA—128-bit Advanced Encryption Standard.
• ssl:AES256-SHA—256-bit Advanced Encryption Standard.
• ssl—A special mode in which the program negotiates and uses the
strongest encryption setting that the session can support.
The default setting is proprietary.

--error Generates an error when execution fails.

rebuild.node 375
EMC CONFIDENTIAL
Command Reference

Table 285 Command options for the rebuild.node command (page 2 of 3)

Option Description

--force Forces the server to be run even if there are stripes present on the
node. This is not the default setting.

--help Shows help, then exits.

--hfscheck Performs an HFS check.

--hfsdir=PATH Specifies the root location where the /data0? data mounts are located
on the storage nodes. The default setting is '/'.

--ignoresysconfig Bypasses node compatibility checks.

This option added in version 6.0.

--kill Terminates any running Avamar processes before starting. This is not
the default setting.

--lmaddr=HOSTNAME Specifies the login manager host address.

--lmport=PORT Specifies the login manager PORT number.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--n | --norun Does not actually execute commands.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

--q | --quiet Runs quietly.

--runlevel= Sets the server run level to one of the following:

{admin | fullaccess}
• admin—Administration-only mode (only root and aroot users can
access the server).
• fullaccess—Full access by all users.

--savesysinfo If supplied, special storage server (GSAN) cleanliness tests are run.
This is the default setting.

--scanfile=PATH Specifies the full PATH and filename of the enhanced server log
scanning parameters information file, which is created using the
avmaint logscan command.

--sslport=PORT Specifies the SSL data PORT. The default setting is 29000.

--systemname=NAME Sets the initial user-defined descriptive system name at server

startup. NAME can be any combination of printable characters up to
32 characters in length.

--tag=MODULE.NODE Specifies an optional logical node ID (MODULE.NODE) so that nodes

can be rebuilt even if their logical ID is different from the physical ID.
MODULE and NODE are both single-digit integers. For example, utility
nodes are typically assigned 0.0 logical ID.

--usealtlogdir If set, uses the alternative log directory name as defined with the
altlogdir option of the gsan command.

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--usercheck Checks for the “admin” user account.

376 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 285 Command options for the rebuild.node command (page 3 of 3)

Option Description

--v | --verbose Provides maximum information.

--wait Calls wait.dpn, after starting the storage nodes. This is the default
setting.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 286 Avamar-only advanced command options for the rebuild.node command

Option Description

--exedir=PATH Dynamically locates the gsan executable according to the following

rules:
1. If --exedir is supplied, use that gsan executable without further
checking.
2. If the gsan executable exists in the current working directory,
use it.
In this case, check if the gsan executable exists in
/usr/local/avamar/bin also and, if so, print a warning if ./gsan
is older than /usr/local/avamar/bin/gsan.
3. If the gsan executable exists in /usr/local/avamar/bin, use it.
4. Otherwise, print a warning and set the exedir to the current
working directory (“.”).

--freezelimits="STRING" Specifies the upper limits for processor activity statistics. The
statistics must stay at or below the specified limits to consider the
server to be in an idle state. STRING must be in the following
format (which is also the default setting):
“busy=3,diskio=40,interrupt=200,switch=1000”

where:
• The busy statistic refers to the percentage of time that the CPU
is busy (the opposite of being idle).
• The diskio statistic refers to disk reads or writes per second.
• The interrupt statistic refers to interrupts per second.
• The switch statistic refers to context switches per second.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 287 Deprecated command options for the rebuild.node command (page 1 of 2)

Option Description

--checkpointdir=PATH Deprecated in version 5.0.

--crc Deprecated in version 5.0.

--delay Deprecated in version 5.0.

rebuild.node 377
EMC CONFIDENTIAL
Command Reference

Table 287 Deprecated command options for the rebuild.node command (page 2 of 2)

Option Description

--expert Deprecated in version 5.0.

--fillindex Deprecated in version 5.0.

--forcerestart Deprecated in version 5.0.

--fork Deprecated in version 5.0.

--indexelements Deprecated in version 5.0.

--inside Deprecated in version 5.0.

--minstripestowrite Deprecated in version 5.0.

--outside Deprecated in version 5.0.

--paritygroups Deprecated in version 5.0.

--poolsize Deprecated in version 5.0.

--probedir=PATH Deprecated in version 5.0.

--profiling Deprecated in version 5.0.

--ramfsoptions=OPTIONS Deprecated in version 5.0.2.

--splitcount Deprecated in version 5.0.

--splitspread Deprecated in version 5.0.

--squash Deprecated in version 5.0.

--syncwrite Deprecated in version 5.0.

--useram Deprecated in version 5.0.2.

--useramfs Deprecated in version 4.0.

--usestunnel Deprecated in version 6.1.

Notes
Consider the following notes for the rebuild.node command:
◆ Do not use both start.nodes and rebuild.node to recover the same node. Doing so
causes the server to fail and might result in loss of data.
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable typically stores the
path to a directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the
default probe.xml location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.

378 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

repl_cron
The repl_cron command is used to implement replication.
The repl_cron program reads all input from the /usr/local/avamar/etc/repl_cron.cfg
configuration file.
A sample repl_cron.cfg is provided in the /usr/local/avamar/bin directory. To use
replication, a live customized version must be placed in /usr/local/avamar/etc.

replicate
The replicate command recursively copies data from a source Avamar server to a
destination Avamar server.
Typically, replicate is invoked by way of repl_cron. The replicate program performs some
housekeeping functions, then invokes replicate using settings stored in the repl_cron.cfg
configuration file. The repl_cron.cfg file is a flag file that contains commands, options, and
settings that are passed to the replicate program at run time.

Synopsis
replicate --dstaddr=DEST-SERVER --dstid=USER@PATH
--dstpassword=PASSWORD --hfsaddr=AVAMARSERVER --id=USER@AUTH
--password=PASSWORD

[{--fullcopy | --reportonly | --restore}]

[--dpnname=SRC-SERVER | --dstpath=DOMAIN --srcpath=DOMAIN]

[--after=TIMESTAMP] [--before=TIMESTAMP] [--dstport=PORT]

[--exclude-pluginid-list=LIST] [--exclude=PATTERN[,PATTERN...]]
[--expiredelta=DAYS] [--flagfile=FILE] [--help]
[--include=PATTERN[,PATTERN...]][--pluginid-list=LIST]
[--progresslog=FILE] [--retention-type={daily | weekly | monthly |
yearly | none}] [--throttle=MBPS] [--timeout=SEC] [--version]

Required values
To support automated nightly replication, the --dstaddr, --dstid, and --dstpassword values
are typically specified in the repl_cron.cfg configuration file on the source server.
The --hfsaddr, --id, and --password values are typically read from the source server
usersettings.cfg file. Therefore, these values do not typically have to be included in the
repl_cron.cfg configuration file or on the command line.

Table 288 Required values for the replicate command (page 1 of 2)

Value Description

--dstaddr=DEST-SERVER Specifies a fully qualified DNS name or IP address of the destination

Avamar server (DEST-SERVER).

repl_cron 379
EMC CONFIDENTIAL
Command Reference

Table 288 Required values for the replicate command (page 2 of 2)

Value Description

--dstid=USER@PATH Authenticate on the destination Avamar server as this Avamar user

ID (account name) at this domain.
USER is the Avamar username, and PATH is the Avamar server
domain.
For example, supplying --dstid=admin@/REPLICATE/avamar-1,
specifies that the admin user account in the destination server
/REPLICATE/avamar-1 domain should be used to authenticate this
replication session.
This is useful for allowing selective replication on a
domain-by-domain basis.

--dstpassword=PASSWORD PASSWORD for the --dstid=USER@AUTH account.

--hfsaddr=AVAMARSERVER Source AVAMARSERVER IP address or fully qualified hostname (as

defined in DNS).

--id=USER@AUTH Authenticate on the source Avamar server as this Avamar user ID

(account name).
USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication
domain is “avamar.”
For example: jdoe@avamar.

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

Commands
Commands control which operational mode (normal, full replicate, report-only or restore)
is used. If no command is supplied, replicate operates in normal mode. If --fullcopy,
--reportonly, or --restore is supplied, then replicate operates in full replicate, report-only
or restore modes, respectively.
Supply one and only one of the following commands on each command line for replicate.

Table 289 Commands for the replicate command

Command Description

--fullcopy Asserts full “root-to-root” replication operational mode.

Full replication is a special operational mode that creates a complete logical
copy of an entire source server on the destination server. Furthermore, the
replicated data is not copied to the REPLICATE domain, it is added directly to the
root domain just as if source clients had registered with the destination server.
Also, source server data replicated in this manner is fully modifiable on the
destination server.

--reportonly Asserts report-only operational mode.

The mode is used to pre-determine the amount of storage a replication activity
might consume on a destination server by running the replication job without
actually saving any data to the destination server.
This command added in version 4.1.

--restore Asserts restore operational mode.

If you previously replicated a source Avamar server to a destination Avamar
server, running replicate from the destination server and supplying this
command restores that data to the source Avamar server.

380 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Destination descriptors
Destination descriptors are options that control where replicated data is stored on the
destination server. The following destination descriptors are available for the replicate
command.

Table 290 Destination descriptors for the replicate command

Descriptor Description

--dpnname=SRC-SERVER Specifies a name to use to represent the source server (SRC-SERVER)

on the destination server. This is the name that is used in the
REPLICATE domain on the destination server.
This option cannot be used with the --dstpath=DIR or --srcpath=DIR
options.

--dstpath=DOMAIN Specifies a location (DOMAIN) on the destination Avamar server where

replicated source data is stored.
The default setting is the top-level directory (/), which stores the
replicated data in a new domain named for the source Avamar server.
This option must be used in conjunction with the --srcpath=DOMAIN
option and cannot be used with the --dpnname=SRC-SERVER option.

--srcpath=DOMAIN Specifies a location (DOMAIN) on the source Avamar server from which
to begin replication. Only data beneath this location is replicated.
The default setting is the top-level domain (/), which replicates the
entire server.
This option must be used in conjunction with the --dstpath=DOMAIN
option and cannot be used with the --dpnname=SRC-SERVER option.

Options
The following options are available for the replicate command.

Table 291 Command options for the replicate command (page 1 of 4)

Option Description

--after=TIMESTAMP Specifies that only backups matching TIMESTAMP and later

should be replicated. TIMESTAMP must be specified using
24 hour local timezone values conforming to the following
syntax:
YYYY-MM-DD HH:MM:SS
Partial date strings are permitted. For example, 2013-02 is
equivalent to 2013-02-01 00:00:00.
This option can also be used with --before=TIMESTAMP to
define a range of effective dates. Only backups taken
within this date range are replicated.
Backups taken exactly at this TIMESTAMP are replicated.

--before=TIMESTAMP Specifies that only backups taken before TIMESTAMP

should be replicated. TIMESTAMP must be specified using
24 hour local timezone values conforming to the following
syntax:
YYYY-MM-DD HH:MM:SS
Partial date strings are permitted. For example, 2013-02 is
equivalent to 2013-02-01 00:00:00.
This option can also be used with --after=TIMESTAMP to
define a range of effective dates. Only backups taken
within this date range are replicated.

replicate 381
EMC CONFIDENTIAL
Command Reference

Table 291 Command options for the replicate command (page 2 of 4)

Option Description

--dstport=PORT Specifies the data PORT to use when connecting to the

destination Avamar server. The default setting is 27000.

--exclude-pluginid-list=LIST Constrains replication activity to exclude backups

originally taken with one or more plug-in types, where LIST
is a comma-separated list of one or more integer plug-in
IDs.
This option added in version 5.0.

--exclude=PATTERN Excludes clients containing PATTERN from a replication.

PATTERN is a single matching pattern. Common glob
operators (wildcards) such as asterisk (*) and question
mark (?) are allowed.
When specifying exclusions, case sensitivity varies
according to the target computing platform you are
backing up. Exclusions specified for Windows platforms
are not case-sensitive; exclusions specified for most other
platforms are case-sensitive.
For example, --exclude=spot excludes any source path
name that contains the pattern “spot.” --exclude=/clients/
excludes all clients within the /clients domain.
Multiple patterns can be separated by commas (for
example, --exclude=spot,/clients/). Multiple --exclude
options can also be used to specify more than one
PATTERN.

--expiredelta=DAYS Causes the specified number of DAYS to be added to the

expiration time for all newly replicated backups that
already have expiration dates. Backups that do not have
expiration dates are not affected (they still have no
expiration date after replication).
Therefore --expiredelta=30 adds 30 days to the expiration
dates of replicated backups that have expiration dates.

--flagfile=FILE Specifies the FILE containing a list of options and values

that are processed by this program as if they were included
on the command line. The default setting is
/usr/local/avamar/etc/usersettings.cfg.

--help Shows help, then exits.

382 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 291 Command options for the replicate command (page 3 of 4)

Option Description

--include=PATTERN Includes clients containing PATTERN in a replication

operation.
PATTERN is a single matching pattern. Common glob
operators (wildcards) such as asterisk (*) and question
mark (?) are allowed.

Note: 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.

For example, --include=spot includes any source path

name that contains the pattern “spot.” --include=/clients/
includes all clients within the /clients domain.
Multiple patterns can be separated by commas (for
example, --include=spot,/clients/). Multiple --include
options can also be used to specify more than one
PATTERN.

--pluginid-list=LIST Constrains replication activity to include backups originally

taken with one or more plug-in types, where LIST is a
comma-separated list of one or more integer plug-in IDs.
This option added in version 4.1.

--progresslog=FILE Specifies the optional local session log FILE that can be
used to monitor replication activity progress.
This option added in version 4.1.

--retention-type= Constrains replication activity to only replicate backups

{daily | weekly | monthly | assigned one of the following retention types:
yearly | none}
• daily—If supplied, only daily backups are replicated.
• weekly—If supplied, only weekly backups are
replicated.
• monthly—If supplied, only monthly backups are
replicated.
• yearly—If supplied, only yearly backups are replicated.
• none—If supplied, only backups without a specific
replication type are replicated.
If not supplied, all backups, regardless of retention type,
are replicated, subject to other filtering criteria such as
--exclude, --include, and so forth.
This option added in version 4.0.

--throttle=MBPS Controls rate at which the underlying avtar process sends

data to the server.
If --throttle=MBPS is supplied, avtar pauses as long as
necessary after sending each packet to ensure that
network usage does not exceed the specified maximum
bandwidth; maximum bandwidth is specified in mega bits
per second.
For example, --throttle=5 uses half a 10Mbps connection,
--throttle=0.772 restricts usage to one-half of a T1 link.

replicate 383
EMC CONFIDENTIAL
Command Reference

Table 291 Command options for the replicate command (page 4 of 4)

Option Description

--timeout=SEC Specifies a maximum execution time in seconds (SEC) for

this replication session. The replicator process is forcefully
stopped if it has not successfully completed in this amount
of time.
The default timeout setting is 20 hours (72000 seconds).

--version Returns the avtar and replicator software versions.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 292 Avamar-only advanced command options for the replicate command (page 1 of 2)

Option Description

--allsnapups If set false, only the most recent backup for each client is
replicated. The default setting is true.

--avtar=OPTIONS Specifies a list of debugging options to be passed to avtar when it

is invoked to perform the replication.

--bindir=PATH Sets the directory containing Avamar binary files. The default
setting is /usr/local/avamar/bin.

--browse=DOMAIN Returns a list of subdomains and clients within the specified server
DOMAIN.

--compress Enables backup compression.

This option added in version 4.0.

--copysnapups If set false, new accounts are created on the destination server but
no backups are copied. The default setting is true.

--count=MAX-NUM Specifies a maximum number (MAX-NUM) of backups to be

replicated during each replication session.

--diffaccts=LEVEL Specifying --diffaccts=0 disables the optimization, which compares

the accounting database and applies only the differences.

--dontfork Controls whether replicate should recursively process. Specifying

--dontfork disables the --timeout option.

--dstavmaint=OPTIONS Specifies a list of debugging options to be passed to avmaint when

it is invoked to perform operations on the remote (destination)
server.

--dstavmgr=OPTIONS Specifies a list of debugging options to be passed to avmgr when it

is invoked to perform operations on the remote (destination)
server.

--forcecreate Forces all accounts to be created on the destination server even

when other options (for example, (for example, --include, --exclude,
and so forth) are supplied.

384 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 292 Avamar-only advanced command options for the replicate command (page 2 of 2)

Option Description

--globalcid If supplied, global client IDs (CIDs) are used during replications.
Global CIDs are primarily used to facilitate fast failovers from one
server to another following a full “root-to-root” replication. This is
the default setting.

--maxchunksize=BYTES Sets the maximum size of an atomic chunk. The default setting is
61440.
This option added in version 4.0.

--minchunksize=BYTES Sets the minimum size of an atomic chunk. The default setting is
1000.
This option added in version 4.0.

--nochunkconversion If supplied, automatic chunk conversion is not performed.

This option added in version 4.0.

--repldebug Enables debugging mode in replicator.

--rechunk= Controls whether replicated data should be re-chunked to

(disable | enable | maximize data deduplication on the destination server.
default)
One of the following:
• disable—Do not re-chunk data before storing on the destination
server.
• enable—Re-chunk data before storing on the destination server
to maximize data deduplication.
• default—Automatically re-chunk data when source and
destination server chunking parameters are different.
This option added in version 4.0.

--small-client-mb=MB Threshold under which a client's new data is considered “small.”

The default setting is 128 MB of new data. A setting of 0 disables
this optimization.

--srcavmaint=OPTIONS Specifies a list of debugging options to be passed to avmaint when

it is invoked to perform operations on the local (source) server.

--srcavmgr=OPTIONS Specifies a list of debugging options to be passed to avmgr when it

is invoked to perform operations on the local (source) server.

--threshold=NUM Sets the atomic block sticky byte magic number (NUM). The default
setting is 30000.
This option added in version 4.0.

--usesnapuplist If supplied, logic that optimizes normal replications by examining

backup lists is enabled. This is the default setting.

--workdir=PATH Specifies an alternate working directory for replicator temporary

files. The default workdir is /tmp/replicate. This directory is created
if it does not exist.

Notes
To completely replicate the entire contents of a source Avamar server to the destination
server, include --srcpath=/, --dstpath=/, and --fullcopy options. Also ensure that both
--srcpath=/ and --dstpath=/ are set to root (/).

replicate 385
EMC CONFIDENTIAL
Command Reference

Examples
Often, when a large client is backed up to an Avamar server, the next replication session
might run over the allotted time. Rather than permanently modifying replication timing, it
is often easier to just explicitly include that large client on a replication command line and
run it at another time.
The following example replicate shows how explicitly include a client called "spot" as part
of a one-time replication:
nohup replicate --flagfile=/usr/local/avamar/etc/repl_cron.cfg
--include=spot --timeout=0 --throttle=4 >& spot.replout &

Space limitations in this guide cause the previous replicate command to continue to more
than one line. You must enter the command on a single command line without any line
feeds or returns.
The order of the options is important because the --include and --timeout options override
the --exclude and --timeout flags in repl_cron.cfg.
The logging information is written to spot.replout in the current working directory.
This command should be run in the background with nohup so that you can log out of the
system without interrupting this replication job.

386 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

resite
The resite command is an interactive program used to change a single-node Avamar
server’s network configuration (for example, hostname, IP address, parent domain, and so
forth).



Beginning with version 5.0, this command has been deprecated in favor of dpnnetutil.

After running the resite program, you must manually update preferences files for other
applications and features to reflect these changes. Applications and features known to be
impacted by resite include EMS and Avamar Administrator Command Line Interface (CLI).

Synopsis
resite [--config=PATH] [--debug] [--help]
[--ignore_filesystem_requirements] [--ignore_node_type]
[--log=PATH} [--verbose]

Options
The following options are available for the resite command.

Table 293 Command options for the resite command

Option Description

--config=PATH Specifies the PATH to the configuration file.

--debug Shows example session information but does not

perform the specified actions.

--help Shows help, then exits.

--ignore_filesystem_requirements Does not check file system requirements.

--ignore_node_type Does not check the node type.

--log=PATH Specifies the log file PATH.

--verbose Provides maximum information.

Notes
Consider the following notes for the resite command:
◆ The resite command must be run as the operating system root user.
◆ The resite program poses interactive questions as dialog boxes. Because cursor
movement capabilities are required for the interactive questions, you should not run
resite from an Emacs shell buffer.
◆ It is recommended that resite be invoked directly from the console of the Avamar
server, using a directly attached keyboard and monitor.
◆ Although it is possible to invoke resite from an interactive ssh or PuTTY session, be
aware that the session drops when the network configuration changes. In that event,
re-connect to the Avamar server at its new name or IP address.

resite 387
EMC CONFIDENTIAL
Command Reference

◆ Interactive questions are bypassed if --config=PATH is specified and if the specified

configuration file contains all of the required information. PATH should be specified as
an absolute path (starting with a ‘/’).
◆ The following are example configuration file entries:
hostname=avamar-1
dns_domain_name=example.com
eth0_ipv4_address=10.0.254.233
eth0_network_mask=255.255.255.0
default_gateway_address=10.0.254.1
primary_dns_resolver_address=192.168.100.89
secondary_dns_resolver_address=192.168.200.89
smtp_server=mail
storage_server_name=AVAMARSERVER
local_time_zone=United States/Pacific

◆ The resite program creates a default configuration file,

/usr/local/avamar/var/resite.conf, if it does not exist.
◆ Review the following log file after running resite:
/usr/local/avamar/var/resite.log

◆ Expect and ignore the following error messages in the log file:
database "mcdb" already exists (from MCS)
User or account already exists (from EMS)

Scrutinize and address any other error messages that appear.

◆ A progress summary of a resite session can be found in
/usr/local/avamar/var/resiteaux.out.
◆ The resiteaux process is a background process that applies the network configuration
changes.

Examples
The following example shows how to properly use the resite program to change a
single-node Avamar server’s network settings:
1. Gather all the following new site settings:
• New name of the host (for example, avamar-1)
• New parent domain name for the host (for example, example.com)
• New IP address for network interface eth0 (for example, 10.0.5.5)
• New network mask for network interface eth0 (for example, 255.255.255.0)
• New default network gateway address (for example, 10.0.5.1)
• IP address of the primary DNS resolving name server (for example,
192.168.100.89)
• IP address of the secondary DNS resolving name server (for example,
192.168.200.89)
• Name, as defined in corporate DNS, of an email server that accepts outgoing
(SMTP) emails from the Avamar server (for example, mail)

388 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

• Name of the local timezone (for example, U.S./Pacific)

• Hostname of the Avamar storage server (for example, AVAMARSERVER)
2. Open a command shell.
3. Log in to the server as user admin.
4. Load the admin OpenSSH key by typing:
ssh-agent bash
ssh-add ~admin/.ssh/admin_key

You are prompted to type a passphrase.

5. Type the admin user account passphrase and press Enter.



You must force a flush of the MCS database to ensure that any very recent changes to
schedules and other administrative settings are saved. Failure to do so results in loss
of data.

6. Type the following command:

mcserver.sh --flush

7. Switch user to root by typing:

su -

8. When prompted for a password, type the root password and press Enter.
9. Type the following command:
resite

The following information appears in the command shell:

Answer each of the remaining questions with information you collected in step 1 .

resite 389
EMC CONFIDENTIAL
Command Reference

10. Navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

11. Type the new name of the host (for example, avamar-1), then navigate to the OK field
using the cursor keys and press Enter.
The following information appears in the command shell:

12. Type the new parent domain name for the host (for example, example.com), then
navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

390 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

13. Type the new IP address for network interface eth0 (for example, 10.0.5.5), then
navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

14. Type the new network mask for network interface eth0 (for example, 255.255.255.0),
then navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

15. Type the new default network gateway address (for example, 10.0.5.1), then navigate
to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

resite 391
EMC CONFIDENTIAL
Command Reference

16. Type the new IP address of the primary DNS resolving name server (for example,
192.168.100.89), then navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

17. Type the new IP address of the secondary DNS resolving name server (for example,
192.168.200.89), then navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

18. Type the name, as defined in corporate DNS, of an email server that accepts outgoing
(SMTP) emails from the Avamar server (for example, mail), then navigate to the OK
field using the cursor keys and press Enter.
The following information appears in the command shell:

392 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

19. Type the new Avamar storage server name (for example, AVAMARSERVER), then
navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

20. If you are using Network Address Translation (NAT), type the external IP address clients
can use to contact the MCS, then navigate to the OK field using the cursor keys and
press Enter.
Otherwise, leave this field blank, then navigate to the OK field using the cursor keys
and press Enter.
The following information appears in the command shell:

resite 393
EMC CONFIDENTIAL
Command Reference

21. Navigate to the proper timezone using the cursor keys and press Enter; then navigate
to the OK field using the cursor keys and press Enter.
22. Type the name, as defined in corporate DNS, of an email server that accepts outgoing
(SMTP) emails from the Avamar server (for example, mail), then navigate to the OK
field using the cursor keys and press Enter.
The following information appears in the command shell:

23. Review the settings, then navigate to the OK field using the cursor keys and press
Enter.
The following information might appear in the command shell:

394 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

24. Navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

25. Navigate to the OK field using the cursor keys and press Enter.
The following information appears in the command shell:

26. Navigate to the OK field using the cursor keys and press Enter.
After all questions have been answered, resite begins making changes in the
background. The resite process typically takes about 10-20 minutes to complete these
changes. However, on very large systems, resite can take up to two hours to complete
all required changes.

resite 395
EMC CONFIDENTIAL
Command Reference

If you invoked resite from an interactive ssh or PuTTY session, the session drops when
the network configuration changes take affect.
If this occurs, it is usually possible to log back into the server using the new hostname
or IP address even if all resite tasks have not completed. Doing so would enable you to
monitor /usr/local/avamar/var/resite.log to determine when resite has completed.
27. Type the following command:
tail /usr/local/avamar/var/resite.log

28. Ensure that resite has completed without errors before resuming normal server
operation.

396 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

restart.dpn
The restart.dpn command restarts Avamar processes on specified storage nodes in the
Avamar server after the system has been shut down.

Synopsis
restart.dpn [--ascd] [--check] [--checkpointdir=DIR]
[--checkpoints={CP-ID,...}] [--clean] [--copy] [--delay]
[--encrypt=METHOD] [--error] [--expert] [--help] [--hfscheck]
[--hfsdir=PATH] [--ignorerollbacktime] [--ignoresysconfig]
[--indexcacheloadmode=MODE] [--kill] [--lmaddr=HOSTNAME]
[--lmport=PORT] [--mainhost=IP-ADDR] [--nodedb=FILE]
[--nodes=NODE-LIST] [--offlineok] [--ping_only] [--quiet]
[--rollbackdir=DIR] [--runlevel={admin | fullaccess}]
[--savesysinfo] [--scanfile=FILE] [--skipvalidation]
[--sslport=PORT] [--tag=NODE-ID] [--usealtlogdir] [--user=USER-ID]
[--usercheck] [--verbose] [--wait]

Options
The following options are available for the restart.dpn command.

Table 294 Command options for the restart.dpn command (page 1 of 3)

Option Description

--ascd Restarts the ascd process.

--check Runs check.dpn. This is the default setting.

--checkpointdir=DIR Specifies the directory (DIR) where the data is located on each
/data0? mount. The default location is 'cur'.

--checkpoints={CP-ID,...} Specifies one or more checkpoints (CP-IDs) to delete before

restarting the Avamar server.

--clean Calls hfsclean, before restarting the Avamar server.

--copy Copies files to the storage nodes. This is not the default setting.

--delay Supplying --delay introduces a short pause between node

restarts on multi-node servers. --nodelay is the default setting.

--encrypt=METHOD Sets the encryption METHOD. Valid settings are:

• proprietary—No encryption.
• ssl:AES128-SHA—128-bit Advanced Encryption Standard.
• ssl:AES256-SHA—256-bit Advanced Encryption Standard.
• ssl—A special mode in which the program negotiates and
uses the strongest encryption setting that the session can
support.
The default setting is proprietary.

--error Generates error when execution fails.

--expert Allows extra parameters to be passed through to storage nodes.

This is not the default setting.

--help Shows help, then exits.

--hfscheck Performs an HFS check.

--hfsdir=PATH Specifies the root location where the /data0? data mounts are
located on the storage nodes. The default setting is '/'.

restart.dpn 397
EMC CONFIDENTIAL
Command Reference

Table 294 Command options for the restart.dpn command (page 2 of 3)

Option Description

--ignorerollbacktime Allows nodes to start when their rollback times are not the
same.
If supplied, rollback time of the nodes is still checked, but if a
discrepancy is found, the server is allowed to restart with only a
warning written to the gsan.log file.
This option added in version 6.0.

--ignoresysconfig Bypasses node compatibility checks.

This option added in version 6.0.

--indexcacheloadmode=MODE Overrides the indexing caching mode that is automatically

selected by the storage server (GSAN). Allowed values for MODE
are:
• 0—(Default) Allows the GSAN to automatically select the
caching mode.
• 1—Index stripe data is not loaded or cached in memory.
• 2—Index stripe data is not fully loaded, but new index
elements are cached in memory.
• 3—Index-safe stripe data is fully loaded and new index
elements are cached in memory for both index-safe and
parity stripes.
• 4—Both index safe and parity stripe data are fully loaded and
cached in memory.
This parameter added in version 6.0.

--kill Terminates any running Avamar processes before starting. This

is not the default setting.

--lmaddr=HOSTNAME Specifies the login manager host address.

--lmport=PORT Specifies the login manager PORT number.

--mainhost=IP-ADDR Sets the “mainhost” storage node to this IP address (IP-ADDR).

The default setting is IP address of storage node 0.0.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nodes=NODE-LIST Specifies which node(s) to restart. If not supplied, all storage

nodes are restarted.
Requires physical MODULE.NODE designations as defined in
probe.xml.

--offlineok Allows offline stripes. This parameter is passed to wait.dpn.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

--quiet Runs quietly.

--rollbackdir=DIR Specifies which checkpoint directory (DIR) to use for the server
rollback.

--runlevel= Sets the server run level to one of the following:

{admin | fullaccess}
• admin—Administration-only mode (only root and aroot users
can access the server).
• fullaccess—Full access by all users.

--savesysinfo If supplied, special storage server (GSAN) cleanliness tests are

run. This is the default setting.

398 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 294 Command options for the restart.dpn command (page 3 of 3)

Option Description

--scanfile=FILE Specifies the full PATH and filename of the enhanced server log
scanning parameters information file, which is created using the
avmaint logscan command.

--skipvalidation If supplied, server integrity checks are bypassed. This is not the
default setting.

--sslport=PORT Specifies the SSL data PORT. The default setting is 29000.

--tag=NODE-ID Specifies an optional logical NODE-ID.

--usealtlogdir If set, uses the alternative log directory name as defined with
the altlogdir option of the gsan command.

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--usercheck Checks for the “admin” user account.

--verbose Provides maximum information.

--wait Calls wait.dpn, after starting the storage nodes. This is the
default setting.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 295 Avamar-only advanced command options for the restart.dpn command (page 1 of 2)

Option Description

--exedir=PATH Dynamically locates the gsan executable according

to the following rules:
1. If --exedir is supplied, use that gsan executable
without further checking.
2. If the gsan executable exists in the current
working directory, use it.
In this case, check if the gsan executable exists
in /usr/local/avamar/bin also and, if so, print a
warning if ./gsan is older than
/usr/local/avamar/bin/gsan.
3. If the gsan executable exists in
/usr/local/avamar/bin, use it.
4. Otherwise, print a warning and set the exedir to
current working directory (“.”).

restart.dpn 399
EMC CONFIDENTIAL
Command Reference

Table 295 Avamar-only advanced command options for the restart.dpn command (page 2 of 2)

Option Description

--freezelimits="STRING" Specifies the upper limits for processor activity

statistics. The statistics must stay at or below the
specified limits to consider the server to be in an
idle state. STRING must be in the following format
(which is also the default setting):
“busy=3,diskio=40,interrupt=200,switch=1
000”

where:
• The busy statistic refers to the percentage of
time that the CPU is busy (the opposite of being
idle).
• The diskio statistic refers to disk reads or writes
per second.
• The interrupt statistic refers to interrupts per
second.
• The switch statistic refers to context switches per
second.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 296 Deprecated command options for the restart.dpn command (page 1 of 2)

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out
file.

--ramfsoptions=OPTIONS Deprecated in version 5.0.2.

Controls stripes are placed in RAM, where OPTIONS is some
combination of HWUG+XDCP designators, where:
• H—HFS stripes
• W—Persistent store stripes
• U—User accounting stripes
• G—Delete stripes
• X—Index stripes
• C—Composite stripes
• D—Data stripes
• P—Parity stripes
Multiple entries must be separated by commas. The default setting
is H+X,U+XP,G+P.

--useram This option added in version 4.0 and deprecated in version 5.0.2.
If supplied, RAM-resident stripes feature is enabled. This is not the
default setting.

400 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 296 Deprecated command options for the restart.dpn command (page 2 of 2)

Option Description

--useramfs Deprecated in version 4.0.

Specifies whether to use ramfs feature. If specified, ramfs is
initialized and the server informed of its location. The default
location is /ramroot.
The --useramfs option is “sticky”. Once it has been specified, it
continues to be used after restarts or when starting new nodes. To
disable ramfs, you must use supply the --nouseramfs option.

--usestunnel Deprecated in version 6.1.

Specifies that stunnel should be enabled when server is restarted.
This is the default setting.

Notes
Consider the following notes for the restart.dpn command:
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable typically stores the
path to a directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the
default probe.xml location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.
◆ It is usually sufficient to restart the Avamar server simply by running restart.dpn
without any parameters as long as the following conditions are satisfied:
1. A valid probe.xml file is located in /usr/local/avamar/var or in the directory
specified by the SYSPROBEDIR environment variable.
2. You have run ssh-add admin_key or are prepared to directly type the admin
password as the ssh command is programmatically run on each storage node.
3. The dpnutils RPM is installed.
4. The /usr/local/avamar/bin directory is in the path.

resume_crons
The resume_crons command resumes regular execution of any suspended Avamar server
cron script. Currently, only repl_cron is affected.

resume_crons 401
EMC CONFIDENTIAL
Command Reference

rollback.dpn
The rollback.dpn command returns (rolls back) an Avamar server to the last saved state in
a checkpoint.
This command should only be used to roll back to a checkpoint that has passed an HFS
check.
To run rollback.dpn, you must know a valid checkpoint CP-ID to roll back to. To obtain a
valid checkpoint CP-ID, run cplist, then supply the checkpoint tag (found in the first
column of the output) to rollback.dpn.

Synopsis
rollback.dpn --cptag=CP-ID [--check] [--clean] [--copy]
[--ignoresysconfig] [--indexcacheloadmode=MODE] [--nodedb=FILE]
[--parallel] [--restart] [--savesysinfo] [--ssmode=MODE] [--yes]

Options
The following options are available for the rollback.dpn command.

Table 297 Command options for the rollback.dpn command (page 1 of 2)

Option Description

--check Runs check.dpn. This is the default setting.

--clean If supplied, calls hfsclean, before starting Avamar server.

--copy If supplied, files are copied to the storage nodes. This is the
default behavior.

--ignoresysconfig Bypasses node compatibility checks.

This option added in version 6.0.

--indexcacheloadmode=MODE Overrides the indexing caching mode that is automatically

selected by the storage server (GSAN). Allowed values are:
• 0—(Default) Allows the GSAN to automatically select the
caching mode.
• 1—Index stripe data is not loaded or cached in memory.
• 2—Index stripe data is not fully loaded, but new index
elements are cached in memory.
• 3—Index-safe stripe data is fully loaded and new index
elements are cached in memory for both index-safe and
parity stripes.
• 4—Both index safe and parity stripe data are fully loaded and
cached in memory.
This parameter added in version 6.0.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--parallel If --parallel is supplied, server rollback of all nodes in done in

parallel. This is the default behavior.

--restart If --restart is supplied, server is automatically restarted following

the rollback. This is the default behavior.

--savesysinfo If supplied, special storage server (GSAN) cleanliness tests are

run. This is the default setting.

402 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 297 Command options for the rollback.dpn command (page 2 of 2)

Option Description

--ssmode=MODE Allows the storage server (GSAN) to relocate index stripe files
from the solid state drive to the disk drive. Allowed values are:
• 0—Solid state drive is not being used.
• 1—Both index safe stripes and index parity stripes are on the
solid state drive.
• 2—Only index safe stripes are on the solid state drive.
The default setting is 2.
This parameter added in version 6.0.

--yes Does not prompt for confirmation to restart the server if only one
error occurs.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 298 Deprecated command options for the rollback.dpn command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Notes
This program requires a valid probe.xml file to resolve MODULE.NODE designations into
actual IP addresses. The SYSPROBEDIR environment variable typically stores the path to a
directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the default
probe.xml location (/usr/local/avamar/var/) is used. You can also override this location
with the --nodedb=FILE option.

rununtil
The rununtil program is used by other Avamar programs to run a process for a specified
amount of time.
Documentation for this script is provided for reference purposes only. Do not run rununtil
directly from the command line.

rununtil 403
EMC CONFIDENTIAL
Command Reference

sched.sh
The sched.sh script returns a histogram representation of daily server activities. Each day
is separated by a line break and multiple lines are shown for a single day when activities
overlap. The heading columns show the time of day starting from midnight (12am). By
default, each column represents 30 minutes.

Synopsis
sched.sh [--csv | --text] [--days=NUM] [--help][--wide]

Options
The following options are available for the sched.sh script.

Table 299 Command options for the sched.sh script

Option Description

--csv | --text If --csv is supplied, output is formatted as Comma Separated Values (CSV),
which can be easily copied and pasted into a spreadsheet.
If --text is supplied, output omits special formatting characters, which makes
it easier to copy, paste and reuse the information.
If neither option is supplied, output is in the default format, which uses
special formatting characters for enhanced clarity. This is the default.

--days=NUM Limits scope of report to only include the specified number (NUM) of days. The
default setting is 7 days.

--help Shows help, then exits.

--wide Changes time scale to 15 minute increments, resulting in output that is twice
as wide. This is not the default.

Notes
Consider the following notes for the sched.sh script:
◆ Because of the inherent limitations of using text characters to represent a histogram,
some routines may appear to overlap that do not. Individual log files should be
examined to confirm exact times of all operations.
◆ This command added in version 4.1.

404 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Examples
sched.sh

sched.sh 405
EMC CONFIDENTIAL
Command Reference

scn
The scn command is the Avamar secure file copy program. It wraps the OpenSSH scp
program to accept simpler MODULE.NODE designations.
The scn program uses syntax similar to the scp command. The scp command uses
hostnames as part of a source or destination. The scn program uses MODULE.NODE (0.0,
for example) to represent a source or destination instead of a hostname.
Starting with Avamar 5.0, MODULE.NODE designations can specify optional nodes types
when using the --physical option with scn and storage node types when using the --logical
option with scn. Only storage nodes running Avamar can be specified when using the
--logical option.
The scn program copies to or from running nodes. The probe.xml file specifies the running
status of a node by the connected attribute’s setting. True means a node is running and
false means it is not running.

Synopsis
scn [--allow_legacy] [--debug] [--displaymap] [--error] [--expert]
[{--logical| --physical}] [--nodedb=FILE]
[--nodes=MODULE.NODE, ...] [--ping_only] [--probefile=PATH]
[--skipserver] [--user=USER-ID]

Options
The following options are available for the scn command.

Table 300 Command options for the scn command (page 1 of 2)

Option Description

--allow_legacy Supports the use of probe.out if probe.xml cannot be found.

This option added in version 5.0.

--debug Enables debugging messages.

--displaymap Displays a list of node designations and IP addresses currently

assigned to them and exits.
If --logical is specified, logical node designations are used as
primary key.
If --physical is specified, physical node designations in probe.xml
file are used as primary key.
If this program requests this information from the Avamar server
and does not receive a list of current nodes,
/usr/local/avamar/var/nodelist.xml is read as a backup source
of this information.

--error Returns error code on failures.

--expert Toggles expert mode.

--logical | --physical If --logical is supplied, all subsequent node designations are

assumed to be logical.
If --physical is supplied, all subsequent node designations are
assumed to be physical.
The default setting is --physical.

406 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 300 Command options for the scn command (page 2 of 2)

Option Description

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nodes=MODULE.NODE, ... Specifies a comma-separated list of nodes, in MODULE.NODE

format, on which to operate.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

This option added in version 5.0.

--probefile=PATH Specifies the PATH to the directory that contains a legacy

probe.out.
The default setting is /usr/local/avamar/var.
If the directory specified by PATH is not an absolute path, then
the scn program uses either the value of the --probedir option or
the value of the $SYSPROBEDIR environment variable.
For example, typing --probedir=/x and --probefile=probe.out.test
causes the ssn program to look for probe.out.test in /x.
The ssn program uses the legacy probe.out file only if probe.xml
is not found.
This option added in version 5.0.

--skipserver If supplied, this program does not request a current list of nodes.
Instead it parses /usr/local/avamar/var/nodelist.xml for a
current list of nodes.

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 301 Avamar-only advanced command options for the scn command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

--probefile=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.
The default setting is /usr/local/avamar/var.
If the directory specified by PATH is not an absolute path, then the mapall
program uses either the value of the --probedir option or the value of the
$SYSPROBEDIR environment variable.
For example, typing --probedir=/x and --probefile=probe.out.test causes
the mapall program to look for probe.out.test in /x.
The mapall program uses the legacy probe.out file only if probe.xml is not
found.
This option added in version 5.0.

scn 407
EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the scn command:
◆ Before Avamar 5.0, the scn program used probe.out to resolve MODULE.NODE
designations into IP addresses. Beginning with Avamar 5.0, the scn program uses the
probe.xml file to resolve MODULE.NODE designations into actual IP addresses. If the
scn program cannot find the probe.xml file, it attempts to use a legacy probe.out file.
◆ The SYSPROBEDIR environment variable typically stores the path to a directory
containing a valid probe.xml file. If SYSPROBEDIR is not set, the default probe.out
location (/usr/local/avamar/var/) is used. You can also override this location with the
--nodedb=FILE option.
◆ This command reads a default operating system user ID from the SYSPROBEUSER
environment variable. If SYSPROBEUSER is not set, then remote commands are run as
user admin.

Examples
Consider a typical scp command line:
scp [email protected]:/data01/cur/gsan.opt .

The equivalent scn command allows you to use MODULE.NODE syntax as follows:
scn 0.0:/data01/cur/gsan.opt .

408 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

securedelete
The securedelete command is a public interface to avmgr getb and delb commands, which
implement the secure backup deletion feature.

Synopsis
securedelete {delb | getb} [--account={LOCATION | "ref{CID}"}]
[--date=DATE] [--id=USER@AUTH] [--password=PASSWORD]

Commands
Supply one and only one of the following commands on each command line for the
securedelete command.

Table 302 Commands for the securedelete command

Command Description

delb Deletes the backup.

Use --date=DATE to identify a backup.

getb Returns a list of all backups sorted by date, with the latest backup listed first.
Information includes label number, label name, number of bytes that were written
(created), total number of bytes that comprise the backup, number of bytes found to
be already present and not needing to be rewritten and the expiration value (number
of days) where a zero indicates that the backup is to be kept indefinitely.

Options
The following options are available for the securedelete command.

Table 303 Command options for the securedelete command

Option Description

--account= Specifies a hierarchical LOCATION on the Avamar server. This option

{LOCATION| "ref{CID}"} is relative to the current home location, unless a slash (/) is used as
a prefix to the path designation, in which case an absolute path is
assumed.

--date=DATE Backup DATE.

DATE is a numerical value, processed according to the following
rules:
• If DATE is smaller than 1032, it is assumed to be a UNIX
timestamp.
• Otherwise, it is assumed to be equal to the number of 100ns
increments since January 1, 1601.

--id=USER@AUTH Authenticate as this Avamar user ID (account name).

USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication
domain is “avamar.”
For example: jdoe@avamar.

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

Notes
This command added in version 5.0.

securedelete 409
EMC CONFIDENTIAL
Command Reference

Examples
The following command locates a backup, which could then be securely deleted:
securedelete getb --id=USER@AUTH --password=PASSWORD
--account=LOCATION

where USER is the Avamar username, AUTH is the authentication system used by that user
(the default internal authentication domain is “avamar”), PASSWORD is the password for
the --id=USER@AUTH account, and LOCATION is the full location of the client machine.
The following command securely deletes a backup:
securedelete delb --id=USER@AUTH --password=PASSWORD
--account=LOCATION --date=DATE

where USER is the Avamar username, AUTH is the authentication system used by that user
(the default internal authentication domain is “avamar”), PASSWORD is the password for
the --id=USER@AUTH account, LOCATION is the full location of the client machine, and
DATE is the backup date returned in the previous command.

410 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

showperfhistory
The showperfhistory command runs the avmaint perf status command, and then displays
the average disk read performance rates in an easy-to-view format, sorted first by event
sets, then by average read rate.

Synopsis
showperfhistory [--noreset] [--zeroaverages]

Options
The following options are available for the showperfhistory command.

Table 304 Command options for the showperfhistory command

Option Description

--noreset Suppresses display of the avmaint perf reset command, and the leading
comment character.

--zeroaverages Displays statistics even if the average is zero because the count is zero.

Notes
This command added in version 4.1.

Examples
showperfhistory
# | Per Disk | Per Disk and Event Set
# Node Disk | Used Skipped Failed | Days Count Average Event-Bits Events
# 0.1 0 785 39 1 10 243 72.73 0
# 0.0 0 775 49 2 10 243 72.84 0
# 0.0 1 783 41 3 10 243 73.23 0
#
# 0.1 0 785 39 1 10 2 72.88 1 backup
# 0.0 0 775 49 2 10 2 74.03 1 backup
# 0.2 1 771 42 1 10 2 75.15 1 backup
#
# 0.0 2 772 52 2 2 118 4.46 17 backup,hfscheck
# avmaint perf reset 0.0 --disknum=2 --events=17
# 0.2 0 775 38 1 2 197 37.00 17 backup,hfscheck
# 0.0 0 775 49 2 2 118 42.00 17 backup,hfscheck

Note that this example shows an avmaint perf reset command because showperfhistory
detected an abnormally high average read performance value on node 0.0 disk 2.



The showperfhistory command only displays a suggested avmaint perf reset command
when it detects an unusually high or low value compared to other nodes or disks for the
same set of events. It must be understood that this is only a suggested avmaint perf reset
command based on simple heuristics. It is the administrator’s responsibility to determine
if this value should be reset, then issue the command to do so.

showperfhistory 411
EMC CONFIDENTIAL
Command Reference

The following table describes each showperfhistory output column.

Table 305 Output columns for the showperfhistory command

Column Description

Node Logical node number.

Disk A disk on that node.

Per Disk

Used Shows total number of performance monitoring tests run on that disk.

Skipped Shows total number of performance monitoring tests whose results were
discarded because the event set at the start of the test did not match the set at
the end of the test.

Failed Shows total number of performance monitoring tests whose results were out of
tolerance.

Per Disk and Event Set

Days Shows total number of days worth of statistics that have accumulated for a disk
and set of events.

Count Shows total number of tests that have been run over the specified number of
days.

Average Shows the average read performance in MB/sec.

Event-Bits Shows numeric encoding for the set of events listed in the Events column.

Events Describes which events took place.

412 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

shutdown.dpn
The shutdown.dpn command shuts down the Avamar server. It wraps avmaint commands.

Synopsis
shutdown.dpn [--kill] [--nocheckhfs] [--nocheckserver]
[{--now | --nowait}] [--pollinterval=SEC]

Options
The following options are available for the shutdown.dpn command.

Table 306 Command options for the shutdown.dpn command

Option Description

--kill Explicitly terminates all running Avamar server (gsan) processes on all
nodes by issuing the correct Linux killall commands at the correct time
during the server shut down process.

--nocheckhfs Disables the check for currently active HFS check.

--nocheckserver Causes shutdown.dpn to not wait for all Avamar server processes to
gracefully exit before performing the shutdown.

--now | --nowait If --now is supplied, an avmaint shutdown --now command is issued,

which immediately cancels any active client sessions.
If --nowait is supplied, active client sessions are shut down in the
following manner:
1. Run avmaint suspend to lock out new avtar connections to the
Avamar server.
2. Run avmaint sessions to check for active backups.
3. One of the following:
• If active backups found, re-enable dispatcher connections with
avmaint resume and terminate script session.
• If no backups found, run avmaint shutdown.

--pollinterval=SEC Sets the interval in seconds that avmaint sessions is successively

called. The default setting is 6 seconds.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 307 Deprecated command options for the shutdown.dpn command

Option Description

--usestunnel Deprecated in version 6.1.

Specifies that stunnel should be enabled when server is restarted.
This is the default setting.

shutdown.dpn 413
EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the shutdown.dpn command:
◆ Invoking shutdown.dpn with no options performs an avmaint suspend command to
lock out new avtar connections to the Avamar server, then goes into a loop calling
avmaint sessions until there are no more client sessions in progress. At any point
during this loop, you can press Ctrl+C to cancel the shutdown operation. This also
re-enables dispatcher connections with avmaint resume before exiting.
◆ When the number of client sessions goes to 0, the normal avmaint shutdown is run
(which should be quick because there are no more clients to wait for). After the
avmaint shutdown command is run, shutdown.dpn waits for all Avamar server (gsan)
processes to end before it exits.
◆ If an HFS check is running, shutdown.dpn does not shut down the server.

414 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

site_inventory
The site_inventory command collects Avamar server information on a per-node basis.

Notes
Consider the following notes for the site_inventory command:
◆ This command added in version 5.0.
◆ You must run the site_inventory command as root. It also requires the dpnid OpenSSH
key to perform operations as root on a multi-node system.

Examples
The following command collects information from a multi-node Avamar server:
ssh-agent bash
ssh-add ~dpn/.ssh/dpnid
export SYSPROBEUSER=root
site_inventory

The following example is a partial excerpt of site_inventory output:

============================

Total Memory: 4041372 kB

Processor Vendor: GenuineIntel

Processor Model: Intel(R) Xeon(R) CPU 5150 @ 2.66GHz
Total Processors: 2
Processor Speed: 2660 MHz

General Network Information

===========================

Hostname IP: 10.6.251.208

eth0 settings
==============
eth0 IP: 10.6.251.208
eth0 Mac Address: 00:18:8B:4B:0B:A4
eth0 Link Speed: 1000Mb/s
eth0 Link Mode: Full Duplex
Auto-negotiation: on
Link detected: yes

eth1 settings
==============
eth1 IP: 10.6.251.208
eth1 Mac Address: 00:18:8B:4B:0B:A6
eth1 Link Speed: Unknown! (0)
eth1 Link Mode: Half Duplex
Auto-negotiation: on
Link detected: yes

Avamar Information
==================

gsan version: v7.2.0.nnn

mcs version: v7.2.0.nnn
ems version: v7.2.0.nnn

Dell Storage Information

========================

site_inventory 415
EMC CONFIDENTIAL
Command Reference

Storage Controller Settings

===========================
PERC 5/i Integrated (Embedded)
ID : 0
Status : Ok
State : Ready
Firmware Version : 5.2.1-0067
Minimum Required Firmware Version : Not Applicable
Driver Version : 00.00.03.13
Minimum Required Driver Version : Not Applicable
Patrol Read Mode : Disabled
Patrol Read State : Stopped

Physical Disk Settings

======================
ID : 0:0:0
Status : Ok
State : Online
Failure Predicted : No
Type : SAS
Capacity : 278.88 GB (299439751168 bytes)
Used RAID Disk Space : 278.88 GB (299439751168 bytes)
Available RAID Disk Space : 0.00 GB (0 bytes)
Vendor ID : DELL
Product ID : ST3300555SS
Revision : T106
Serial No. : 3LM0A67C
Manufacture Day : 06
Manufacture Week : 51
Manufacture Year : 2013

ID : 0:0:1
Status : Ok
State : Online
Failure Predicted : No
Type : SAS
Capacity : 278.88 GB (299439751168 bytes)
Used RAID Disk Space : 278.88 GB (299439751168 bytes)
Available RAID Disk Space : 0.00 GB (0 bytes)
Vendor ID : DELL
Product ID : ST3300555SS
Revision : T106
Serial No. : 3LM0B4GS
Manufacture Day : 06
Manufacture Week : 51
Manufacture Year : 2013

Virtual Disk Settings

=====================
ID : 0
Status : Ok
State : Ready
Layout : RAID-5
Size : 348.59 GB (374299688960 bytes)
Device Name : /dev/sda
Type : SAS
Read Policy : Adaptive Read Ahead
Write Policy : Write Back

ID : 1
Status : Ok
State : Ready
Layout : RAID-5
Size : 348.59 GB (374299688960 bytes)
Device Name : /dev/sdb

416 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Type : SAS
Read Policy : Adaptive Read Ahead
Write Policy : Write Back

Chassis and Dell Software Information

======================================

Product name : Server Administrator Install Core (subscription)

Version : 5.4.0
Copyright : Copyright (C) Dell Inc. 1995-2013. All rights
reserved.
Company : Dell Inc.

BIOS Information

Manufacturer : Dell Inc.

Version : 1.2.0
Release Date : 10/18/2013

BMC Version : 1.27

Chassis Model : PowerEdge 2950
Chassis Service Tag : 9768BC1
Chassis Asset Tag :

site_inventory 417
EMC CONFIDENTIAL
Command Reference

ssn
The ssn command is the Avamar secure remote shell program. This program wraps the
OpenSSH ssh program to accept simpler MODULE.NODE designations.
Starting with Avamar 5.0, MODULE.NODE designations can specify optional node types
when using the --physical option with ssn. They can also specify storage node types when
using the --logical option with ssn. Only storage nodes running Avamar can be specified
when using the --logical option.
More information about the use of optional nodes is available in probe.xml.
The ssn program applies a command only to nodes that are running. The probe.xml file
specifies the running status of a node by the connected node’s attribute setting. True
means a node is running and false means it is not running.

Synopsis
ssn [--allow_legacy] [--debug] [--displaymap] [--error] [--expert]
[--logical | --physical}] [--n] [--nodedb=FILE]
[--nodes=MODULE.NODE, ...] [--ping_only] [--run] [--skipserver]
[--user=USER-ID]

Options
The following options are available for the ssn command.

Table 308 Command options for the ssn command (page 1 of 2)

Option Description

--allow_legacy Supports the use of probe.out if probe.xml cannot be found.

This option added in version 5.0.

--debug Enables debugging messages.

--displaymap Displays a list of node designations and IP addresses currently

assigned to them and exits.
If --logical is specified, logical node designations are used as
primary key.
If --physical is specified, physical node designations in probe.xml
file are used as primary key.
If this program requests this information from the Avamar server
and does not receive a list of current nodes,
/usr/local/avamar/var/nodelist.xml is read as a backup source
of this information.

--error Returns error code on failures.

--expert Toggles expert mode.

--logical | --physical If --logical is supplied, all subsequent node designations are

assumed to be logical.
If --physical is supplied, all subsequent node designations are
assumed to be physical.

--n Shows example session information but does not perform the
specified actions.

418 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 308 Command options for the ssn command (page 2 of 2)

Option Description

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nodes=MODULE.NODE, ... Specifies a comma-separated list of nodes, in MODULE.NODE

format, on which to operate.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

This option added in version 5.0.

--probefile=PATH Specifies the PATH to the directory that contains a legacy

probe.out.
The default setting is /usr/local/avamar/var.
If the directory specified by PATH is not an absolute path, then
the ssn program uses either the value of the --probedir option or
the value of the $SYSPROBEDIR environment variable.
For example, typing --probedir=/x and --probefile=probe.out.test
causes the ssn program to look for probe.out.test in /x.
The ssn program uses the legacy probe.out file only if probe.xml
is not found.
This option added in version 5.0.

--run Executes all commands.

--skipserver If supplied, this program does not request a current list of nodes.
Instead it parses /usr/local/avamar/var/nodelist.xml for a
current list of nodes.

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--probefile=PATH Specifies the PATH to the directory that contains a legacy

probe.out.
The default setting is /usr/local/avamar/var.
If the directory specified by PATH is not an absolute path, then
the ssn program uses either the value of the --probedir option or
the value of the $SYSPROBEDIR environment variable.
For example, typing --probedir=/x and --probefile=probe.out.test
causes the ssn program to look for probe.out.test in /x.
The ssn program uses the legacy probe.out file only if probe.xml
is not found.
This option added in version 5.0.

--run Executes all commands.

--skipserver If supplied, this program does not request a current list of nodes.
Instead it parses /usr/local/avamar/var/nodelist.xml for a
current list of nodes.

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

ssn 419
EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 309 Deprecated command options for the ssn command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

--probefile=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.
The default setting is /usr/local/avamar/var.
If the directory specified by PATH is not an absolute path, then the mapall
program uses either the value of the --probedir option or the value of the
$SYSPROBEDIR environment variable.
For example, typing --probedir=/x and --probefile=probe.out.test causes
the mapall program to look for probe.out.test in /x.
The mapall program uses the legacy probe.out file only if probe.xml is not
found.

Notes
Consider the following notes for the ssn program:
◆ Before Avamar 5.0, the ssn program used probe.out to resolve MODULE.NODE
designations into IP addresses. Beginning with Avamar 5.0, the ssn program uses the
probe.xml file to resolve MODULE.NODE designations into actual IP addresses. If the
ssn program cannot find the probe.xml file, it attempts to use a legacy probe.out file.
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into IP addresses. The SYSPROBEDIR environment variable typically stores the path to
a directory that contains a valid probe.xml file. If SYSPROBEDIR is not set, the default
probe.xml location (/usr/local/avamar/var/) is used. You can also override this
location with the --nodedb=FILE option.
◆ This command reads a default operating system user ID from the SYSPROBEUSER
environment variable. If SYSPROBEUSER is not set, then remote commands are run as
user admin.

Examples
Consider a typical ssh command line:
ssh [email protected] ’COMMAND’

where COMMAND is the command set to execute on the remote node.

The equivalent ssn command allows you to use MODULE.NODE syntax as follows:
ssn 0.0 ’COMMAND’

420 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

start.dpn
The start.dpn command starts an Avamar server for the first time and initializes all the
storage nodes in the system.
After start.dpn has been run once and the Avamar server has been initialized, start.dpn
should not be run again. To restart a server that has existing data, use restart.dpn.

Synopsis
start.dpn [--catserver] [--check] [--checkpointdir=DIR] [--clean]
[--copy] [--delay] [--diskreadonly=PERCENT] [--diskwarning=PERCENT]
[--encrypt=METHOD][--error] [--exedir=PATH] [--expert] [--hfscheck]
[--hfsdir=PATH] [--ignoresysconfig] [--indexelements=NUM] [--kill]
[--lmaddr=HOSTNAME] [--lmport=PORT] [--mainhost=IP-ADDR]
[--masterdc=NUM] [--matchbits=N] [--maxlogfiles=NUM]
[--maxlogsize=MB] [--maxrwatomdatastripe=SIZE]
[--minstripestowrite=NUM] [--nat] [--nodedb=FILE] [--noinit]
[--norun | --n] [--nousercheck] --password=PASSWORD [{--quiet | -q}]
[--paritygroups=Nx,Fy] [--runlevel={admin | fullaccess}]
[--rwmatchbits=N] [--savesysinfo] [--short] [--sslport=PORT]
[--systemname=NAME] [--tag] --user=USER-ID [--usermatchbits=N]
[--usewritelogheaders] [{--verbose | -v}]

Options
The following options are available for the start.dpn command.

Table 310 Command options for the start.dpn command (page 1 of 5)

Option Description

--catserver Starts this server as a CAT server to perform data

deduplication assessment for prospective customer.

--check Runs check.dpn. This is the default setting.

--checkpointdir=DIR Specifies the directory where the data is on each

/data0? mount. The default setting is 'cur'.

--clean If supplied, calls hfsclean, before starting Avamar

server.

--copy Copies files to the storage nodes. This is the default

setting.

--delay Supplying --delay introduces a short pause between

node starts on multi-node servers. The default setting
is --nodelay.

--diskreadonly=PERCENT Sets the percentage (PERCENT) of full server storage

capacity that triggers conversion of the server from a
fully writable condition to read-only. The default
setting is 65%.

--diskwarning=PERCENT Sets the percentage (PERCENT) of full server storage

capacity that triggers a warning to the server
administrator that the server is becoming full. The
default setting is 50%.

start.dpn 421
EMC CONFIDENTIAL
Command Reference

Table 310 Command options for the start.dpn command (page 2 of 5)

Option Description

--encrypt=METHOD Sets the encryption METHOD. Valid settings are:

• proprietary—No encryption.
• ssl:AES128-SHA—128-bit Advanced Encryption
Standard.
• ssl:AES256-SHA—256-bit Advanced Encryption
Standard.
• ssl—A special mode in which the program
negotiates and uses the strongest encryption
setting that the session can support.
The default setting is proprietary.

--error Generates error when execution fails.

--exedir=PATH Dynamically locates the gsan executable

according to the following rules:
1. If --exedir is supplied, use that gsan executable
without further checking.
2. If the gsan executable exists in the current working
directory, use it.
In this case, check if the gsan executable exists in
/usr/local/avamar/bin also and, if so, print a
warning if ./gsan is older than
/usr/local/avamar/bin/gsan.
3. If the gsan executable exists in
/usr/local/avamar/bin, use it.
4. Otherwise, print a warning and set the exedir to
current working directory (“.”).

--expert Allows extra parameters to be passed through to

storage nodes.

--hfscheck Runs an HFS check.

--hfsdir=PATH Specifies the root location where the /data0? data

mounts are located on the storage nodes. The default
setting is root (/).

--ignoresysconfig Bypasses node compatibility checks.

This option added in version 6.0.

--indexelements=NUM Sets the index stripe size to this number (NUM) of

elements.

--kill Terminates any running Avamar processes before

starting. This is not the default setting.

--lmaddr=HOSTNAME Specifies the login manager host address.

--lmport=PORT Specifies the login manager PORT number.

--mainhost=IP-ADDR Sets the “mainhost” storage node to this IP address

(IP-ADDR). The default setting is IP address of storage
node 0.0.

--masterdc=NUM Sets the master module to N. The default setting is 0.

422 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 310 Command options for the start.dpn command (page 3 of 5)

Option Description

--matchbits=N Sets the initial number of hfs index stripes.

If zero is supplied as a value (N), the system
dynamically computes the initial number of match
bits value according to the following formula:
floor(log2(ndrives)).
Supplying a positive integer as a value (N), sets the
initial number of hfs index stripes to that power of
two. For example, --matchbits=8 sets the initial
number of hfs index stripes to 256.

--maxlogfiles=NUM Sets the maximum number of gsan.log files to retain.

The default setting is 25 MB.
In multi-node servers, this setting applies equally to
all storage nodes on the server (you cannot configure
gsan.log file size on a node-by-node basis).

--maxlogsize=MB Sets the maximum gsan.log file size in MB. The

default setting is 25 MB.
In multi-node servers, this setting applies equally to
all storage nodes on the server (you cannot configure
gsan.log file size on a node-by-node basis).

--maxrwatomdatastripe=SIZE Sets the maximum read-write (rw) atomic data stripe

SIZE to this number of elements.

--minstripestowrite=NUM Sets the minimum number (NUM) of stripes per family

that must be online before writing occurs.

--nat Sets whether the server is using NATing modules.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is
/usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--noinit Does not run initacnt and avmaint init (pre 1.2.1
behavior). The default setting is --init.

--norun | --n Does not actually execute commands. The default

setting is --run.

--nousercheck If supplied, normal verification that start.dpn has

been invoked as user admin is bypassed. The default
setting is --usercheck.

--password=PASSWORD PASSWORD for the --user account.

When used with --init, this must be the Avamar root
user account password.

--quiet | -q Supplying either --quiet or -q causes start.dpn to run

quietly.

start.dpn 423
EMC CONFIDENTIAL
Command Reference

Table 310 Command options for the start.dpn command (page 4 of 5)

Option Description

--paritygroups=Nx,Fy Sets the parity description by specifying the sizes of

near and far parity groups, where Nx is the maximum
size of near parity groups and Fy is the maximum size
of the first far parity group.
Larger parity groups improve storage efficiency at the
expense of reconstruction efficiency. In other words,
large parity groups use disk space more efficiently,
but take more time and more disk seeks to backup or
restore data when a node or module is down.
In multi-node servers, the maximum near parity
setting is always the number of storage nodes in a
module. Far parity groups never grow larger than the
number of modules minus one.
The default setting is N8,F4.

--runlevel={admin | fullaccess} Sets the server run level to one of the following:
• admin—Administration-only mode (only root and
aroot users can access the server).
• fullaccess—Full access by all users.

--rwmatchbits=N Sets the initial number of read-write (rw) index

stripes.
If zero is supplied as a value (N), the system
dynamically computes the initial number of match
bits value according to the following formula:
floor(log2(ndrives/4)).
Supplying a positive integer as a value (N), sets the
initial number of read-write (rw) index stripes to that
power of two. For example, --rwmatchbits=8 sets the
initial number of read-write (rw) index stripes to 256.

--savesysinfo If supplied, special storage server (GSAN) cleanliness

tests are run. This is the default setting.

--short Outputs a very abbreviated report that does not

contain configuration, checkpoint, garbage
collection, or HFS check information.

--sslport=PORT Specifies the SSL data PORT. The default setting is

29000.

--systemname=NAME Sets the initial user-defined descriptive system name

at server startup. NAME can be any combination of
printable characters up to 32 characters in length.

--tag Passes the --nodetag=MODULE.NODE parameter to

storage nodes (default).

--user=USER-ID Specifies an alternative USER-ID. The default user ID

is $ENV{SYSPROBEUSER}).

--usermatchbits=N Sets the initial number of user index stripes.

If zero is supplied as a value (N), the system
dynamically computes the initial number of match
bits value according to the following formula:
floor(log2(ndrives/4))

Supplying a positive integer as a value (N), sets the

initial number of user index stripes to that power of
two. For example, --usermatchbits=8 sets the initial
number of user index stripes to 256.

424 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 310 Command options for the start.dpn command (page 5 of 5)

Option Description

--usewritelogheaders Enables feature that periodically updates server

writelog header to prevent writelog corruption. This is
the default setting.

--verbose | -v Supplying either --verbose or -v provides maximum

information.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. You must include the --expert option to use many of these advanced
command line options.
Misuse of these advanced options can cause loss of data. If you are unsure about any
aspect of these options, contact EMC Customer Support for additional information before
using them.

Table 311 Avamar-only advanced command options for the start.dpn command

Option Description

--chunkhashcheck Enables additional hash validation in datastripe getchunk.

Requires --expert.

--dbtimeout=SEC Sets the debug timeout in seconds (SEC).

Requires --expert.

--dpntimecheck=SEC If set to a positive integer, the server continually verifies that all
nodes report the same time of day, within this number of seconds
(SEC) tolerance. In other words, this is the maximum allowable
difference between any two nodes reported time of day.
Requires --expert.
If set to zero (0), this feature is disabled.

--exitonfatal Completely shuts down any storage node that experiences a fatal
error.
Requires --expert.

--freezelimits="STRING" Specifies the upper limits for processor activity statistics. The
statistics must stay at or below the specified limits to consider the
server to be in an idle state. STRING must be in the following
format (which is also the default setting):
“busy=3,diskio=40,interrupt=200,switch=1000”

where:
• The busy statistic refers to the percentage of time that the CPU
is busy (the opposite of being idle).
• The diskio statistic refers to disk reads or writes per second.
• The interrupt statistic refers to interrupts per second.
• The switch statistic refers to context switches per second.

start.dpn 425
EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 312 Deprecated command options for the start.dpn command (page 1 of 2)

Option Description

--encryptatrest=ENCRYPTIONKEYSALT Deprecated in version 6.1 in favor of the avmaint

atrestencryption command.

--crc Deprecated in version 4.0.

--fillindex Deprecated in version 4.0.

--forcerestart Deprecated in version 4.0.

--fork Deprecated in version 4.0.

--inside Deprecated in version 4.0.

--maxdatastripe Deprecated in version 4.0.

--maxdc Deprecated in version 4.0.

--maxnode Deprecated in version 4.0.

--nodes Deprecated in version 4.0.

--outside Deprecated in version 4.0.

--poolsize Deprecated in version 4.0.

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a
legacy probe.out file.

--profiling Deprecated in version 4.0.

--ramfsoptions=OPTIONS Deprecated in version 5.0.2.

Controls stripes are placed in RAM, where OPTIONS is
some combination of HWUG+XDCP designators,
where:
• H—HFS stripes
• W—Persistent store stripes
• U—User accounting stripes
• G—Delete stripes
• X—Index stripes
• C—Composite stripes
• D—Data stripes
• P—Parity stripes
Multiple entries must be separated by commas. The
default setting is H+X,U+XP,G+P.

--remotestart Deprecated in version 4.0.

--splitcount Deprecated in version 4.0.

--splitspread Deprecated in version 4.0.

--squash Deprecated in version 4.0.

--statnode Deprecated in version 4.0.

426 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 312 Deprecated command options for the start.dpn command (page 2 of 2)

Option Description

--syncwrite Deprecated in version 4.0.

--useram Deprecated in version 5.0.2.

If supplied, RAM-resident stripes feature is enabled.
This is not the default setting.
This option added in version 4.0.

--useramfs Deprecated in version 4.0.

Specifies whether to use ramfs feature. If specified,
ramfs is initialized and the server informed of its
location. The default location is /ramroot.

Note: The --useramfs option is “sticky”. Once it has

been specified, it continues to be used after restarts
or when starting new nodes. To disable ramfs, supply
the --nouseramfs option.

--usestunnel Deprecated in version 6.1.

Specifies that stunnel should be enabled when
server is started. This is the default setting.

Notes
Consider the following notes for the start.dpn command:
◆ If the Avamar username and password are present in the .avamar file, then
--id=USER@AUTH and --password=PASSWORD are not required on the command line.
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable typically stores the
path to a directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the
default probe.xml location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.
◆ It is usually sufficient to restart the Avamar server simply by running start.dpn without
any parameters as long as the following conditions are satisfied:
1. A valid probe.xml file is located in /usr/local/avamar/var or in the directory
specified by the SYSPROBEDIR environment variable.
2. You have run ssh-add admin_key or are prepared to directly type the admin
password as the ssh command is programmatically run on each storage node.
3. The dpnutils RPM is installed.
4. The /usr/local/avamar/bin directory is in the path.

start.dpn 427
EMC CONFIDENTIAL
Command Reference

start.nodes
The start.nodes command starts one or more Avamar server nodes. This should only be
done when adding or replacing nodes in an Avamar server.

Synopsis
start.nodes --nodes=MODULE.NODE[,MODULE.NODE,...]
[--checkpointdir=DIR] [--clean] [--copy] [--error] [--expert]
[--hfsdir=PATH] [--ignoresysconfig] [--kill] [--lmaddr=HOSTNAME]
[--lmport=PORT] [--newdatacenter] [--nodedb=FILE] [--norun]
[--quiet] [--runlevel={admin | fullaccess}] [--tag]
[--usewritelogheaders] [--verbose]

Options
The following options are available for the start.nodes command.

Table 313 Command options for the start.nodes command (page 1 of 2)

Option Description

--nodes=MODULE.NODE You must include the --nodes=MODULE.NODE node descriptor or the

program does not run, where MODULE.NODE is the physical node.
Multiple MODULE.NODE values can be included as a
comma-separated list.

--checkpointdir=DIR Specifies the directory where the data is on each /data0? mount. The
default setting is cur.

--clean If this option is not supplied (default behavior), start.nodes checks

storage nodes for any existing data and ensures that it is not
overwritten (cleaned) during startup.
However, to restart with clean storage nodes (all existing data
removed), supply the --clean option.

--copy Copies files to the storage nodes. This is the default setting.

--error Generates error when execution fails.

--expert Allows extra parameters to be passed through to storage nodes. This

is not the default setting.

--hfsdir=PATH Specifies the root location where the /data0? data mounts are located
on the storage nodes. The default setting is '/'.

--ignoresysconfig Bypasses node compatibility checks.

This option added in version 6.0.

--kill Terminates any running Avamar processes before starting. This is not
the default setting.

--lmaddr=HOSTNAME Specifies the login manager host address.

--lmport=PORT Specifies the login manager PORT number.

--newdatacenter Specifies that this new node is in a new module (datacenter) that is
being created.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--norun Does not actually execute commands.

428 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 313 Command options for the start.nodes command (page 2 of 2)

Option Description

--quiet Runs quietly.

--runlevel= Sets the server run level to one of the following:

{admin | fullaccess}
• admin—Administration-only mode (only root and aroot users can
access the server).
• fullaccess—Full access by all users.

--systemname=NAME Sets the initial user-defined descriptive system name at server

startup. NAME can be any combination of printable characters up to
32 characters in length.

--tag Passes the --nodetag=MODULE.NODE parameter to storage nodes

(default).

--usewritelogheaders Enables a feature that periodically updates the server writelog header
to prevent writelog corruption. This is the default setting.

--verbose Provides maximum information.

Avamar-only options
Avamar-only options access advanced functionality that is normally reserved for use by
EMC personnel only. Misuse of these advanced options can cause loss of data. If you are
unsure about any aspect of these options, contact EMC Customer Support for additional
information before using them.

Table 314 Avamar-only advanced command options for the start.nodes command

Option Description

--exedir=PATH Dynamically locates the gsan executable according to the following

rules:
1. If --exedir is supplied, use that gsan executable without further
checking.
2. If the gsan executable exists in the current working directory,
use it.
In this case, check if the gsan executable exists in
/usr/local/avamar/bin also and, if so, print a warning if ./gsan
is older than /usr/local/avamar/bin/gsan.
3. If the gsan executable exists in /usr/local/avamar/bin, use it.
4. Otherwise, print a warning and set the exedir to the current
working directory (“.”).

--freezelimits="STRING" Specifies the upper limits for processor activity statistics. The
statistics must stay at or below the specified limits to consider the
server to be in an idle state. STRING must be in the following
format (which is also the default setting):
“busy=3,diskio=40,interrupt=200,switch=1000”

where:
• The busy statistic refers to the percentage of time that the CPU
is busy (the opposite of being idle).
• The diskio statistic refers to disk reads or writes per second.
• The interrupt statistic refers to interrupts per second.
• The switch statistic refers to context switches per second.

start.nodes 429
EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 315 Deprecated command options for the start.nodes command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

--ramfsoptions= Deprecated in version 5.0.2.

OPTIONS
Controls stripes are placed in RAM, where OPTIONS is some combination of
HWUG+XDCP designators, where:
• H—HFS stripes
• W—Persistent store stripes
• U—User accounting stripes
• G—Delete stripes
• X—Index stripes
• C—Composite stripes
• D—Data stripes
• P—Parity stripes
Multiple entries must be separated by commas. The default setting is
H+X,U+XP,G+P.

--useramfs Deprecated in version 5.0.2.

Specifies whether to use ramfs feature. If specified, ramfs is initialized and
the server informed of its location. The default location is /ramroot.

Note: The --useramfs option is “sticky”. Once it has been specified, it

continues to be used after restarts or when starting new nodes. To disable
ramfs, supply the --nouseramfs option.

--usestunnel Deprecated in version 6.1.

Specifies that stunnel should be enabled or restarted on the specified
nodes. This is the default setting.

Notes
This program requires a valid probe.xml file to resolve MODULE.NODE designations into
actual IP addresses. The SYSPROBEDIR environment variable typically stores the path to a
directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the default
probe.xml location (/usr/local/avamar/var/) is used. You can also override this location
with the --nodedb=FILE option.

stats.sh
The stats.sh shell script retrieves the following statistics:
◆ List of all client agents installed and number of each type
◆ Total number of bytes protected for all installed clients
The stats.sh shell script is located in the utility node /usr/local/avamar/bin directory and
must be run from that location.

430 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

status.dpn
The status.dpn command continuously returns status of Avamar server nodes. The status
report can be sorted by node ID (default), node IP address, number of dispatchers, load
average, MB used, or percentage full. This program can also accept some avmaint options.
The information provided by status.dpn might differ slightly from similar information
provided by other Avamar administrative tools and utilities. In most cases, these
variations are normal and are caused by the manner in which the information was
retrieved from the system.

Synopsis
status.dpn [INTERVAL] --help --sort=[+ | -][dispatcher | full | ipaddr
| load | node | used] [AVMAINT-OPTIONS]

Options
The following options are available for the status.dpn command.

Table 316 Command options for the status.dpn command

Option Description

INTERVAL Time INTERVAL in seconds between status updates. typing zero (0)
returns a single status report and exits (does not loop).

--sort=[+ | -] Sorts status report by one of the following:

[dispatcher | full |
ipaddr | load | node • dispatcher—Number of dispatchers.
| used] • full—Percentage full.
• ipaddr—Node IP address.
• load—Load average.
• node—Node ID. This is the default setting.
• used—MB used.
You can also control the direction of the sort by including a plus (+) or
minus (-) sign with the --sort option. Normal sorting (alphanumeric,
largest values first, and so forth) is the default; reverse sorting
requires the minus (-) sign.
For example, supplying --sort=+used sorts the status report according
to the MB used on each node (largest values first); supplying
--sort=-node sorts the status report in reverse alphanumeric order
according to the node ID.

--help Shows help, then exits.

AVMAINT-OPTIONS A complete list of options that can be included with this program is
available in “avmaint” on page 73.

Output
The output for status.dpn can include the following status codes.

Table 317 Status codes output by the status.dpn command (page 1 of 2)

Status Description

Online Node is functioning properly.

Offline Node has experienced a problem.

status.dpn 431
EMC CONFIDENTIAL
Command Reference

Table 317 Status codes output by the status.dpn command (page 2 of 2)

Status Description

Ready Transitional state that might or might not be due to normal operation.

Migrating Node is migrating stripes.

Dead Decommissioned.

The full server access mode is typically represented as three four-bit fields. For example:
mhpu+mhpu+0000

The most significant bits show server privileges, the middle bits show root user privileges,
and the least significant bits show privileges for all other users.
The individual bits in these fields convey the following information.

Table 318 Individual bits in full server access mode fields

Bit Description

m Maintenance is allowed.

h HFS is writable.

p Persistent store is writable.

u User accounting is writable.

The following additional information is returned by the status.dpn command.

Table 319 Additional information returned by the status.dpn command

Information Description

Dis Number of dispatchers running on the node. There is one dispatcher for every
command that is currently running.

UsedMB Total amount of node RAM currently being used by all processes.

Errlen Size of the server message log in bytes.

432 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

store-checkpoint
The store-checkpoint command stores selected checkpoints as tar bundles. The
destination Avamar server is only used for temporary storage of the checkpoints; the
checkpoints cannot be used as-is on the destination server. Instead, the checkpoints
must be retrieved by way of pull-checkpoint to use them. The source and destination
server do not have to be configured identically, but the destination server must have at
least as many /data* partitions as the source server.

Synopsis
store-checkpoint [--bump=N] --cp=cp.YYYYMMDDHHMMSS[,...] [--debug]
[--dryrun] --dst=NODE-LIST [--dstkey=FILE] [--gzip] [--help]
--src=NODE-LIST [--srckey=FILE] [--verbose]

Options
The following options are available for the store-checkpoint command.

Table 320 Command options for the store-checkpoint command

Option Description

--bump=N Increments destination partition numbers by N.

--cp=cp.YYYYMMDDHHMMSS[,...] Specifies which checkpoint to store, where

cp.YYYYMMDDHHMMSS is a valid checkpoint ID.
Multiple checkpoints can be specified on the same
command line; separate multiple checkpoint IDs with a
comma.
This option is required.

--debug Shows example session information but does not perform

the specified actions.

--dryrun Runs auxiliary scripts in debug mode.

--dst=NODE-LIST Specifies the destination Avamar nodes (NODE-LIST). This

option is required.

--dstkey=FILE Specifies the path to the destination Avamar server

OpenSSH dpnid key FILE.

--gzip Applies gzip to the tar streams.

--help Shows help, then exits.

--src=NODE-LIST Specifies the source Avamar nodes (NODE-LIST). This option

is required.

--srckey=FILE Specifies the path to the source Avamar server OpenSSH

dpnid key FILE.

--verbose Provides maximum information.

store-checkpoint 433
EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for store-checkpoint command:
◆ You must load the dpnid OpenSSH key before running this command.
◆ This program requires that source and destination Avamar server nodes have similar
data partitioning schemes (for example, both source and destination servers have
/data01 through /data04 partitions).

Examples
Although these examples wrap to more than one line, you must enter all commands and
options on a single command line without any line feeds or returns.
The following example sends specified checkpoints in one tar bundle from source nodes
0.2 through 0.6 to destination nodes 0.0 and 0.1:
store-checkpoint --dst=0.0,0.1 --cp=cp.20130616080300
--cp=cp.20130616080900 --src=0.2,0.3,0.4,0.5,0.6

The following example sends specified checkpoints in one tar bundle to the specified
single-node server, using that server's SSH key:
store-checkpoint --dst=dpe17 --dstkey=$HOME/.ssh/dpe17-dpnid
--cp=cp.20130616080300 --cp=cp.20130616080900 --src=#.#

stunctl


Beginning with version 6.1, stunnel has been deprecated in favor of FIPS 140-2 compliant
encryption. Therefore, the stunctl command should not be used.

The stunctl command controls the stunnel service.

The stunnel service is used to present a new default SSL interface to the Avamar server.
Although stunctl can be used for manual control of the stunnel service, stunctl is primarily
intended for use by other programs that provide control of the Avamar server such as
restart.dpn, shutdown.dpn, start.dpn, and start.nodes.

Synopsis
stunctl [--debug] [--help] [--nodes=DESCRIPTOR] [--sslport=PORT]
[--verbose] {help | restart | start | status | stop}

Options
The following options are available for the stunctl command.

Table 321 Command options for the stunctl command (page 1 of 2)

Option Description

--debug Shows example session information but does not perform the specified
actions.

--help Shows help, then exits. Same as supplying the help command.

434 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 321 Command options for the stunctl command (page 2 of 2)

Option Description

--nodes=DESCRIPTOR Specifies which nodes should be affected by this stunctl action, where
DESCRIPTOR is one or more logical node designations.

--sslport=PORT Specifies the SSL data PORT. The default setting is 29000.

--verbose Provides maximum information.

Commands
Supply one and only one of the following commands on each command line for the stunctl
command.

Table 322 Commands for the stunctl command

Command Description

help Shows help, then exits. Same as supplying the --help option.

restart Stops, then restarts the stunnel service on each node.

start Starts the stunnel service.

status Show the stunnel status.

stop Stops the stunnel service.

Environment variables
The stunctl command uses the following environment variable.

Table 323 Environment variables used by the stunctl command

Environment variable Description

$PATH Executable locations

Examples
The following example stops stunnel services on all nodes, changes the SSL port setting to
29001, then restarts stunnel services on all nodes:
stunctl restart --sslport=29001

stunctl 435
EMC CONFIDENTIAL
Command Reference

suspend_crons
The suspend_crons command suspends activity of any of the Avamar server cron scripts.
Currently, only repl_cron is affected. The execution of suspended scripts can be continued
with the resume_crons script.

Synopsis
suspend_crons [--autoonly]

Options
The following option is available for the suspend_crons command.

Table 324 Command options for the suspend_crons command

Option Description

--autoonly If supplied, automatic running of Avamar server cron scripts from dpn_crontab is
disabled.
If not supplied (default behavior), all invocations of Avamar server cron scripts is
completely disabled.

Notes
The --autoonly state is only checked by cron_env_wrapper, and not the individual cron
scripts. Therefore, disabling Avamar server cron scripts with --autoonly does not impact
the ability to manually run Avamar server cron scripts.

436 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

swraidctl
The swraidctl command returns server software RAID status.

Synopsis
swraidctl {help | status} [--debug] [--help] [--verbose]

Commands
Supply one and only one of the following commands on each swraidctl command line.

Table 325 Commands for the swraidctl command

Command Description

help Shows help, then exits. Same as --help.

status Shows server software RAID status.

Options
The following options are available for the swraidctl command.

Table 326 Command options for swraidctl command

Option Description

--debug Shows example session information but does not perform the specified actions.

--help Shows help, then exits.

--verbose Provides maximum information.

swraidctl 437
EMC CONFIDENTIAL
Command Reference

timedist
The timedist command distributes NTP configuration files to nodes in the Avamar server.
This command must be run as user dpn. This program attempts to load the dpnid
OpenSSH key from the dpn user .ssh directory. This command fails if it is run as a different
user.
Documentation for this script is provided for reference purposes only. The timedist
program is typically invoked programmatically by asktime, and should not be run directly
from the command line.

Synopsis
timedist [--configdir=DIR] [--debug] [--domall] [--has_utility_node]
[--help] [--noactivate] [--nodedb=FILE] [--nodes=NODE-LIST]
[--nozone] [--set=DATE-TIME] [--verbose]

Options
The following options are available for the timedist command.

Table 327 Command options for the timedist command

Option Description

--configdir=DIR Specifies the directory (DIR) containing time configuration files created
by mktime. The default location is
/usr/local/avamar/var/time-config-files.

--debug Shows example session information but does not perform the specified
actions.

--domall Configures all utility nodes. Otherwise, utility nodes other than 0.m are
skipped.

--has_utility_node Processes a combined 0.s/0.m node.

--help Shows help, then exits.

--noactivate Does not restart ntpd.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--nodes=NODE-LIST Specifies which nodes to configure. If not supplied, all nodes are
configured.
Requires physical MODULE.NODE designations as defined in probe.xml
file.

--nozone Does not change the timezone symbolic link.

--set=DATE-TIME Sets the initial date and time (DATE-TIME) value for /bin/date --set.

--verbose Provides maximum information.

438 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 328 Deprecated command options for the timedist command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Notes
This program requires a valid probe.xml file to resolve MODULE.NODE designations into
actual IP addresses. The SYSPROBEDIR environment variable typically stores the path to a
directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the default
probe.xml location (/usr/local/avamar/var/) is used. You can also override this location
with the --nodedb=FILE option.

Files
Files used by the timedist command include:
◆ ${configdir}/time-config-files/mktime.out
◆ ${configdir}/time-config-files/ntp.conf*
◆ ${configdir}/time-config-files/step-tickers*
where ${configdir} is one of the following, in order of decreasing precedence:
1. Specified by --configdir=DIR
2. ${SYSPROBEDIR}/time-config-files
3. /usr/local/avamar/var/time-config-files
A complete set of time configuration files must exist, as created by a previous invocation
of the custom version of mktime.
Files modified on Avamar nodes by the timedist command include:
◆ /etc/ntp.conf
◆ /etc/ntp/step-tickers
◆ /etc/localtime
◆ /etc/sysconfig/clock
This application automatically rotates its log file whenever it is run and when the log file
exceeds 1 MB in size. Up to eight log files are retained.

timedist 439
EMC CONFIDENTIAL
Command Reference

Troubleshooting
The following table describes how to recover from common problems encountered when
running timedist.

Table 329 Troubleshooting information for the timedist command

Error or symptom Description or remedy

timedist: unrecognized command-line You are using an obsolete version of timedist.

option “-configdir” - for help use -help. Upgrade to latest version.
You can also set SYSPROBEDIR, rerun probe, rerun
asktime, rerun mktime.custom if asked, and then
rerun timedist as follows:
mkdir -p /home/dpn/var
export SYSPROBEDIR=/home/dpn/var
probe AVAMARSERVER
asktime/home/dpn/var/mktime.custom
timedist

where AVAMARSERVER is the Avamar server

hostname as defined in corporate DNS.

timedist: See the previous troubleshooting entry.

/usr/local/avamar/var/time-config-files
must exist and be a directory writable by
you.

When running timedist, you see any Ensure that you correctly set the dpnid OpenSSH key
prompt for root@NODE's password. before running this program.
Also verify that all nodes have the correct authorized
keys (especially verify that any new nodes added to
the system have the correct keys).

timerange
The timerange command uploads selected portions of the storage node gsan.log files by
specifying a range of data/time values. It gets copied to each storage node by start.dpn.
Documentation for this script is provided for reference purposes only. Do not run
timerange directly from the command line.

440 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

timesyncmon
The timesyncmon command starts ntpd and ensures that it continues running.
Documentation for this script is provided for reference purposes only. The timesyncmon
program is typically invoked by timedist, or the ntpd_keepalive cron job and should not be
run directly from the command line.

Synopsis
timesyncmon {--install | --keep_alive | --shutdown}

[--activate] [--allow_ntpd_restart] [--archive_file=FILE.tgz]

[--debug] [--help] [--local_timezone=TIMEZONE]
[--no_timezone_change] [--node_type=TYPE] [--quiet]
[--set=DATE_TIME] [--shutdown] [--verbose]

Commands
Commands control which operational mode (install, keep alive, or shutdown) is used.
Supply one and only one of the following commands on each command line for the
timesyncmon command.

Table 330 Commands for the timesyncmon command

Command Description

--install Runs in install mode.

--keep_alive Runs in keep-alive mode (restarts ntpd if needed).

--shutdown Runs in shutdown mode (stops ntpd).

Options
The following options are available for the timesyncmon command.

Table 331 Command options for the timesyncmon command (page 1 of 2)

Option Description

--activate Enables and activates ntpd.

--allow_ntpd_restart Allows ntpd to be restarted if ntpd exits.

--archive_file=FILE.tgz Specifies the name of the tarball containing configuration files.

--debug Shows example session information but does not perform the
specified actions.

--help Shows help, then exits.

--local_timezone=TIMEZONE Specifies the local TIMEZONE (for example, U.S./Pacific).

--no_timezone_change Does not update timezone-related configuration files.

--node_type=TYPE Used with --local_timezone to specify node TYPE (for example, s

indicates utility node).

--quiet Runs quietly (logging only).

timesyncmon 441
EMC CONFIDENTIAL
Command Reference

Table 331 Command options for the timesyncmon command (page 2 of 2)

Option Description

--set=DATE_TIME Specifies the initial system time.

--verbose Provides maximum information.

Notes
This program runs in one of three modes.

Table 332 Modes for the timesyncmon command

Mode Command Description

Install --install This mode stops ntpd, installs time configuration files, sets the
system time, starts ntpd, restarts selected processes (the ones that
keep their own times), and monitors essential processes to ensure
that ntpd continues to run.

Shutdown --shutdown This mode terminates a previously running instance of

timesyncmon and stops ntpd in preparation for installing or
reinstalling time configuration files and restarting ntpd.

Keep-alive --keep_alive This mode verifies whether ntpd is running, attempts to restart ntpd
if it is not running, and monitors essential processes to ensure that
ntpd continues to run.

This application automatically rotates its log file whenever it is run and when the log file
exceeds 1 MB in size. In install and shutdown modes, up to eight log files are retained. In
keep-alive mode, up to 24 log files are retained.

Files
The following log files are of interest on the utility node or single-node servers:
◆ /usr/local/avamar/var/timesyncmon.log
◆ /usr/local/avamar/var/cron/ntpd_keepalive_cron.log
The following log files are of interest on the storage nodes in multi-node servers;
◆ /usr/local/avamar/var/timesyncmon.log
◆ /usr/local/avamar/var/ntpd_keepalive_cron.log

442 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

tomcatctl
The tomcatctl command controls the Apache Tomcat service. The Tomcat service is
installed along with the EMS.
Although the tomcatctl command is typically invoked by dpnctl, it can be run directly from
the command line.

Synopsis
tomcatctl [--debug] [--help] [--java_home=PATH] [--verbose] COMMAND

Options
The following options are available for the tomcatctl command.

Table 333 Command options for the tomcatctl command

Option Description

--debug Shows example session information but does not perform the specified
actions.

--help Shows help, then exits. Same as supplying the help command.

--java_home=PATH Specifies $JAVA_HOME for final execution environment.

--verbose Provides maximum information.

Commands
Supply one and only one of the following commands on each command line for the
tomcatctl command.

Table 334 Commands for the tomcatctl command

Command Description

help Shows help, then exits. Same as supplying the --help option.

start Starts Tomcat service.

status Shows Tomcat service status.

stop Stops Tomcat service.

Environment variables
The tomcatctl command uses the following environment variables.

Table 335 Environment variables used by the tomcatctl command

Environment variable Description

$JAVA_HOME Java directory (for MCS-related operations)

$PATH Executable locations

tomcatctl 443
EMC CONFIDENTIAL
Command Reference

Notes
Consider the following notes for the tomcatctl command:
◆ The tomcatctl program automatically loads all required OpenSSH keys.
◆ If multiple versions of Apache Tomcat are installed, then tomcatctl operates on the
highest version number.

444 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

transfer-key
The transfer-key command copies existing admin and dpn SSH keys to another node.

Synopsis
transfer-key [--debug] [--help] --node=IP-ADDR [--verbose]

Options
The following options are available for the transfer-key command.

Table 336 Command options for transfer-key command

Option Description

--debug Shows example session information but does not perform the specified
actions.

--help Shows help, then exits.

--node=IP-ADDR Specifies where the SSH keys will be copied, where IP-ADDR is target node’s IP
address.

--verbose Provides maximum information.

truncate
The truncate command truncates the contents of a file. The hfscheck_kill program, invokes
truncate to cause the system to re-initiate an HFS check on a checkpoint that has failed a
previous HFS check attempt. This program is copied to each storage node by start.dpn.
Documentation for this script is provided for reference purposes only. Do not run truncate
directly from the command line.

transfer-key 445
EMC CONFIDENTIAL
Command Reference

ugcheck
The ugcheck command checks each node for upgrade-readiness. It checks each storage
node that is listed in the probe.xml file to verify the following upgrade requirements:
◆ CPU is 64-bit-capable.
◆ Maintenance partitions /bootalt, /rootalt, and /varalt are included in /etc/fstab.
◆ Adequate disk space exists on the maintenance partitions.
◆ Sufficient free space exists on the /data01 partition to accommodate the RHEL4.6
operating system image tarballs.
By default, probe.xml file is located in /usr/local/avamar/var/probe.xml. To select an
alternate directory that contains an augmented probe.xml file, set the environment
variable SYSPROPEDIR.
Starting with Avamar 4.1, the ugcheck program runs as a subprogram of avupos. You can
also run ugcheck from the command line for a manual OS upgrade.
The ugcheck program exits with a status of 0 if all nodes meet the requirements,
otherwise, ugcheck exits with a non-zero status.

Synopsis
ugcheck [--help]

Options
The following option is available for the ugcheck command.

Table 337 Command options for the ugcheck command

Option Description

--help Print a help message and exit

446 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

ugcopy
The ugcopy command distributes dpnugprep packages and files from the /data01/ugprep
directory to all storage nodes. You run ugcopy from the utility node. By default, ugcopy
does the following:
◆ Extracts the dpnugprep package from the latest customer tarball located in the
/usr/local/avamar/src/ directory.
◆ Uses the /usr/local/avamar/var/probe.out file to identify each storage node. Then
copies the dpnugprep package to the /usr/local/avamar/src/ directory on each
storage node.
By default, probe.out is located in /usr/local/avamar/var. To select an alternate
directory that contains an augmented probe.out file, set the environment variable
SYSPROPEDIR.
◆ Creates a /data01/ugprep directory on each storage node listed in the probe.out file,
then distributes the contents of the /data01/ugprep directory to the /data01/ugprep
directory on each storage node.

Synopsis
ugcopy [--copy_only] [--help] [--src=DIRECTORY] [--unpack]

Options
The following options are available for the ugcopy command.

Table 338 Command options for the ugcopy command

Option Description

--copy_only Copies files from the source directory.

The default setting is --nocopy_only. Does not extract the dpnugprep
package, and does not checksum tarballs.
The use of --copy_only implies --nounpack.

--help Shows a help message and exit.

--src=DIRECTORY Uses DIRECTORY as the source of operating system image tarballs instead of
/data01/ugprep.

--unpack Does not extract the dpnugprep package.

The default setting is --unpack.

Notes
The dpnugprep RPM package includes ugcopy as part of the ugprep program. To extract
the ugcopy program from the dpnugprep package, type the following:
rpm2cpio dpnugprep-VERSION.i386.rpm | cpio -idv
./usr/local/avamar/bin/ugcopy

ugcopy 447
EMC CONFIDENTIAL
Command Reference

ugprep
The ugprep command upgrades Avamar nodes from Red Hat Enterprise Linux 3 (update 3,
5, or 8) to Red Hat Enterprise Linux 4 (update 6). You run ugprep from the root user on
each node. This program completes the following high-level steps:
1. Creates new ext3 filesystems on pre-existing maintenance partitions (/bootalt,
/rootalt, and /varalt).
2. Installs the new operating system image for Red Hat Enterprise Linux 4 on the
maintenance partition.
3. Migrates a select set of configuration files from the old operating system partitions to
the new partitions.
4. Updates the boot loader configuration to boot, by default, on the new operating
system image.

Synopsis
ugprep [--auto] [--help] [--nocheck] [--os_src=PATH] [--verbose]

Options
The following options are available for the ugprep command.

Table 339 Command options for the ugprep command

Option Description

--auto Runs the OS upgrade without interactive prompts.

--help Shows a help message, and then exits.

--nocheck Skips the following:

• Bad blocks when creating filesystems
• Environment checks
• Initial mount of /rootalt that is used to check existing operating system

--os_src=PATH Specifies the location of the OS image tarball when it is located in a directory
other than /data01/ugprep/.

--verbose Provides maximum information.

Notes
Consider the following notes for the ugprep command:
◆ The ugprep program automatically removes /rootalt/data* mount points for which
there are no corresponding entries in /etc/fstab. This helps avoid problems for tools
that might expect all /data* mounts to be active mount points. The ugprep program
does not remove a mount point for /data01. If /etc/fstab does not contain a mount
point for /data01, ugprep returns an error.
◆ The ugprep program writes status to the /var/log/ugprep.log file. The contents of
ugprep.log are then copied to /var/log/upgrade.log for each node after ugprep
finishes processing.

448 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Files migrated or updated by ugprep

After the new operating system is installed on the maintenance partitions (/bootalt,
/rootalt, and /varalt), ugprep migrates or updates the following files on the maintenance
partitions.

Table 340 Maintenance partition files migrated or updated by the ugprep command

File Description

/bootalt/grub/grub.conf GRUB configuration file.

/rootalt/etc/fstab New fstab file formed from the /etc/fstab file

in which:
• The partitions /bootalt, /rootalt, and /varalt
serve the same purpose as /boot, /(root)
and /var.
• The ext3 partition labels remain the same.
LABEL entries in the new fstab file,
therefore, appear as LABEL=/rootalt and
are mounted on /.

/rootalt/root Copy of /root, which is the home directory for

the operating system root user.

/rootalt/home Copy of /home, which is normally a symbolic

link.

/rootalt/etc/hosts Copy of /etc/hosts.

/rootalt/etc/resolv.conf Copy of /etc/resolv.conf.

/rootalt/etc/nsswitch.conf Copy of /etc/nsswitch.conf.

/rootalt/etc/yp.conf Copy of /etc/yp.conf, the ypbind configuration

file.

/rootalt/etc/ldap.conf Merged copy of /etc/ldap.conf, the

Lightweight Directory Access Protocol (LDAP)
service configuration file.

/rootalt/etc/sysconfig/network Copy of /etc/sysconfig/network.

/rootalt/etc/sysconfig/network-scripts/ifcfg-eth* Copies of
/etc/sysconfig/network-scripts/ifcfg-eth*,
network interface configuration files.

/rootalt/etc/ssh/ssh_host_*_key Copies of host keys used by Secure Shell

Daemon (SSHD).
If host keys are not migrated from Red Hat
Enterprise Linux 3 to Red Hat Enterprise Linux
4, host keys must be manually generated after
each node is booted to Red Hat Enterprise
Linux 4.

ugprep 449
EMC CONFIDENTIAL
Command Reference

The ugprep program migrates or updates the following Avamar storage server files.

Table 341 Storage server files migrated or updated by the ugprep command

File Description

/rootalt/etc/pam.d/lm_* Copy of /etc/pam.d/lm_*.

/rootalt/usr/local/avamar/etc/* Copy of the contents of the /usr/local/avamar/etc/

directory, excluding node.cfg.
Files in this directory include:
• avamar.cfg
• cert.pem
• domains.cfg
• dpn_crontab
• groups.txt
• install_rpm_list
• key.pem
• license.xml
• master_rpm_list
• serverlogscanners.xml
• usersettings.cfg
• users.txt

/rootalt/usr/local/avamar/etc/node.cfg Node type setting taken from

/usr/local/avamar/etc/node.cfg.

The ugprep program migrates or updates the following MCS files.

Table 342 MCS files migrated or updated by the ugprep command

File Description

/rootalt/usr/local/avamar/etc/* Copy of the contents of the /usr/local/avamar/etc/

directory, excluding node.cfg.
Examples of files in this directory relevant to MCS include
dpn_crontab.

/rootalt/etc/snmp/snmpd.conf.RHEL3 Unmodified copy of the /etc/snmp/snmpd.conf file.

There are no EMS files migrated by ugprep.

The ugprep program migrates or updates following files that are related to NTP.

Table 343 NTP files migrated or updated by the ugprep command (page 1 of 2)

File Description

/rootalt/etc/MAINT/cron/* Copy of /etc/MAINT/cron/*, which contains Avamar

cron jobs specifically related to ntpd_keepalive.

/rootalt/etc/cron.d/ntpd_keepalive Copy of the ntpd_keepalive cron job currently

installed.

/rootalt/etc/ntp.conf Copy of the /etc/ntp.conf file if the file is an Avamar

configuration file—the notrust tokens have been
removed from the restrict statements.

/rootalt/etc/ntp/step-tickers Copy of /etc/ntp/step-tickers, which is used by

ntpdate in ntpd startup.

/rootalt/etc/sysconfig/clock Modified copy of /etc/sysconfig/clock.

450 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

Table 343 NTP files migrated or updated by the ugprep command (page 2 of 2)

File Description

/rootalt/etc/localtime File updated by using the ZONE setting in

/etc/sysconfig/clock.

/rootalt/etc/httpd/conf/ssl.crt/server.crt Apache web server SSL certificate file.

/rootalt/etc/httpd/conf/ssl.key/server.key Apache web server key file.

Files not migrated or updated by ugprep

The ugprep program does not migrate or update following files.

Table 344 Files not migrated or updated by the ugprep command

File Description

/backup_changenodetype.tar Archive of selected operating system configuration files, which

support the change_nodetype script.
This file is created as part of the operating system image tarball
for the root partition.

/backup_dpe_configs.tar Archive of selected Avamar configuration files (single-node

servers only), which support the deprecated create_newconfigs
program.

/backup_utility_configs.tar Archive of selected operating system files (utility nodes only),

which support the deprecated create_newconfigs program.

/etc/madm.conf Software RAID configuration file.

Avamar servers should not run RAID software.

/etc/modules.conf Configuration of loadable kernel modules, such as device drivers.

/etc/raidtab Software RAID configuration file.

Avamar servers should not run RAID software.

/etc/syslog.conf The syslogd configuration file.

/etc/named.conf DNS name server configuration file.

Avamar servers no longer run DNS name servers.

/etc/3dmd.conf 3ware RAID monitoring service configuration file.

/etc/MAINT/dhcpd/* Avamar DHCP configuration files.

DHCP is deprecated on all Avamar servers

/etc/MAINT/named/* Avamar DNS name server (named) configuration files.

Avamar servers no longer run DNS name servers.

/etc/dhcpd.conf DHCP (dhcpd) server configuration file.

DHCP is deprecated on all Avamar servers.

/var/named/* DHCP (dhcpd) server configuration file.

DHCP is deprecated on all Avamar servers.

The ugprep program does not update Avamar application files on non-system partitions,
such as those in the /data01 partition. The following directories are not updated:
◆ /usr/local/avamar/doc/
◆ /usr/local/avamar/src/
◆ /usr/local/avamar/var/

ugprep 451
EMC CONFIDENTIAL
Command Reference

The following directories, which contain Avamar application files, remain on the root (/)
partition of the old operating system:
◆ /usr/local/avamar/bin/
◆ /usr/local/avamar/httpd/
◆ /usr/local/avamar/httpds/
◆ /usr/local/avamar/install/
◆ /usr/local/avamar/lib/
◆ /usr/local/avamar/man/

Boot menu changes

The ugprep program installs GRUB as the boot manager and also installs a new GRUB
configuration file, /boot/grub/grub.conf. The following table provides information about
boot labels in the grub.conf file.

Table 345 Boot labels in grub.conf

Position Label Description

0 operating The default boot label.

Boots the RHEL4.6 operating system by using an SMP kernel (assuming
that an SMP kernel is available for the hardware platform).

1 operating-up Alternate boot label.

Boots the RHEL4.6 operating system by using a uniprocessor kernel.

2 failsafe Alternate boot label.

Boots a copy of the default RHEL4.6 SMP kernel.
If using the default operating boot option fails because of a problem
such as storage corruption in the /boot partition, this same type of
problem might prevent you from using the failsafe boot option.

3 maintenance Alternate boot label.

Boots the operating system installed on the maintenance partitions,
typically the previous operating system, RHEL3 (update 3, 5 or 8).
Use this boot option to run Avamar under the old operating system.

452 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

wait.crunch
The wait.crunch command waits for the specified type and amount of asynchronous stripe
crunching to complete.

Synopsis
wait.crunch [--accounting] [--atomic] [--composite] [--help] [--hfs]
[--hfsport=PORT] [--id=USER@AUTH] [--multiday] [--nodedb=FILE]
[--password=PASSWORD] [--persistent] [--q | --quiet]
[--resetandrollover] [--rollover] [--server=AVAMARSERVER]
[--timeout=MIN] [--v | --verbose]

Options
The following options are available for the wait.crunch command.

Table 346 Command options for the wait.crunch command (page 1 of 2)

Option Description

--accounting If supplied, wait applies to accounting stripes. This is not the default
setting.

--atomic If supplied, wait applies to atomic data stripes. This is the default
setting.

--composite If supplied, wait applies to composite data stripes. This is not the
default setting.

--help Shows help, then exits.

--hfs If supplied, wait applies to HFS stripes. This is the default setting.

--hfsport=PORT Specifies the Avamar server data PORT.

--id=USER@AUTH Authenticate on the source Avamar server as this Avamar user ID

(account name).
USER is the Avamar username, and AUTH is the authentication
system used by that user. The default internal authentication domain
is “avamar.”
For example: jdoe@avamar.

--multiday If supplied, continue to wait after a rollover. This is not the default
setting.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.

--password=PASSWORD PASSWORD for the --id=USER@AUTH account.

--persistent If supplied, wait applies to persistent store stripes. This is not the
default setting.

--q | --quiet Runs quietly (logging only).

--resetandrollover If supplied, issue the avmaint crunch resetandrollover command

before waiting.

--rollover If supplied, issue the avmaint crunch rollover before waiting.

--server=AVAMARSERVER AVAMARSERVER IP address or fully qualified hostname (as defined in

DNS).

wait.crunch 453
EMC CONFIDENTIAL
Command Reference

Table 346 Command options for the wait.crunch command (page 2 of 2)

Option Description

--timeout=MIN Specifies the maximum number of minutes (MIN) wait.crunch is

allowed to run after crunching progress has stopped.
A setting of zero (0) specifies that wait.crunch can run forever (no
timeout). Zero is the default setting.

--v | --verbose Provides maximum information. This is the default setting.

Deprecated options
Beginning with the noted release, use of these options is officially discouraged. Support
for these options might be discontinued entirely at any time.

Table 347 Deprecated command options for the wait.crunch command

Option Description

--probedir=PATH Deprecated in version 5.0.

Specifies the PATH to the directory that contains a legacy probe.out file.

Notes
Consider the following notes for the wait.crunch command:
◆ This command added in version 4.0.
◆ If the Avamar username and password are present in the .avamar file then
--id=USER@AUTH and --password=PASSWORD are not required on the command line.
◆ This program requires a valid probe.xml file to resolve MODULE.NODE designations
into actual IP addresses. The SYSPROBEDIR environment variable typically stores the
path to a directory containing a valid probe.xml file. If SYSPROBEDIR is not set, the
default probe.xml location (/usr/local/avamar/var/) is used. You can also override
this location with the --nodedb=FILE option.

454 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

wait.dpn
The wait.dpn command waits for all the stripes to go online. It can be run on its own and it
is also used by restart.dpn.

Synopsis
wait.dpn [--ap=PASSWORD] [--error] [--help] [--hfsaddr=AVAMARSERVER]
[--hfsport=PORT] [--n] [--nodedb=FILE] [--nodes=NODELIST]
[--ping_only] [--q | --quiet] [--run]
[--runlevel= {admin | fullaccess}] [--timeout=MIN] [--user=USER-ID]
[--v | --verbose]

Options
The following options are available for the wait.dpn command.

Table 348 Command options for the wait.dpn command

Option Description

--ap=PASSWORD Specifies the PASSWORD for --user account.

--error Generates error when execution fails.

--help Shows help, then exits.

--hfsaddr=AVAMARSERVER Specifies the AVAMARSERVER IP address or fully qualified

hostname (as defined in DNS).

--hfsport=PORT Sets the Avamar server PORT number. The default setting is 27000.

--n Lists but does not execute commands.

--nodedb=FILE Specifies the full path to a valid probe.xml file.

The default setting is /usr/local/avamar/var/probe.xml.

--nodes=NODELIST Specifies one or more nodes by using MODULE.NODE notation.

Multiple entries require commas.

--ping_only Only perform ICMP ping. The default timeout is 25 seconds.

--q | --quiet Runs quietly (logging only).

--run Executes all commands (opposite of --n).

--runlevel= Sets the server run level to one of the following:

{admin | fullaccess}
• admin—Administration-only mode (only root and aroot users can
access the server).
• fullaccess—Full access by all users.

--timeout=MIN Specifies the timeout in minutes (MIN). The default setting is 60

minutes.

--user=USER-ID Specifies an alternative USER-ID. The default user ID is

$ENV{SYSPROBEUSER}).

--v | --verbose Provides maximum information.

wait.dpn 455
EMC CONFIDENTIAL
Command Reference

website
The website command performs operations on the Avamar integrated web server, which
provides the Avamar Web Access services.

Synopsis
website {create-cfg | init | restart | start | status | stop | version}

Commands
Supply one and only one of the following commands on each command line for the
website command.

Table 349 Commands for the website command

Command Description

create-cfg Creates /usr/local/avamar/etc/avamar.cfg file used by the Avamar Web Access

service.

init Stops the web server if it is running and then performs some initialization.

restart Stops and then starts the web server.

start Starts the web server if it is currently stopped.

status Gets the status of the web server.

stop Stops the web server if it is currently running.

version Returns version of this script.

Configuring and restarting Avamar web access services

This procedure describes how to configure and restart Avamar Web Access services. This
is typically done as part of server software upgrades on existing Avamar servers, but can
be performed at any time without harming the system.
1. Open a command shell and log in using one of the following methods:
• To log in to a single-node server, log in to the server as admin.
• To log in to a multi-node server, log in to the utility node as admin.
2. Switch user to root by typing:
su -

3. Configure web services settings by typing:

website create-cfg

The following appears in the command shell:

============Defining HFSADDR for Webserver=============
===Creating /etc/avamar/avamar.cfg
File already exists. All information in /etc/avamar/avamar.cfg will
be removed.
Are you sure you want to proceed (y/n)?

456 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Command Reference

4. Type y and press Enter.

The following appears in the command shell:
--hfsaddr=10.0.254.202
--vardir=/usr/local/avamar/var
--singleconn
===Done

5. Initialize web services by typing:

website init

The following appears in the command shell:

============Initialize Webserver=============
==Shutting down website
Shutting down httpd: [FAILED]
===Adding web-managers alias
web-managers: [email protected]
Detected web-managers alias
===Done



Ignore any FAILED status indications during web server shutdown. This is normal.

6. Restart web services by typing:

website restart

The following appears in the command shell:

============Initialize Webserver=============
==Shutting down website
Shutting down httpd: [FAILED]
===Adding web-managers alias
web-managers: [email protected]
Detected web-managers alias
===Done
Be sure to setup /etc/avamar/avamar.cfg
(/usr/local/avamar/bin/website create-cfg)
Then restart webserver with SSL enabled
(/usr/local/avamar/bin/website restart)



Ignore any FAILED status indications during web server shutdown. This is normal.

website 457
EMC CONFIDENTIAL
Command Reference

7. Verify web services as described in the following table.

Table 350 Web services verification step by Avamar server type

Avamar server type Verification step

Single-node Open a web browser and type the following URL:

http://AVAMARSERVER-IP

where AVAMARSERVER-IP is the Avamar server IP address.

Multi-node Open a web browser and type the following URL:

http://UTILITY-NODE-IP

where UTILITY-NODE-IP is the IP address of the utility node on the Avamar

server.

The Please click here to transfer to the secure login page appears.
8. Switch back to admin by typing:
exit

zzdpn
The zzdpn command is a system service that implements the automated shutdown and
restart feature on single-node servers.
The zzdpn command is not intended to be run directly from the command line. To
configure and control the automated shutdown and restart feature on the Avamar server,
use dpnctl.

458 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

CHAPTER 3
Environment Variables

The following topics describe Avamar environment variables:

◆ AVAMAR_INSTALL_BASEDIR_PATH ......................................................................... 460
◆ AVAMAR_INSTALL_VARDIR_PATH ........................................................................... 460
◆ SYSNODEDB.......................................................................................................... 460
◆ SYSPROBEDIR ....................................................................................................... 460
◆ SYSPROBEUSER .................................................................................................... 461

Environment Variables 459

EMC CONFIDENTIAL
Environment Variables

AVAMAR_INSTALL_BASEDIR_PATH
This variable is only present in the environment during Solaris client installations. It is
used to set the base installation directory location. The default location is
/usr/local/avamar.

AVAMAR_INSTALL_VARDIR_PATH
This variable is only present in the environment during Linux and Solaris client
installations. It is used to set the var directory location. The default location is
/var/avamar.

SYSNODEDB
This variable stores the path of the node resource database file. The name of the node
resource database file does not need to be probe.xml.

SYSPROBEDIR
This variable stores the path to a directory where a valid probe.out file is located. If not
set, then /usr/local/avamar/var is used. The following utilities use SYSPROBEDIR:
◆ asktime
◆ check.dpn
◆ mapall
◆ mktime
◆ nodedb
◆ nodenumbers
◆ probe
◆ probedump
◆ restart.dpn
◆ rollback.dpn
◆ scn
◆ ssn
◆ start.dpn
◆ start.nodes
◆ timedist

460 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Environment Variables

SYSPROBEUSER
This variable stores an operating system user ID. If set, certain utilities run as that user.
The following utilities use use SYSPROBEUSER:
◆ mapall
◆ mktime
◆ scn
◆ ssn
If not set, then the utility runs as user admin. Typical user IDs stored by this variable are
root, admin, or dpn.

SYSPROBEUSER 461
EMC CONFIDENTIAL
Environment Variables

462 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

CHAPTER 4
Important Files

The following topics describe important files in the Avamar system:

◆ .avamar ................................................................................................................ 464
◆ avagent.cfg ........................................................................................................... 464
◆ AVAMAR-MCS-MIB.txt............................................................................................ 464
◆ avinstaller.xml ...................................................................................................... 464
◆ avw_start_dpn_options.txt ................................................................................... 468
◆ axionfs.cfg ............................................................................................................ 468
◆ checkpoints.xml.................................................................................................... 468
◆ config_info............................................................................................................ 469
◆ emclient.xml ......................................................................................................... 471
◆ emserver.xml ........................................................................................................ 472
◆ /etc/hosts ............................................................................................................ 478
◆ gsankeydata.xml................................................................................................... 479
◆ gsan.log................................................................................................................ 479
◆ license.xml ........................................................................................................... 480
◆ Login manager configuration files ......................................................................... 481
◆ logs.DATE.tar......................................................................................................... 482
◆ mccli.xml .............................................................................................................. 482
◆ mcclient.xml ......................................................................................................... 483
◆ mcclimcs.xml ........................................................................................................ 484
◆ mcserver.xml ........................................................................................................ 487
◆ mktime.custom ..................................................................................................... 512
◆ mktime.out ........................................................................................................... 512
◆ ntp.conf* .............................................................................................................. 512
◆ probe.out.............................................................................................................. 513
◆ probe.xml ............................................................................................................. 517
◆ repl_cron.cfg......................................................................................................... 522
◆ step-tickers* ......................................................................................................... 522
◆ usersettings.cfg .................................................................................................... 522
◆ web.xml ................................................................................................................ 522

Important Files 463

EMC CONFIDENTIAL
Important Files

.avamar
The .avamar file is a flag file that contains options that are passed to Avamar utilities when
they are invoked by this user. The .avamar file is typically found in the home directory for
the admin and dpn users on utility nodes.
The default .avamar file typically contains a single entry:
--flagfile=/usr/local/avamar/etc/usersettings.cfg

This references another flag file, usersettings.cfg.

avagent.cfg
The avagent.cfg file is a flag file. This flag file is located in the Avamar client var directory.
This is typically C:\Program Files\avs\var on Windows clients and /usr/local/avamar/var
on UNIX clients. It contains options that are passed to avagent when it is invoked.

AVAMAR-MCS-MIB.txt
AVAMAR-MCS-MIB.txt is a plain text definition file that describes the Avamar SNMP
Management Information Base (MIB). On Avamar servers, the Avamar MIB is located in
/usr/local/avamar/doc/AVAMAR-MCS-MIB.txt. It also installed with Avamar Administrator
in the /doc subdirectory. The EMC Avamar Administration Guide provides additional
information about monitoring an Avamar server using SNMP.

avinstaller.xml
The avinstaller.xml file is the Avamar AvInstaller configuration file. The file conforms to the
preferences.dtd XML Document Type Description (DTD) referenced by the JDK 1.4 API.
<root type="system">
<node name="com">
<node name="avamar">
<node name="asn">
<node name="module">
<node name="datastore">
<node name="avi">
<node name="repo">
<node name="avigui">
<node name="mc">
<node name="compatibility">
<node name="dpn">
<node name="mcsvars">

Two copies of avinstaller.xml typically reside on each server:

◆ /usr/local/avamar/lib/avi/avinstaller.template.xml is a template that is intended to
be used as a basis for custom site settings. Changes made to this file do not affect the
behavior of the Avamar Avinstaller server.
◆ /usr/local/avamar/var/avi/server_data/prefs/avinstaller.xml is the live configuration
file. Changes made to this file affect the behavior of the Avamar AvInstaller server.

464 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

com.avamar.asn.module.datastore
The following table describes the elements for com.avamar.asn.module.datastore.

Table 351 com.avamar.asn.module.datastore elements

Element Description

database_url URL of the database used by AVI to store data.

database_name EMC internal use only. Do not edit.

database_port Data port used to access the AVI database. Default

setting is 5558.

savePGPrivilegesPath EMC internal use only. Do not edit.

db_schema_version_required_for_update EMC internal use only. Do not edit.

upgrade_script_startswith aviupgrade

dbmaint_path EMC internal use only. Do not edit.

jdbcDriver EMC internal use only. Do not edit.

dbviewsPath EMC internal use only. Do not edit.

dbdropviewsPath EMC internal use only. Do not edit.

dbgrantPath EMC internal use only. Do not edit.

script_path EMC internal use only. Do not edit.

script_params EMC internal use only. Do not edit.

com.avamar.avi
The following table describes the elements for com.avamar.avi.

Table 352 com.avamar.avi elements

Element Description

javaDir Location of the Java home directory.

tomcatDir Location of the symlink to the Tomcat server directory, which points
to the actual Tomcat server directory.

tomcatDirLocation Location of the actual Tomcat server directory.

tomcatTarFile Name of the Tomcat server tarball.

testAviRunningUrl EMC internal use only. Do not edit.

aviDataDir EMC internal use only. Do not edit.

messageLogDirectory EMC internal use only. Do not edit.

PackageLogDirectory EMC internal use only. Do not edit.

taskTimeoutIntervalMinutes Timeout interval for processing a task in a workflow.

aviLibDir EMC internal use only. Do not edit.

avinstaller.xml 465
EMC CONFIDENTIAL
Important Files

com.avamar.avi.repo
The following table describes the elements for com.avamar.avi.repo.

Table 353 com.avamar.avi.repo elements

Element Description

repo_location EMC internal use only. Do not edit.

repo_packages EMC internal use only. Do not edit.

repo_downloads EMC internal use only. Do not edit.

repo_temp EMC internal use only. Do not edit.

com.avamar.avigui
The following table describes the elements for com.avamar.avigui.

Table 354 com.avamar.avigui elements

Element Description

urlProtocol EMC internal use only. Do not edit.

urlPort EMC internal use only. Do not edit.

com.avamar.mc.compatibility
The following table describes the elements for com.avamar.mc.compatibility.

Table 355 com.avamar.mc.compatibility elements

Element Description

db_schema_version EMC internal use only. Do not edit.

db_views_schema_version EMC internal use only. Do not edit.

com.avamar.mc.dpn
The following table describes the elements for com.avamar.mc.dpn.

Table 356 com.avamar.mc.dpn elements (page 1 of 2)

Element Description

flush_method EMC internal use only. Do not edit.

flush_dir EMC internal use only. Do not edit.

flush_exclude_subdirs EMC internal use only. Do not edit.

flush_start_minute EMC internal use only. Do not edit.

flush_delay_minutes EMC internal use only. Do not edit.

flush_interval_min EMC internal use only. Do not edit.

flush_wait_minutes EMC internal use only. Do not edit.

466 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 356 com.avamar.mc.dpn elements (page 2 of 2)

Element Description

flush_path EMC internal use only. Do not edit.

flush_logfile EMC internal use only. Do not edit.

com.avamar.mc.mcsvars
The following table describes the elements for com.avamar.mc.mcsvars.

Table 357 com.avamar.mc.mcsvars elements

Element Description

usrLocal EMC internal use only. Do not edit.

baseDir EMC internal use only. Do not edit.

binDir EMC internal use only. Do not edit.

libDir EMC internal use only. Do not edit.

sqlDir EMC internal use only. Do not edit.

upgradeDir EMC internal use only. Do not edit.

jarDir EMC internal use only. Do not edit.

varDir EMC internal use only. Do not edit.

mcDir EMC internal use only. Do not edit.

logDir EMC internal use only. Do not edit.

dataDir EMC internal use only. Do not edit.

prefsDir EMC internal use only. Do not edit.

postgresDir EMC internal use only. Do not edit.

dbDir EMC internal use only. Do not edit.

dumpFile EMC internal use only. Do not edit.

avinstaller.xml 467
EMC CONFIDENTIAL
Important Files

avw_start_dpn_options.txt
The avw_start_dpn_options.txt file is a flag file containing server startup parameters that
are read by avw_install and passed to the start.dpn command line.
The only valid location for avw_start_dpn_options.txt is /usr/local/avamar/var.
All valid start.dpn options are allowed in avw_start_dpn_options.txt. Each option must
appear as a single line of text. However, if the --nocheck option is present, it is ignored.



Entries in avw_start_dpn_options.txt are not validated. Therefore, be advised that if
invalid start.dpn command line options are included in the options file, then start.dpn
might fail with an error.

axionfs.cfg
The axionfs.cfg file is a flag file that is used by axionfs to implement the Avamar File
System (AvFS) feature.

checkpoints.xml
The checkpoints.xml file stores a list of all checkpoints that have been taken by the
system. The default location is /usr/local/avamar/var/checkpoints.xml.
The following is a sample checkpoints.xml listing:
<?xml version ="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE checkpointlist>
<checkpointlist nodecount="4">
<checkpoint
tag="cp.20131215000403"
isvalid="true"
refcount="4"
cpctime="1134605043"
nodestotal="4"
stripestotal="159"
hfsctime="1134604408"
dirstotal="4"
deletable="true">
<hfscheck
starttime="1134605286"
nodestarttime="1134605286"
nodefinishedtime="1134605302"
validcheck="true"
errors="0"/>
<nodeidlist count="4">
<nodeidrange
dcno="0"
lseqno="0"
useqno="3"/>
</nodeidlist>
</checkpoint>
</checkpointlist>

468 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

config_info
The config_info file is used to configure utility nodes during factory testing and final
deployment of a multi-node, single-node, or Commonality Assessment Tool (CAT) system
at a customer site.
During factory testing, default values are used. During final deployment of an Avamar
server at a customer site, config_info contains final customer network and DNS entries.
The create_newconfigs utility reads these settings and configures the utility node in that
module accordingly.
Each Avamar server configuration uses a slightly different config_info.

Multi-node servers
The config_info files for multi-node servers contain the entries described in the following
table.

Table 358 config_info file entries for multi-node servers

Entry Description

DPNNAME Network hostname as defined in DN) for this Avamar module.

DOMAIN Customer domain name.

GATEWAYIP IP address of the network gateway.

NAMESERVERIP IP address of the customer DNS server. This entry can be blank.

NTPSERVER Network hostname as defined in DNS or IP address of the customer NTP server.

NTPIP IP address of the customer NTP server. This entry can be blank.

NETINFO Subnet and subnet mask of this module. For example, 10.0.99.0/24.
The only valid network widths for these subnets are /24, /25, /26, and /27.

OTHERNETS Subnet and subnet mask of the other Avamar module in this system. For
example, 10.0.98.0/24.
The only valid network widths for these subnets are /24, /25, /26, and /27.

OTHERDPNS Network hostname as defined in DNS for the other Avamar module in this
system. If this config_info file is used to configure the primary module, then this
entry contains the DNS name of the secondary module.

Single-node servers
The config_info files for single-node servers contain the entries described in the following
table.

Table 359 config_info file entries for single-node servers (page 1 of 2)

Entry Description

DPENAME Network hostname as defined in DNS for this single-node server.

DOMAIN Customer domain name.

NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.

config_info 469
EMC CONFIDENTIAL
Important Files

Table 359 config_info file entries for single-node servers (page 2 of 2)

Entry Description

GATEWAYIP IP address of the network gateway.

DPEIP IP address of this single-node server.

NAMESERVERIP IP address of the customer DNS server. This entry can be blank.

Avamar NDMP Accelerator

The config_info files for Avamar NDMP Accelerators contain the entries described in the
following table.

Table 360 config_info file entries for Avamar NDMP Accelerator

Entry Description

ACCNAME Network hostname as defined in DNS for this single-node server.

DOMAIN Customer domain name.

NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.

GATEWAYIP IP address of the network gateway.

ACCIP IP address of this Avamar NDMP Accelerator.

NAMESERVERIP IP address of the customer DNS server. This entry can be blank.

CAT servers
The config_info files for CAT servers contain the entries described in the following table.

Table 361 config_info file entries for CAT servers

Entry Description

CATNAME Network hostname as defined in DNS for this Avamar CAT server.

DOMAIN Customer domain name.

NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.

GATEWAYIP IP address of the network gateway.

CATIP IP address of this Avamar CAT server.

NAMESERVERIP IP address of the customer DNS server. This entry can be blank.

Spare nodes
The config_info files for spare nodes contain the entries described in the following table.

Table 362 config_info file entries for spare nodes (page 1 of 2)

Entry Description

SPARENAME Network hostname as defined in DNS for this spare node.

DOMAIN Customer domain name.

470 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 362 config_info file entries for spare nodes (page 2 of 2)

Entry Description

NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.

GATEWAYIP IP address of the network gateway.

SPAREIP IP address of this spare node.

NAMESERVERIP IP address of the customer DNS server. This entry can be blank.

emclient.xml
The emclient.xml is a Tomcat configuration file that stores Avamar Enterprise Manager
configuration settings.
This file is located in the /usr/local/avamar-tomcat/webapps/cas/WEB-INF directory.
Note that even though this configuration file resides on the EMS, Avamar Enterprise
Manager is a client to Tomcat.
The emclient.xml file contains the entries described in the following table.

Table 363 emclient.xml file entries

Entry Description

serviceHost Name of the node running EMS. The default setting is localhost.

portNumber Data port that is used to communicate with EMS. The default setting is 8778.

searchPrefs Scope of the search. The default setting is session.

showRowCheckBox If true, checkboxes and Select All/Clear All buttons are shown on search
results pages if the number of results exceeds the defaultVisibleRows value.
The default setting is true.

defaultVisibleRows Specifies the maximum number of search result rows that are shown with
checkboxes and Select All/Clear All buttons. If this value is exceeded, then
checkboxes and Select All/Clear All buttons are not shown. The default
setting is 25.

emclient.xml 471
EMC CONFIDENTIAL
Important Files

emserver.xml
The emserver.xml file is an Avamar Enterprise Manager server configuration file. The
emserver.xml file conforms to the preferences.dtd XML Document Type Description (DTD)
referenced by the JSDK 1.4 API.
The following is the Document Object Model (DOM) for emserver.xml:
<root type="system">
<node name="com">
<node name="avamar">
<node name="asn">
<node name="module">
<node name="datastore">
<node name="mail">
<node name="service">
<node name="mc">
<node name="ca">
<node name="compatibility"
<node name="dashboard">
<node name="datadomain">
<node name="dpn">
<node name="event">
<node name="mcvars">

Two copies of emserver.xml typically reside on each server:

◆ /usr/local/avamar/lib/emserver.xml is a template that is intended to be used as a
basis for custom site settings. Changes made to this file do not affect the behavior of
the Avamar Enterprise Manager server.
◆ /usr/local/avamar/var/em/server_data/prefs/emserver.xml is the live configuration
file. Changes made to this file affect the behavior of the Avamar Enterprise Manager
server.

com.avamar.asn
The following table describes the global EMS settings in com.avamar.asn.

Table 364 com.avamar.asn settings (page 1 of 2)

Element Description

login_server_port Data port for login servicing. The default setting is 8779.

node_context_port Data port used for EMS node communication. The default setting is 8781.

port Data port used to contact EMS to service requests. The default setting is
8778.

rmi_cipher_strength Allowed values are medium (128-bit) or high (256-bit). The default setting
is medium.

rmi_over_ssl If true, then communication with the EMS is secured using Secure Sockets
Layer (SSL).
If false, then communication with the EMS is unsecured.
The default setting is false.
This element added in version 4.0.

472 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 364 com.avamar.asn settings (page 2 of 2)

Element Description

rmi_ssl_keystore_ap Password for the certificate keystore in

/usr/local/avamar/lib/rmi_ssl_keystore, which stores the trusted
certificate used by the EMS for SSL-encrypting RMI connections.
This element added in version 4.0.

service_context_port Data port used for EMS service communication. The default setting is
8780.

trust_keystore_ap Password for the certificate keystore in /root/.keystore used by Tomcat.

This element added in version 4.0.

com.avamar.asn.module.datastore
The following table describes the EMS database settings in
com.avamar.asn.module.datastore.

Table 365 com.avamar.asn.module.datastore settings

Element Description

clean_db_start Specifies the start time for each daily clean_db.pl cron session.

database_port Data port used to access EMS database. The default setting is 5556.

database_url EMC internal use only. Do not edit.

datatap_type EMC internal use only. Do not edit.

com.avamar.asn.module.mail
The following table describes the EMS mail settings in com.avamar.asn.module.mail.

Table 366 com.avamar.asn.module.mail settings

Element Description

admin_mail_sender_address EMC internal use only. Do not edit.

smtpHost EMC internal use only. Do not edit.

com.avamar.asn.service
The following table describes the EMS message service settings in
com.avamar.asn.service.

Table 367 com.avamar.asn.service settings

Element Description

flush_timeout_seconds EMC internal use only. Do not edit.

svc_load_file EMC internal use only. Do not edit.

worker_threads EMC internal use only. Do not edit.

wt_polldelay_ms EMC internal use only. Do not edit.

emserver.xml 473
EMC CONFIDENTIAL
Important Files

com.avamar.mc
The following table describes the EMS settings in com.avamar.mc.

Table 368 com.avamar.mc settings

Element Description

crontab_file EMC internal use only. Do not edit. This element added in version 4.0.

enableassertions EMC internal use only. Do not edit.

javaDir Location of Java Runtime Environment (JRE).

maxJavaHeap EMC internal use only. Do not edit.

com.avamar.mc.ca
The following table describes com.avamar.mc.ca settings.

Table 369 com.avamar.mc.ca settings (page 1 of 2)

Element Description

ada_enabled Shows or hides the Avamar Enterprise Manager ADA

menu. The default setting is false.
EMC internal use only. Do not edit. This element added
in version 4.1.

clean_emdb_all Number of days that EMS should retain all Avamar

server monitoring information. The default setting is 14
days.
This element added in version 4.0.

clean_emdb_daily Number of days that EMS should retain daily Avamar

server monitoring information. The default setting is
2555 days (that is, approximately 7 years).
This element added in version 4.0.

clean_emdb_hourly Number of days that EMS should retain hourly Avamar

server monitoring information. The default setting is 90
days.
This element added in version 4.0.

clean_db_start Hour of day to run clean_db.pl script.

This element added in version 4.0.

clean_emdb_cm_operation_log_days Specifies the number of days of Avamar Client Manager

log table records to retain. The default setting is 365
days (1 year).
The records retained after application of this setting
are further pruned by the number of records specified
by clean_emdb_cm_operation_log_records. The
pruning logic reduces records to no more than the
number set by
clean_emdb_cm_operation_log_records.
This element added in version 6.1.

474 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 369 com.avamar.mc.ca settings (page 2 of 2)

Element Description

clean_emdb_cm_queue_info_days Specifies the number of days of Avamar Client Manager

queue table records to retain. The default setting is
365 days (1 year).
The records retained after application of this setting
are further pruned by the number of records specified
by clean_emdb_cm_queue_info_records. The pruning
logic reduces records to no more than the number set
by clean_emdb_cm_queue_info_records.
This element added in version 6.1.

clean_emdb_dpn_info_records Number of dpn_info table records that are retained

during pruning with clean_db.pl. The default setting is
10000000 (10 million records).
This element added in version 6.1.

clean_emdb_ddr_info_records Number of ddr_info table records that are retained

during pruning with clean_db.pl. The default setting is
10000000 (10 million records).
This element added in version 6.1.

clean_emdb_cm_operation_log_records Number of cm_operation_log table records that are

retained during pruning with clean_db.pl. The default
setting is 10000000 (10 million records).
This element added in version 6.1.

clean_emdb_cm_queue_info_records Number of cm_queue_info records that are retained

during pruning with clean_db.pl. The default setting is
10000000 (10 million records).
This element added in version 6.1.

historical_dpninfo_days Specifies the number of days of historical information

that should be retrieved when a new Avamar server is
added to Avamar Enterprise Manager.
The default setting is 30 days of historical data. If set to
zero (0), then no historical data is retrieved.
This element added in version 4.1.

mcs_poll_interval_seconds Rate in seconds for EMS server to poll all managed

Avamar servers for data. The default setting is 600
seconds (10 minutes).

Note: Increasing this value causes a lag in reporting

managed systems status. Decreasing this value
provides closer to real-time status reporting at the
expense of higher system resource utilization.

mcs_poll_retry_interval_seconds EMC internal use only. Do not edit.

metadata_search_enabled Shows or hides Search menu in Avamar Enterprise

Manager. The default setting is false (hide the Search
menu).
This element added in version 3.7.2.

poll_retries EMC internal use only. Do not edit.

tomcatDir EMC internal use only. Do not edit. This element added
in version 4.0.

tomcatTarFile EMC internal use only. Do not edit. This element added
in version 4.0.

emserver.xml 475
EMC CONFIDENTIAL
Important Files

com.avamar.mc.compatibility
The following table describes com.avamar.mc.compatibility settings.

Table 370 com.avamar.mc.compatibility settings

Element Description

db_schema_version EMC internal use only. Do not edit.

db_views_schema_version EMC internal use only. Do not edit.

com.avamar.mc.dashboard
This entire node added in version 4.1. The following table describes the EMS capacity
dashboard settings in com.avamar.mc.dashboard.

Table 371 com.avamar.mc.dashboard settings

Element Description

capErrPercent Defines the capacity threshold, after which the capacity state icon is red.
The default threshold is >95%.

capForecastErrDays Number of days that the capacity forecast icon is red. The default setting
is <30 days.

capForecastWarnDays Number of days that the capacity forecast icon is yellow. The default
setting is <90 days.

capWarnPercent Defines the capacity threshold, after which the capacity state icon is
yellow. The default threshold is >80%.

com.avamar.mc.dpn
The following table describes com.avamar.mc.dpn settings.

Table 372 com.avamar.mc.dpn settings (page 1 of 2)

Element Description

dbmaint_path EMC internal use only. Do not edit.

flush_cacheflag EMC internal use only. Do not edit.

flush_delay_minutes EMC internal use only. Do not edit.

flush_dir EMC internal use only. Do not edit.

flush_exclude_subdirs EMC internal use only. Do not edit.

flush_logfile EMC internal use only. Do not edit.

flush_method EMC internal use only. Do not edit.

flush_path EMC internal use only. Do not edit.

flush_senddataflag EMC internal use only. Do not edit.

flush_start_minute EMC internal use only. Do not edit.

local_flush_dir EMC internal use only. Do not edit.

476 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 372 com.avamar.mc.dpn settings (page 2 of 2)

Element Description

local_flush_filename_base EMC internal use only. Do not edit.

local_flush_retention_count EMC internal use only. Do not edit.

com.avamar.mc.event
The following table describes the EMS event service settings in com.avamar.mc.event.

Table 373 com.avamar.mc.event settings

Element Description

email_max_log_size_mb Specifies the maximum size of any log file attached to an email event
notification. Values must be integers. The default setting is 5 MB.
This setting added in version 5.0.

eventCatalogPath EMC internal use only. Do not edit.

com.avamar.mc.mcvars
The following table describes the EMS program directory and file locations in
com.avamar.mc.mcvars.

Table 374 com.avamar.mc.mcvars settings (page 1 of 2)

Element Description

binDir EMC internal use only. Do not edit.

The default setting is bin.

dataDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data.

dbDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data/postgres/data.

dumpFile EMC internal use only. Do not edit.

The default setting is var/mc/server_data/mcs_data_dump.sql.

jarDir EMC internal use only. Do not edit.

The default setting is lib.

libDir EMC internal use only. Do not edit.

The default setting is lib.

logDir EMC internal use only. Do not edit.

The default setting is var/mc/server_log.

mcDir EMC internal use only. Do not edit.

The default setting is var/mc.

postgresDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data/postgres.

prefsDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data/prefs.

emserver.xml 477
EMC CONFIDENTIAL
Important Files

Table 374 com.avamar.mc.mcvars settings (page 2 of 2)

Element Description

sqlDir EMC internal use only. Do not edit.

The default setting is lib/sql.

upgradeDir EMC internal use only. Do not edit.

The default setting is lib/upgrade.

usrLocal EMC internal use only. Do not edit.

This element added in version 4.0.

varDir EMC internal use only. Do not edit.

The default setting is var.

/etc/hosts
The /etc/hosts file is an operating system configuration file that contains information
regarding known hosts on the network. This provides a mechanism for resolving IP
addresses to network hostnames that is independent of DNS.
The location for the /etc/hosts files are on Avamar utility nodes. The files are used by the
system to resolve the IP addresses of these nodes to the official hostname and various
aliases.

File format and syntax

For each host, a single line should be present with the following information:
IP-ADDR HOST-NAME [ALIAS-1 ...ALIAS-n]

where IP-ADDR is the IP address of this network host, official HOST-NAME is the fully
qualified official name of this network host, and ALIAS-1 through ALIAS-n are one or more
optional names for this network host. Aliases can be fully qualified (for example,
host.domain.com) or unqualified (for example, host).
Values are separated by any number or combination of spaces or tabs. A pound sign (#)
indicates the beginning of a comment.
The first /etc/hosts entry must always be the localhost entry. For example:
127.0.0.1 localhost.localdomain localhost

Default /etc/hosts files

These entries appear in the default utility node /etc/hosts file:
127.0.0.1 localhost.localdomain localhost
10.0.99.5 dpn99s.local.avamar.com dpn99s
10.0.99.6 dpn99mcs.local.avamar.com dpn99mcs.avamar.com dpn99mcs

These entries appear in single-node and CAT server /etc/hosts files:

127.0.0.1 localhost.localdomain localhost
10.0.99.5 dpne99s.corp.com dpne99s

478 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

These entries reflect default network settings used for factory tests. When deploying an
Avamar server at a customer site, these entries are modified during system installation to
reflect actual node network settings and hostnames in use at that customer site. For
example, “dpn99” is typically changed to some customer-defined Avamar server name
(for example, “my-dpn-01”), and IP addresses are changed to reflect actual
customer-defined subnets used by each Avamar module.

gsankeydata.xml
The gsankeydata.xml file is an information file generated by the gathergsankeydata utility.
This file is used as an input for the AvaSpere web-based license generation mechanism.
The following is a typical gsankeydata.xml listing:
<?xml version ="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE gsankeydatalist (View Source for full doctype...)>
<gsankeydatalist customer-asset-id="A-2013001041" account-id="101010">
<gsankeydata time="1128033237" hostname="multi_axion_test4">
<macaddr name="eth0" addr="00:30:48:51:EE:B3">
<ipaddr addr="10.0.66.5" />
</macaddr>
<macaddr name="eth1" addr="00:30:48:51:EE:A9" />
<sysinfo kernel-version ="Linux version 2.4.21-20.EL
([email protected]) (gcc version 3.2.3 20130502
(Red Hat Linux 3.2.3-42)) #1 Wed Aug 18 20:58:25 EDT 2013"
memsize="1578557440" tzname="PDT"
localtime="Thu Sep 29 15:33:57 2013" />
</gsankeydata>
</gsankeydatalist>

gsan.log
The gsan.log file is the log file for the Avamar storage (gsan) processes.
In a multi-node server, there is one gsan.log file on each storage node. The gsan.log file is
located in the /data01/cur directory on each storage node.
In a single-node server, there is only one gsan.log file. It is located in the /data01/cur
directory.
File size and versioning for gsan.log is controlled by the maxlogsize=MB and
maxlogfiles=N parameters, respectively, in avmaint config. This behavior can also be
controlled by supplying the --maxlogsize=MB and --maxlogfiles=N options with either
start.dpn or restart.dpn commands.
Maximum gsan.log file size is controlled by the maxlogsize=MB parameter, where MB is
the maximum allowable gsan.log file size in MB. The default setting is 25 MB. In a
multi-node server, this setting applies equally to all storage nodes on the server. You
cannot configure gsan.log file size on a node-by-node basis.
Once gsan.log reaches this maximum size, it is renamed to gsan.log.001. The gsan.log file
is then emptied so that it can continue storing the most recent information.
When gsan.log reaches its maximum size a second time, gsan.log.001 is renamed to
gsan.log.002, gsan.log is renamed to gsan.log.001, and gsan.log is again emptied so that
it can continue storing the most recent information.

gsankeydata.xml 479
EMC CONFIDENTIAL
Important Files

This mechanism continues creating new historic log files and shifting information into
them until the maximum number of gsan.log files allowed on that storage node is reached.
Once this maximum limit is reached, the oldest gsan.log file is dropped from the system.
This maximum number of gsan.log files allowed on any given storage node is controlled by
the maxlogfiles=N parameter, where N is the maximum number of gsan.log files allowed.
The default setting is to limit the number of gsan.log files allowed on any given storage
node to 100 maximum. In a multi-node server, this setting applies equally to all storage
nodes on the server. You cannot configure the maximum number of gsan.log files on a
node-by-node basis.

license.xml
The license.xml file is the license key file used by the server to determine how much
storage capacity has been licensed for that Avamar server.
The AvaSpere web-based license generation mechanism typically generates license.xml. It
must be present on the utility node in/usr/local/avamar/etc in order for the server to
work.
The following is a typical license.xml listing:
3df6d6d4e60fa9efdc1e5a8b7ad72b231cc48d71
<?xml version ="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE licensekey>
<licensekey
generation-time="1130544323"
account-id="101010"
customer-asset-name="avamar-1"
customer-asset-id="A-2013001041"
expires="0"
protected-data-max="80">
<macaddr addr="00:30:48:27:D1:2A"/>
</licensekey>



The first line of this file contains an encrypted identifier, which was generated by by the
web-based license generation mechanism when the license key file was created. This
encrypted identifier must be correct and present for the license key file to work.

480 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Login manager configuration files

The configuration files in the following table are used by the lm utility. Some configuration
files might not be used at all sites.

Table 375 lm utility configuration files

Configuration file Description

/etc/avamar/domains.cfg EMC domain configuration file. Identifies the supported external

authentication domains, and associates a unique numerical identifier
with each domain name.

/etc/pam.d/lm_# PAM configuration file for the login manager for domain ID “#”
authentication domain. These files are typically symbolic links to
named configuration files (for example, lm_DOMAIN_NAME).

/etc/rc.d/init.d/lm Script for activating the login manager during system startup.

/var/run/lm.pid Contains the process ID of the currently running login manager.

/etc/pam.d/lm_ldap LDAP configuration for the login manager. Identifies the PAM module
to use (/lib/security/pam_ldap.so).

/etc/pam.d/lm_nis NIS configuration for the login manager. Identifies the PAM module to
use (/lib/security/pam_unix.so).

/etc/pam.d/lm_winnt SMB configuration for the login manager. Identifies the PAM module to
use (/lib/security/pam_smb.so).

/etc/ldap.conf LDAP configuration file. Identifies the LDAP server and how to
communicate with the server. This is typically a symbolic link to one of
the example LDAP configuration files.

/etc/ldap.conf.nis Example LDAP configuration file for use with an OpenLDAP (NIS based)
server.

/etc/ldap.conf.winad Example LDAP configuration file for use with a Windows Active
Directory server.

/etc/yp.conf NIS client configuration file. Identifies the NIS domain and domain
server.

/etc/pam_smb.conf Default SMB client configuration file. Identifies the Windows domain,
Primary Domain Controller (PDC), and Backup Domain Controller
(BDC).

/etc/resolve.conf Domain Name Server (DNS) client resolver configuration file. Identifies
the DNS server.

Login manager configuration files 481

EMC CONFIDENTIAL
Important Files

logs.DATE.tar
The logs.DATE.tar file is generated by the getlogs utility. It contains important log files from
all nodes in the system in compressed format.
The DATE portion of the filename is an eight character date code (YYYYMMDD) and
six-character timestamp (HHMMSS).
If you view the contents of logs.DATE.tar using the tar -tvf logs.DATE.tar command, then the
contents typically look like this:
0.0/nodelogs.tgz
0.1/nodelogs.tgz
0.2/nodelogs.tgz
0.m/nodelogs.tgz
0.s/nodelogs.tgz
1.0/nodelogs.tgz
1.1/nodelogs.tgz
1.2/nodelogs.tgz
1.s/nodelogs.tgz

Each node in the system has a subdirectory named for its physical node number as
defined in the probe.out file.

mccli.xml
The mccli.xml file is the Avamar Administrator CLI preferences file. This file contains all
user-modifiable parameters for the Avamar Administrator CLI application.
The factory default version of mccli.xml is located in $AVAMAR_ROOT/lib. Each time the
Avamar Administrator CLI application is run,
$USER_ROOT/.avamardata/var/mc/cli_data/prefs is examined to determine if a working
copy of mccli.xml is present. If mccli.xml is not present in
$USER_ROOT/.avamardata/var/mc/cli_data/prefs, then the factory default copy of
mccli.xml is copied to that location from $AVAMAR_ROOT/lib.
When any Avamar Administrator CLI command is invoked,
$USER_ROOT/.avamardata/var/mc/cli_data/prefs/mccli.xml is read, and those settings
are used for that command session.

com.avamar.mc.cli
The following table describes com.avamar.mc.cli settings.

Table 376 com.avamar.mc.cli settings (page 1 of 2)

Element Description

detail_server_stats If true, enables detail server statistics that were previously

removed. The default setting is false.
This element added in version 4.1.

event_monitor_display_limit Sets the maximum number of events to retrieve. An informational

message is displayed if the limit is reached. The default setting is
5000.

invalid_name_characters List of invalid characters for use in directory or filenames.

482 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 376 com.avamar.mc.cli settings (page 2 of 2)

Element Description

mcs_config_file Location of the mcclimcs.xml default options file. The default

setting is lib/mcclimcs.xml.

syntax_file EMC internal use only. Do not edit.

mcclient.xml
The mcclient.xml file is the Avamar Administrator configuration file. The file conforms to
the preferences.dtd XML Document Type Description (DTD) referenced by the JSDK 1.4 API.

com.avamar.mc.gui
The following table describes the com.avamar.mc.gui settings.

Table 377 com.avamar.mc.gui settings

Element Description

ddr_max_streams Sets the maximum number of streams. The default setting is 50

streams.
This element added in version 6.0.

ddr_snmp_community_str SNMP community name. The default name is public.

This element added in version 6.0.

ddr_snmp_getter_setter_port Data port for SNMP getter and setter. The default value is 161. The
default setting is data port 161.
This element added in version 6.0.

ddr_snmp_trap_port Data port on which to recieve SNMP trap message. The default
setting is data port 162.
This element added in version 6.0.

debug Debug mode if true.

detail_server_stats If true, enables detail server statistics that were previously

removed. The default setting is false.
This element added in version 4.1.

dst_update_check Enables or disables a check to determine whether the Sun Java

DST update has been applied. The default setting is true (perform
the check).
This element added in version 3.7.1.

invalid_name_characters List of invalid characters for use in directory or filenames.

lm_warn Enables or disables a license manager quota check. The default

setting is true (perform the quota check).

max_backup_nodes Sets the maximum number of directories and files that are shown
at one time when browsing backup contents. The default setting is
50000.
This element added in version 4.1.

port_number Port number to use for communication with the MCS.

service_host Fully qualified name or IP address of the utility node.

mcclient.xml 483
EMC CONFIDENTIAL
Important Files

mcclimcs.xml
The mcclimcs.xml is an XML file that stores custom mccli command parameters and profile
settings that are used when you invoke an mccli command.

Default command parameters

The mcclimcs.xml preferences file can be used to set a default value for any mccli
command parameter. Any default values set in this file are used unless another value is
explicitly supplied on the command line. Additionally, these default values are global
(they are used by all profiles).

Profiles
Each profile is an element in the XML document and is distinguishable by the mcsprofile
attribute, which identifies the name of the profile. Each profile contains a list of default
options to use with the MCS specified for that profile. One profile can be designated as the
default profile to use if no MCS information is specified on the command line by way of the
global options. Otherwise, the profile name of the MCS is all that is required on the
command line, and the remainder of the options are read from the configuration file. One
or all of the options can be specified on the command line to override entries in the
mcclimcs.xml file.



If the server hostname or data port assignment are changed for any reason (for example,
after running the resite utility), or the user account name or password used to run mccli
commands is changed for any reason, you must manually update the corresponding
settings in the mcclimcs.xml preferences file to account for those changes.

Behavior
The factory default version of mcclimcs.xml is located in $AVAMAR_ROOT/lib. Each time
the Avamar Administrator CLI application is run,
$USER_ROOT/.avamardata/var/mc/cli_data/prefs is examined to determine if a working
copy of mcclimcs.xml is present.
If $USER_ROOT/.avamardata/var/mc/cli_data/prefs/mcclimcs.xml is not present, then
the factory default copy of mcclimcs.xml is copied to that location from
$AVAMAR_ROOT/lib.

Default file settings

The following is a listing of the default mcclimcs.xml options file:
<!-- MCS Profiles -->

<!-- default : name of default MCS profile -->

<!-- mcsprofile : MCS profile name -->
<!-- mcsaddr : network name or IP of MCS node -->
<!-- mcsport : port to contact MCS -->
<!-- mcsuserid : account on MCS -->
<!-- mcspasswd : password -->

<MCSConfig default="local">

484 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

<Defaults>
<Commands>
<!-- Add Resource, Command, Options, Option nodes to match-->
<!-- the hierarchy in the mcclisyntax.xml file -->
<!-- use the Value attribute to specify the default value -->
<!--
<Resource Name="ResourceName">
<Command Name="CommandName">
<Options>
<Option Name="OptionName" Value="OptionValue" />
</Options>
</Command>
</Resource>
-->
<Resource Name="activity">
<Command Name="show">
<Options>
<Option Name="active" Value="true" />
</Options>
</Command>
</Resource>
<Resource Name="client">
<Command Name="add">
<Options>
<Option Name="enabled" Value="true" />
<Option Name="pageport" Value="29123" />
</Options>
</Command>
</Resource>
</Commands>
</Defaults>
<MCS
mcsprofile="local"
mcsaddr="avamar-1.example.com"
mcsport="7778"
mcsuserid="root"
mcspasswd="MyPassword"
/>
<!-- add more profiles if needed here -->
<!-- and set default to select default -->
</MCSConfig>

mcclimcs.xml 485
EMC CONFIDENTIAL
Important Files

Practical examples
Consider the following activity resource setting:
<Resource Name="activity">
<Command Name="show">
<Options>
<Option Name="active" Value="true" />
</Options>
</Command>
</Resource>

This setting constrains the mccli activity show command to only show active jobs, as if the
--active=true option was supplied on the command line.
Consider the following client resource settings:
<Resource Name="client">
<Command Name="add">
<Options>
<Option Name="enabled" Value="true" />
<Option Name="pageport" Value="29123" />
</Options>
</Command>
</Resource>

These settings affect the mccli client add command so that any new client is enabled and
has its page data port set to 29123 as if the --enabled=true and --pageport=29123
options were supplied on the command line.

486 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

mcserver.xml
The mcserver.xml file is the MCS configuration file. The mcserver.xml file conforms to the
preferences.dtd XML Document Type Description (DTD) referenced by the JSDK 1.4 API.
The following is the Document Object Model (DOM) for mcserver.xml.
<root type="system">
<node name="com">
<node name="avamar">
<node name="asn">
<node name="module">
<node name="datastore">
<node name="mail">
<node name="rpt">
<node name="service">
<node name="mc">
<node name="burm">
<node name="connectemc"
<node name="cr">
<node name="datadomain">
<node name="dpn">
<node name="users">
<node name="dtlt">
<node name="event">
<node name="ldap">
<node name="lm">
<node name="mcsdk">
<node name="mcsm">
<node name="mcsvars">
<node name="mon">
<node name="repl">
<node name="rpt">
<node name="security">
<node name="um">
<node name="vmware">
<node name="wo">

Two copies of mcserver.xml typically reside on each server:

◆ /usr/local/avamar/lib/mcserver.xml is a template that is intended to be used as a
basis for custom site settings. Changes made to this file do not affect the behavior of
the MCS.
◆ /usr/local/avamar/var/mc/server_data/prefs/mcserver.xml is the live configuration
file. Changes made to this file affect the behavior of the MCS.

com.avamar.asn
The following table describes the global MCS settings in com.avamar.asn.

Table 378 com.avamar.asn settings (page 1 of 2)

Element Description

cipher_suite_128 Common-separated list of supported 128-bit cipher suites.

cipher_suite_256 Common-separated list of supported 256-bit cipher suites.

datastore_module_class EMC internal use only. Do not edit.

mailmgr_module_class EMC internal use only. Do not edit.

mcserver.xml 487
EMC CONFIDENTIAL
Important Files

Table 378 com.avamar.asn settings (page 2 of 2)

Element Description

port Data port for client connection. The default setting is 7778.

rmi_cipher_strength Allowed values are medium (128-bit) or high (256-bit). The default
setting is medium.

rmi_over_ssl If true, then communication with the MCS is secured using SSL.
If false, then communication with the MCS is unsecured.
The default setting is false.
This element added in version 4.0.

rmi_ssl_keystore_ap Password for the certificate keystore in

/usr/local/avamar/lib/rmi_ssl_keystore, which stores the trusted
certificate used by the MCS for SSL-encrypting RMI connections.
This element added in version 4.0.

security_module_class EMC internal use only. Do not edit.

com.avamar.asn.module.datastore
The following table describes the MCS database settings in
com.avamar.asn.module.datastore.

Table 379 com.avamar.asn.module.datastore settings (page 1 of 4)

Element Description

activities_max_batch_size EMC internal use only. Do not edit.

activities_max_queue_size EMC internal use only. Do not edit.

activities_sleep_msec_if_max_queued EMC internal use only. Do not edit.

activities_thread_cnt EMC internal use only. Do not edit.

audits_max_batch_size EMC internal use only. Do not edit.

This element added in version 4.1.

audits_max_queue_size EMC internal use only. Do not edit.

This element added in version 4.1.

audits_sleep_msec_if_max_queued EMC internal use only. Do not edit.

This element added in version 4.1.

audits_thread_cnt EMC internal use only. Do not edit.

This element added in version 4.1.

clean_db_activities_days Specifies the number of days of activities table

information to retain. The default setting is 365
days (1 year).
The records retained after application of this
setting are further pruned by the number of
records specified by clean_db_activities_records.
The pruning logic will reduce records to no more
than the number set by
clean_db_activities_records.
This element added in version 5.0. Relationship to
clean_db_activities_records added in version 6.1.

488 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 379 com.avamar.asn.module.datastore settings (page 2 of 4)

Element Description

clean_db_audits_days Specifies the number of days of audits table

information to retain. The default setting is 365
days (1 year).
The records retained after application of this
setting are further pruned by the number of
records specified by clean_db_audits_records.
The pruning logic will reduce records to no more
than the number set by clean_db_audits_records.
This element added in version 5.0. Relationship to
clean_db_audits_records added in version 6.1.

clean_db_events_days Specifies the number of days of events table

information to retain. The default setting is 365
days (1 year).
The records retained after application of this
setting are further pruned by the number of
records specified by clean_db_events_records.
The pruning logic will reduce records to no more
than the number set by clean_db_events_records.
This element added in version 5.0. Relationship to
clean_db_events_records added in version 6.1.

clean_db_sv_node_space_days Specifies the number of days of sv_node_space

table information to retain. The default setting is
365 days (1 year).
The records retained after application of this
setting are further pruned by the number of
records specified by
clean_db_sv_node_space_records. The pruning
logic will reduce records to no more than the
number set by clean_db_sv_node_space_records.
This element added in version 5.0. Relationship to
clean_db_sv_node_space_records added in
version 6.1.

clean_db_sv_node_util_days Specifies the number of days of sv_node_util

table information to retain. The default setting is
365 days (1 year).
The records retained after application of this
setting are further pruned by the number of
records specified by
clean_db_sv_node_util_records. The pruning
logic will reduce records to no more than the
number set by clean_db_sv_node_util_records.
This element added in version 5.0. Relationship to
clean_db_sv_node_util_records added in version
6.1.

mcserver.xml 489
EMC CONFIDENTIAL
Important Files

Table 379 com.avamar.asn.module.datastore settings (page 3 of 4)

Element Description

clean_db_ddr_node_space_days Specifies the number of days of ddr_node_space

table information to retain. The default setting is
365 days (1 year).
The records retained after application of this
setting are further pruned by the number of
records specified by
clean_db_ddr_node_space_records. The pruning
logic will reduce records to no more than the
number set by
clean_db_ddr_node_space_records.
This element added in version 6.0. Relationship to
clean_db_ddr_node_space_records added in
version 6.1.

clean_db_events_records Maximum number of event table records that are

retained when pruning with clean_db.pl. The
default setting is 10000000 (10 million records).
This element added in version 6.1.

clean_db_audits_records Maximum number of audit table records that are

retained when pruning with clean_db.pl. The
default setting is 10000000 (10 million records).
This element added in version 6.1.

clean_db_activities_records Maximum number of activities table records that

are retained when pruning with clean_db.pl. The
default setting is 10000000 (10 million records).
This element added in version 6.1.

clean_db_sv_node_space_records Maximum number of sv_node_space table

records that are retained when pruning with
clean_db.pl. The default setting is 10000000 (10
million records).
This element added in version 6.1.

clean_db_sv_node_util_records Maximum number of sv_node_util table records

that are retained when pruning with clean_db.pl.
The default setting is 10000000 (10 million
records).
This element added in version 6.1.

clean_db_ddr_node_space_records Maximum number of ddr_node_space records

that are retained when pruning with clean_db.pl.
The default setting is 10000000 (10 million
records).
This element added in version 6.1.

database_port Data port used by the MCS database. The default

setting is 5555.

database_url Name of the database used by MCS to store

operational and report data.

db_schema_version _required_for_update Minimum version of the MCS database that

supports a direct update to this version of the
MCS database.

dbdropviewsPath EMC internal use only. Do not edit.

dbgrantPath EMC internal use only. Do not edit.

490 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 379 com.avamar.asn.module.datastore settings (page 4 of 4)

Element Description

dbviewsPath EMC internal use only. Do not edit.

ds_load_file EMC internal use only. Do not edit.

events_max_batch_size EMC internal use only. Do not edit.

events_max_queue_size EMC internal use only. Do not edit.

events_sleep_msec_if_max_queued EMC internal use only. Do not edit.

events_thread_cnt EMC internal use only. Do not edit.

max_db_conn Maximum number of database connections.

mds_data_dir Metadata search database data directory.

mds_database_host Metadata search database hostname.

mds_database_port Metadata search database data port.

The default setting is 5557.

mds_database_url Metadata search database universal resource

locator.

mds_log_dir Metadata search database log file directory.

mds_pass Metadata search database account password.

mds_user Metadata search database account name.

min_db_conn Number of MCS database connections to initially

allow. The default setting is 10.

root_dir EMC internal use only. Do not edit.

savePGPrivilegesPath EMC internal use only. Do not edit.

snapup_history_max_batch_size EMC internal use only. Do not edit.

snapup_history_max_queue_size EMC internal use only. Do not edit.

snapup_history_sleep_msec_if_max_queued EMC internal use only. Do not edit.

snapup_history_thread_cnt EMC internal use only. Do not edit.

com.avamar.asn.module.mail
The following table describes the module mail settings in com.avamar.asn.module.mail.

Table 380 com.avamar.asn.module.mail settings

Element Description

admin_mail_sender_address Sender email address for MCS mail messages.

The default setting is [email protected],
where AVAMARSERVER.DOMAIN is the fully qualified name of the
Avamar server as defined in DNS.

smtpHost Outgoing SMTP mail server name. The default setting is mail.

mcserver.xml 491
EMC CONFIDENTIAL
Important Files

com.avamar.asn.service
The following table describes the MCS message service settings in
com.avamar.asn.service.

Table 381 com.avamar.asn.service settings

Element Description

svc_load_file EMC internal use only. Do not edit.

worker_threads EMC internal use only. Do not edit.

wt_polldelay_ms Time in milliseconds that a worker thread waits after making a complete pass
to all service queues without finding any service messages. The default setting
is 100.

com.avamar.mc
The following table describes the Avamar server settings in com.avamar.mc.

Table 382 com.avamar.mc settings (page 1 of 2)

Element Description

allow_end_user_to_request_snapup If true, then users can initiate an on-demand client

backup using the Avamar Client for Windows system tray
icon.
If false, then Avamar Client for Windows cannot initiate
on-demand backups.
The default setting is true.

crontab_file EMC internal use only. Do not edit.

This element added in version 4.0.

em_port Data port used to communicate with the local EMS. The
default setting is 8778.
This element added in version 5.0.

enableassertions EMC internal use only. Do not edit.

enableBrmService If true, the Backup & Recovery Manager (BRM) adaptor

service is enabled to send status to the BRM application.
This element added in version 7.0.

external_nonat_addr External Network Address Translation (NAT) IP address.

This is the IP address used by backup clients to connect
to the MCS when the Avamar server is located on a
private network that the client cannot access directly.

failovermcaddr EMC internal use only. Do not edit.

failovermcport EMC internal use only. Do not edit.

failovermin EMC internal use only. Do not edit.

group_scheduler_enabled If true, then scheduled backups are automatically

enabled immediately after MCS starts and restarts.
If false, then regularly scheduled group backups must be
manually enabled each time the MCS is restarted.
The default setting is false.

492 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 382 com.avamar.mc settings (page 2 of 2)

Element Description

hfsaddr Avamar server hostname. This name is passed to the

client and is generally resolved by way of the site DNS.

hfsport Data port used to communicate with the Avamar server.

The default setting is 2700.

ld_library_path EMC internal use only. Do not edit.

local_hfsaddr hfsaddr to use for MCS to Avamar server communication.

The default setting is the same as hfsaddr.

max_report_size_to_mcgui Maximum number of characters that the MCS sends to

Avamar Administrator when a System - GSAN Perf Stats
report is run interactively.
This setting only affects the amount of information
shown in Avamar Administrator. It does not affect the
amount of data emailed.
The default setting is 102400 characters.
This element added in version 6.0.

maxJavaHeap EMC internal use only. Do not edit.

maxPermSize EMC internal use only. Do not edit.

This element added in version 6.0.

product EMC internal use only. Do not edit.

proxy_deployment_manager_monitor_ Number of seconds Proxy Deployment Manager tasks are

refresh_delay_seconds allowed to run before they time out. The default setting is
10 seconds.
This element added in version 7.2.

rmi_address EMC internal use only. Do not edit.

com.avamar.mc.burm
The following table describes com.avamar.mc.burm settings.

Table 383 com.avamar.mc.burm settings

Element Description

backup_adhoc_group_priority EMC internal use only. Do not edit.

This element added in version 7.0.

backup_adhoc_priority EMC internal use only. Do not edit.

This element added in version 6.0.

restore_adhoc_priority EMC internal use only. Do not edit.

This element added in version 6.0.

restore_backup_window_hours EMC internal use only. Do not edit.

validate_adhoc_priority Job priority for on-demand backup validations.

The default setting is 3000.
This element added in version 7.1.

validate_sched_priority Job priority for scheduled backup validations.

The default setting is 0.
This element added in version 7.1.

mcserver.xml 493
EMC CONFIDENTIAL
Important Files

com.avamar.mc.connectemc
The following table describes the ConnectEMC settings in com.avamar.mc.connectemc.
This entire node added in version 5.0.

Table 384 com.avamar.mc.connectemc settings

Element Description

connectemc_channels EMC internal use only. Do not edit.

connectemc_poll EMC internal use only. Do not edit.

site_name EMC internal use only. Do not edit.

com.avamar.mc.cr
The following table describes the client registration settings in com.avamar.mc.cr.

Table 385 com.avamar.mc.cr settings (page 1 of 2)

Element Description

allow_duplicate_client_names Controls whether a client name can appear multiple places in

the server domain structure. The default setting is false.

browse_for_backup_secondary Specifies the timeout setting for browsing backup objects

_timeout_seconds containing many submembers, in seconds.
The default setting is 120.

client_can_init_snapups Controls whether a client can initiate backups immediately after

activation. The default setting is true.

client_listen_port The default setting is 28002.

client_num_retries Number of retries before a client is deemed to have stopped

communicating with the MCS. The default setting is 2.

client_timeout_sec Time in seconds before a client is deemed to have stopped

communicating with the MCS. The default setting is 10.

default_bulk_user_permission When adding multiple clients or users with the batch client
registration feature, this privilege is assigned unless another is
explicitly set in the clients definition file. The default setting is
enabled,read,backup.

default_domain When adding multiple clients or users with the batch client
registration feature, this domain is assigned unless another is
explicitly set in the clients definition file. The default setting is
clients.

encrypt_server_authenticate Enables or disables the current client/server socket encryption

mechanism. If true, pre-4.0 clients will fail when they attempt to
authenticate with a 4.0 or later Avamar server. The default
setting is true.

enforce_client_msg_encryption If true, the MCS will not accept unencrypted (plain-text) client
messages. The default setting is true.
This element added in version 7.0.

mcs_service_port The default setting is 28001.

494 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 385 com.avamar.mc.cr settings (page 2 of 2)

Element Description

plugin_catalog_dir EMC internal use only. Do not edit.

Specifies the location of plug-in files.
The default setting is /usr/local/avamar/lib/plugins.
This element added in version 4.1.

plugin_catalog_loading Controls how the plug-in catalog is loaded. One of the

following:
• always—The plug-in catalog is always reloaded from the
plug-in catalog file.
• different—The plug-in catalog is reloaded when there is a
version mismatch between the plug-in catalog file and the
currently loaded plug-in catalog.
• newer—The plug-in catalog reloads from the plug-in catalog
file if the file version is newer than the version that is already
loaded.

plugin_catalog_xml EMC internal use only. Do not edit.

Note: Beginning with version 4.1, this option is deprecated in

favor of plugin_catalog_dir.

reset_registration EMC internal use only. Do not edit.

The default setting is false.

com.avamar.mc.datadomain
The following table describes com.avamar.mc.datadomain settings. This entire node
added in version 6.0.

Table 386 com.avamar.mc.datadomain settings (page 1 of 3)

Element Description

checkPointBackupTrigger Controls when checkpoint backups occur. Valid values are

any of the following:
• CP_CREATE_SUCCESS—Back up checkpoints as soon as
they are created.
• CP_HFSCHECK_END—Back up checkpoints after
checkpoint validation (HFS check) ends.
• CP_HFSCHECK_START—Back up checkpoints after
checkpoint validation (HFS check) begins.
• CP_HFSCHECK_SUCCESS—Back up checkpoints after
checkpoint validation (HFS check) successfully
completes.
• NONE—Never back up checkpoints.
This element added in version 7.0.

ddr_ignore_snmp_errors If set to true, the node ignores SNMP errors. Default value is
false.
This element added in version 7.2.

ddr_max_streams_limit_max Maximum number of simultaneous data streams allocated

for operations involving Data Domain systems.
Optimum settings vary according to which Data Domain
systems are in use. Models such as the DD880 can reliably
support 180 simultaneous streams, whereas the DD610 can
only reliably support 64. The default setting is 64.

mcserver.xml 495
EMC CONFIDENTIAL
Important Files

Table 386 com.avamar.mc.datadomain settings (page 2 of 3)

Element Description

ddr_max_streams_limit_min Default minimum value for the maximum streams setting.

The default setting is 15 minutes.

ddr_poller_interval_sec Frequency at which Data Domain systems are polled for data.
The default setting is 60 seconds.

ddr_snmp_get_retries The number of SNMP GET retries. The default is 1.

This element added in version 7.2.

ddr_snmp_get_table_timeout_sec The number of seconds that system will wait for a response
to an SNMP GET TABLE attempt. The default is 200.
This element added in version 7.2.

ddr_snmp_get_table_max_rows The maximum rows that system will receive for an SNMP GET
TABLE attempt. The default is 20.
This element added in version 7.2.

ddr_snmp_get_timeout_sec The number of seconds that system will wait for a response
to an SNMP GET attempt. The default is 10.
This element added in version 7.2.

ddr_snmp_get_udp_socket_timeo The number of seconds that system will wait for a response
ut_sec to an SNMP GET UDP SOCKET attempt. The default is 5.
This element added in version 7.2.

ddr_ssh_cli_user_name Optional Data Domain system username for ddr ssh cli
commands.
If not defined, then the ost user is used. The default setting
is undefined (null).

ddr_ssh_key_path_name The path and filename of the private key for ddr ssh cli
commands. The default setting is
/usr/local/avamar/lib/ddr_key.

ddr_stream_management_enabled If true, then backup and restore operations involving a Data

Domain system are not allowed if the number of minimum
streams defined at the plug-in level are not available. The
default setting is true.

ddrCommandFailureLimit Maximum number of failed attempts to poll any Data Domain

system. Once this limit has been reached, the overall Avamar
server state becomes inactive. The state remains inactive
until all Data Domain systems can be polled without failure.
The default setting is 10 attempts.

ddrJobCapacityFactor Job capacity for a backup or restore operation to or from a

Data Domain system when compared with a backup or
restore operation to or from the Avamar server.
The default setting is 1, meaning that a Data Domain job is
equivalent in capacity to an Avamar server job.

ddrmaint_params Additional parameters passed to all invocations of the

ddrmaint command. The default setting is --timeout=30.

ddrmaint_timeout_sec Number of seconds before a command times out if it does

not complete. The default setting is 5 minutes (300
seconds).

ddrmaintPath Path to the ddrmaint command. The default setting is

bin/ddrmaint.

496 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 386 com.avamar.mc.datadomain settings (page 3 of 3)

Element Description

ddrPollerRestartMinutes Restart poller in this time interval if it has stopped. The

default setting is 15 minutes.

min_supported_version Minimum Data Domain OS version supported. The default

setting is 4.9.0.

ps_max_indexes Maximum number of Data Domain systems that can be

managed by the MCS. The default setting is 255.

com.avamar.mc.dpn
The following table describes the Avamar client settings for the MCS in
com.avamar.mc.dpn.

Table 387 com.avamar.mc.dpn settings (page 1 of 4)

Element Description

avmaint_timeout_sec Number of seconds to wait for an avmaint response before killing

the process.

avmaintPath Fully qualified path and executable name of the avmaint utility.

avmgr_timeout_sec Number of seconds to wait for an avmgr response before killing the
process.

avmgrPath Fully qualified path and executable name of the avmgr utility.

avPath Fully qualified path of the EMC software root install directory.

avtar_timeout_sec Number of seconds to wait for an avtar response before killing the
process.

avtarPath Fully qualified path and executable name of the avtar utility.

checkPointOverdueHours Generate a system event if checkpoint does not occur within this
number of hours. The default setting is 24.

client_msgs_maint_params Optional parameters to send with an avmaint getclientmsgs

command.

client_msgs_max_count Maximum number of entries in the activity monitor table. The

default setting is 500.

client_msgs_max_secs Length of time in seconds to retain completed activities. The

client_msgs_max_count setting has precedence over this setting.
The default setting is 86400 seconds (24 hours).

CommandRetryCount When executing an avmaint or avmgr command, this is the

maximum number of successive failed attempts that are allowed
before the command is no longer attempted.

datacenterlist_schema EMC internal use only. Do not edit.

Specifies the location of the internal file used to implement
validation of avmaint XML output using specific schema
documents.
The default setting is lib/avmaint_datacenterlist.xsd.

dbmaint_path Fully qualified path of dbmaint.sh.

mcserver.xml 497
EMC CONFIDENTIAL
Important Files

Table 387 com.avamar.mc.dpn settings (page 2 of 4)

Element Description

diskfull Specifies a percentage of maximum server storage capacity, that

when exceeded, generates event code 22416:
The Avamar server storage has exceeded maximum + operating
capacity.
The default setting is 30%.

diskwarning Specifies a percentage of maximum server storage capacity that,

when exceeded, generates event code 22415:
The Avamar server storage is more than %d + percent full.
The default setting is 80%.

dpnCommandFailureLimit When requesting server monitor information from the Avamar

server, this is the maximum number of successive failed attempts
that are allowed before the Avamar server status is set to inactive.

dpnxslfile Relative path to the XSLT file for translating the avmaint nodelist
output to internal document format necessary for proper Avamar
server status display.

errlog_maint_params Optional parameters to send with an avmaint geterrors command.

feedcheck_internal_sec Number of seconds between feedcheck calls. The default setting is

60 seconds.

feedcheck_params EMC internal use only. Do not edit.

Parameters passed to feedcheck. The default settings are:
--conntimeout=20 --timeout=25
--vardir=/usr/local/avamar/var

feedcheck_path EMC internal use only. Do not edit.

feedstart_params EMC internal use only. Do not edit.

Parameters passed to feedstart. The default setting is
--maxparallelfiles=200.

feedstartPath EMC internal use only. Do not edit.

flush_cacheflag Set to --nocache if caching should not be used on flush from MCS.

flush_dir Root directory for the avtar backup (flush).

flush_exclude_subdirs Comma-separated list of MCS directories that should not be

included in MCS flushes.

flush_interval_min Number of minutes between flush calls to avtar (required). To

disable this setting and prevent automatic flushes, set this value
to zero. The default setting is 60.

flush_logfile Optional log file for flushes. If not specified, no log is produced.

flush_method One of the following:

• pg-dump—Dump the database, and then backup the dump
files.
• file system—Back up the operating system data files.
The default setting is pg-dump.

flush_path avmgr path where flush backups are stored (optional). If not
specified, then the default is /MC_BACKUPS.

flush_senddataflag EMC internal use only. Do not edit.

498 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 387 com.avamar.mc.dpn settings (page 3 of 4)

Element Description

flushOverdueMinutes Generate a system event if an MCS flush does not occur within this
number of hours. The default setting is 120.

geterrors_schema EMC internal use only. Do not edit.

Specifies the location of internal file used to implement validation
of avmaint XML output using specific schema documents.
The default setting is lib/avmaint_geterrors.xsd.

hfsCheckOverdueHours Generate a system event if a daily system integrity check does not
occur within this number of hours. The default setting is 48.

local_flush_dir EMC internal use only. Do not edit.

Specifies the directory where local MCS flushes are stored. This
directory is located under the directory specified by
com.avamar.mc.mcsvars.baseDir. The default setting is
/usr/local/avamar/var/mc/server_flush.

local_flush_filename_base EMC internal use only. Do not edit.

Specifies the base filename for local MCS flushes. This base
filename has the date and time appended to it. The default
filename is mcflush.

local_flush_retention_count Specifies the maximum number of local MCS flush files that are
retained. A setting of zero (0) disables local MCS flushes. The
default number of local MCS flush files to retain is 5.

log_results_len EMC internal use only. Do not edit. The default setting is 100.

lscp_interval_sec Interval in seconds between successive avmaint lscp commands.

move_to_last_client_msg If true, then when the MCS restarts, it ignores any Avamar client
messages sent before the MCS restart. The default setting is false.

move_to_last_error If true, then when the MCS restarts, it ignores any Avamar server
error messages sent before the MCS restart. The default setting is
false.

nodelist_interval_sec Interval in seconds between successive avmaint nodelist

commands.

nodelist_maint_params Optional parameters to send with an

avmaint nodelist command.

nodelist_schema EMC internal use only. Do not edit.

Specifies the location of the internal file used to implement
validation of avmaint XML output using specific schema
documents.
The default setting is lib/avmaint_nodelist.xsd.

pollerRestartMinutes EMC internal use only. Do not edit.

This element added in version 4.0.

retain_checkpoints Specifies the minimum number of checkpoints to retain in the

system. Avamar Administrator does not allow a user to delete a
validated checkpoint if that delete operation would cause the total
number of retained validated checkpoints to fall below this
threshold. The default setting is 1.

schedstatus_interval_sec EMC internal use only. Do not edit.

This element added in version 5.0.

session_interval_sec Interval in seconds between avmaint sessions commands.

mcserver.xml 499
EMC CONFIDENTIAL
Important Files

Table 387 com.avamar.mc.dpn settings (page 4 of 4)

Element Description

session_maint_params Optional parameters to send with an avmaint sessions command.

sessions_schema EMC internal use only. Do not edit.

Specifies the location of the internal file used to implement
validation of avmaint XML output using specific schema
documents.
The default setting is lib/avmaint_sessions.xsd.

vardirFlag Fully qualified path for var directory required by avtar.

com.avamar.mc.dpn.users
The following table describes the settings for the Avamar client user account used by the
MCS, which are set in com.avamar.mc.dpn.users.

Table 388 com.avamar.mc.dpn.users settings

Element Description

administratorID Primary Avamar administration user account.

administratorAP Password for the administrator user account.

backuponlyID User account reserved for performing on-demand backups initiated from
Avamar Administrator clients.

backuponlyAP Password for the backuponlyID user account.

MCUSERID User account that MCS should use for most activities.

MCUSERAP MCUSER user account password.

restoreonlyID User account reserved for performing on-demand restores initiated from
Avamar Administrator clients.

restoreonlyAP Password for the restoreonly user account.

rootAP Password for the root user account.

com.avamar.mc.dtlt
The following table describes the settings for Avamar Desktop/Laptop used by the MCS,
which are set in com.avamar.mc.dtlt.
This entire node added in version 7.0.

Table 389 com.avamar.mc.dtlt settings

Element Description

expire_data_after_secs Sets the period of validity for the secure token used in Avamar
Desktop/Laptop web browser authentication. The HTTPS session must
start within that period. Otherwise a new session, with a new secure
token, must be instantiated.
The default value is 20 seconds.

500 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

com.avamar.mc.event
The following table describes the MCS event service settings in com.avamar.mc.event.

Table 390 com.avamar.mc.event settings (page 1 of 2)

Element Description

connectemc_throttle_duration Used with connectemc_throttle_repeat_count and

connectemc_throttle_trigger_duration to control
ConnectEMC event throttling.
This setting specifies an event throtting windows in
seconds during which identical event codes are
evaluated for possible throttling (that is, thinning, so that
ConnectEMC email messages efficiently communicate
server status without needlessly repeating event codes).
The default setting is 86400 seconds (24 hours=1 day).
This element added in version 5.0.

connectemc_throttle_repeat_count Used with connectemc_throttle_duration and

connectemc_throttle_trigger_duration to control
ConnectEMC event throttling.
This setting specifies the maximum number of identical
event codes that are passed to ConnectEMC during the
specified throttling duration.
The default setting is 1 event.
This element added in version 5.0.

connectemc_throttle_trigger_duration Used with connectemc_throttle_duration and

connectemc_throttle_repeat_count to control
ConnectEMC event throttling.
This setting specifies an initial trigger duration (in
seconds).
The default setting is 86400 seconds (24 hours=1 day),
which is identical to the connectemc_throttle_duration
setting. However, if you set this to a shorter duration,
then multiple identical events must be detected during
this initial trigger duration for a throttling window to be
enabled.
This element added in version 5.0.

email_query_limit Restricts the number of event descriptions sent in the

custom event profile email notification.
The default setting is 1000. If there are more events than
this, then the following warning is included in the email:
WARNING: Only displaying 1000 of N events.
where N is the total number of events that exist.

ems_audit_security_login_interval Interval in minutes at which EMS login events are

published. The default setting is 10 minutes.
This element added in version 4.0.

eventCatalogPath Location of the XML definitions for the event catalogs. The
path is relative to the MCS install directory.

EventHandler.LogHandler EMC internal use only. Do not edit.

EventHandler.ProfileHandler EMC internal use only. Do not edit.

syslog_hostname EMC internal use only. Do not edit.

syslog_port EMC internal use only. Do not edit.

throttle_duration Duration in seconds for event throttling.

mcserver.xml 501
EMC CONFIDENTIAL
Important Files

Table 390 com.avamar.mc.event settings (page 2 of 2)

Element Description

throttle_repeat_count Number of events that must occur before event throttling

begins.

throttle_trigger_duration Duration in seconds during which identical events must

occur before event throttling begins.

use_event_pending_table If true, then all events are logged in a pending table until
processed. Mainly used for debugging to determine if
events are processed properly. The default setting is
false.

com.avamar.mc.ldap
The following table describes the enterprise authentication settings in com.avamar.mc.ldap.
This entire node added in version 6.1

Table 391 com.avamar.mc.ldap settings

Element Description

enable_new_user_authentication_selection If true, the enterprise authentication feature is

enabled. The EMC Avamar Administration Guide
provides details.
The default setting is false.

ldap_services_timeout_seconds Specifies the timeout setting for connections with

the KDC, in seconds.
The default setting is 300.

com.avamar.mc.lm
The following table describes the license manager settings in com.avamar.mc.lm.

Table 392 com.avamar.mc.lm settings

Element Description

license_buffer_pct EMC internal use only. Do not edit.

license_period_day EMC internal use only. Do not edit.

license_warn_interval_sec Interval in seconds at which license expiration warnings are

issued. The default setting is 86400 seconds (24 hours).
This element added in version 4.1.

license_will_expire_warn_days Number of days until the license expires after which warnings
are issued. The default setting is 10 days.
This element added in version 4.1.

lmoc EMC internal use only. Do not edit.

Enables or disables license manager quota check. The default
setting is true (perform the quota check).

502 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

com.avamar.mc.mcsdk
The following table describes the management console Software Development Kit (SDK)
settings in com.avamar.mc.mcsdk. This entire node added in version 6.0.

Table 393 com.avamar.mc.mcsdk settings

Element Description

axis_home Location relative to the Avamar installation directory where the packaged web
applications for apache axis2 and MCS web services components are
installed. The default location is lib/axis2.war.

sdk_protocol Specifies whether to use secure (https) or unsecured (http) web protocol. The
default setting is secure (https).

sdk_port Specifies the data port for web services communication. The default setting is
data port 9443.

trust_keystore Location relative to the Avamar installation directory of the key store file. The
default key store file is lib/rmi_ssi_keystore.
Deprecated in 6.0 Service Pack 1.

trust_keystore_ap Key store password.

Deprecated in 6.0 in favor of the rmi_ssl_keytore_ap parameter.

com.avamar.mc.mcsm
The following table describes the MCS manager settings in com.avamar.mc.mcsm.

Table 394 com.avamar.mc.mcsm settings (page 1 of 2)

Element Description

capForecastDataDays Future time period in days for which capacity is forecast. The default
setting is 30 days.
This element added in version 4.1.

capForecastDataMinDays Specifies the minimum amount of historical data, measured in

days, that must be available to forecast capacity usage. The default
setting is 14 days.
This element added in version 4.1.

capForecastReachedDays Specifies the number of days before capReachedPercentage

capacity is reached that capacity alerts should begin to be sent. The
default setting is 30 days.
This element added in version 4.1.

capMonitorIntervalMin Specifies how often the MCS checks server capacity to determine if
capReachedPercentage capacity is likely to be reached within the
period specified by capForecastDataDays. The default setting is 1
day (that is, once daily).
This element added in version 4.1.

capReachedPercentage Specifies the percentage of total server storage capacity, that, when
reached, begins generating capacity alerts. The default setting is
95%.
This element added in version 4.1.

hcDelayIntervalMin After the first health check limit warning is acknowledged, this
setting specifies the time period in which subsequent health check
limit warnings are suppressed. The default setting is 90 days.
This element added in version 4.1.

mcserver.xml 503
EMC CONFIDENTIAL
Important Files

Table 394 com.avamar.mc.mcsm settings (page 2 of 2)

Element Description

hcMonitorIntervalMin Specifies how often the MCS performs a server health check. The
default setting is 1 day (that is, once daily).
This element added in version 4.1.

hcOffsetROPercentage Specifies the percentage that, when subtracted from the server
read-only limit, is still considered to be acceptable capacity. The
default setting is 5% (that is 95% of server read-only limit).
This element added in version 4.1.

hcReminderIntervalMin Specifies how often the MCS issues capacity alerts once
capReachedPercentage has been reached. Alerts continue until the
health check event has been acknowledged. The default setting is
60 minutes.
This element added in version 4.1.

staleBytesProtectedMinutes EMC internal use only. Do not edit.

Sets the time in minutes after which the bytes protected valued
cached by the MCS is assumed to be stale. The default setting is 30
minutes.

com.avamar.mc.mcsvars
The following table describes the MCS program directory and file locations in
com.avamar.mc.mcsvars.

Table 395 com.avamar.mc.mcsvars settings (page 1 of 2)

Element Description

baseDir EMC internal use only. Do not edit.

The default setting is /usr/local/avamar. Other mcsvars settings are relative to
this baseDir location.

binDir EMC internal use only. Do not edit.

The default setting is bin. This location is relative to the baseDir location.

dataDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data. This location is relative to the
baseDir location.

dbDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data/postgres/data. This location is
relative to the baseDir location.

dumpFile EMC internal use only. Do not edit.

The default setting is var/mc/server_data/mcs_data_dump.sql. This location
is relative to the baseDir location.

etcDir EMC internal use only. Do not edit.

The default setting is etc. This location is relative to the baseDir location.

health_checkFile EMC internal use only. Do not edit.

Beginning with version 6.0, this setting has been deprecated.

libDir EMC internal use only. Do not edit.

The default setting is lib. This location is relative to the baseDir location.

504 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 395 com.avamar.mc.mcsvars settings (page 2 of 2)

Element Description

logDir EMC internal use only. Do not edit.

The default setting is var/mc/server_log. This location is relative to the baseDir
location.

mcDir EMC internal use only. Do not edit.

The default setting is var/mc. This location is relative to the baseDir location.

postgresDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data/postgres. This location is relative to
the baseDir location.

prefsDir EMC internal use only. Do not edit.

The default setting is var/mc/server_data/prefs. This location is relative to the
baseDir location.

sqlDir EMC internal use only. Do not edit.

The default setting is lib/sql. This location is relative to the baseDir location.

upgradeDir EMC internal use only. Do not edit.

The default setting is lib/upgrade. This location is relative to the baseDir
location.

varDir EMC internal use only. Do not edit.

The default setting is var. This location is relative to the baseDir location.

com.avamar.mc.mon
The following table describes the MCS monitoring settings in com.avamar.mc.mon.

Table 396 com.avamar.mc.mon settings (page 1 of 3)

Element Description

adaFailEventIntervalMinutes Interval in minutes at which to publish a warning event if

the ADA service is not running.
This element added in version 4.1.

adaInterval Interval in seconds at which the status of the ADA service

is checked.
This element added in version 4.1.

adaMonitorCommand Specifies the command used to monitor the ADA service.

This element added in version 4.1.

adaMonitorTimeout Sets the ADA monitor timeout value that determines how
long to allow the adaMonitorCommand to run before
terminating.
This element added in version 4.1.

connectemcFailEventIntervalMinutes Interval in minutes at which event 22716 is published if

ConnectEMC is not running.
The default setting is 120 minutes (2 hours).
This element added in version 5.0.

connectemcInterval Interval in seconds at which the status of ConnectEMC is

monitored.
The default setting is 60 seconds (1 minute).
This element added in version 5.0.

mcserver.xml 505
EMC CONFIDENTIAL
Important Files

Table 396 com.avamar.mc.mon settings (page 2 of 3)

Element Description

connectemcMonitorEnabled If true, monitoring of ConnectEMC is enabled.

The default setting is true.
This element added in version 5.0.

connectemcSuspendHoursError Number of hours that ConnectEMC can be suspended

before error event 22717 is published.
The default setting is 24 hours.
This element added in version 5.0.

consoleInactiveMinutesToReport Inactivity timeout setting for Avamar Administrator, in

minutes. The default setting is -1, indicating no timeout.
Activity is defined as any mouse or keyboard interaction
with the Avamar Administrator UI.

copyScript Full path to the copyScriptToNode.pl script. The default

setting is /usr/local/avamar/bin/copyScriptToNode.pl.

ddrSnmpFailEventIntervalMinutes Time interval for publishing failed events for the ddr snmp
service. The default setting is 2 minutes (120 seconds).
This element added in version 6.0.

ddrSnmpInterval Time interval for checking status for the ddr snmp service.
The default setting is 60 seconds.
This element added in version 6.0.

ddrSnmpdMonitorTimeout Timeout setting for the ddr snmp service monitor

command. The default setting is 5 minutes (300 seconds).
This element added in version 6.0.

dhcpdFailEventIntervalMinutes Minimum interval in minutes at which the dhcp process

failure event is published. The default setting is 60.

dhcpdInterval Interval in seconds at which the dhcp process is

monitored. The default setting is 300.

discoverServiceLocationsScript Full path to the discoverServiceLocations.pl script. The

default setting is
/usr/local/avamar/bin/discoverServiceLocations.pl.

diskSpaceInterval Interval in seconds at which the web restore hard drive

space is monitored. The default setting is 300.

diskSpaceScript Full path to the monitorWebDiskSpace.pl script. The

default setting is
/usr/local/avamar/bin/monitorWebDiskSpace.pl.

httpdFailEventIntervalMinutes Minimum interval in minutes at which the web services

failure event is published. The default setting is 60.

lmFailEventIntervalMinutes Minimum interval in minutes at which the Login Manager

failure event is published. The default setting is 60.

loadAverageInterval Interval in seconds at which the load average on the utility

node is monitored. The default setting is 60.

loginManagerInterval Interval in seconds at which the login manager is

monitored. The default setting is 60.

metadata_cronInterval Interval in seconds at which the metadata_cron job is

monitored. The default setting is 60.

506 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 396 com.avamar.mc.mon settings (page 3 of 3)

Element Description

monitorCronScript Full path to the monitorCron.pl script. The default setting is

/usr/local/avamar/bin/monitorCron.pl.

pingFailEventIntervalMinutes Minimum interval in minutes at which the ping failure

event is published. The default setting is 10.

pingTimeInterval Interval in seconds at which the utility node is pinged. The

default setting is 60.

postgresFailEventIntervalMinutes Interval in minutes between publishing a database failure

event if there is an error with the postgres database. The
default setting is 60.

postgresInterval Interval in seconds between monitoring the postgres

database. The default setting is 60.

rediscoverIntervalMinutes Interval in minutes at which the MCS attempts to query the

dpn configuration to see what services are configured to
run on the utility node. The default setting is 60.

repl_cron_enabled Controls whether replication operations should be

monitored.
If true, then daily replication operations are expected, and
absence of them is considered an error.
If false, then daily replication operations are not expected,
and absence of them is not considered an error.
Beginning with version 7.0, this setting has been
deprecated.

repl_cron_monitored Controls whether to monitor replication activities.

If true or /usr/local/avamar/etc/repl_cron.cfg exists, then
replication activities are monitored by this MCS.
If false and /usr/local/avamar/etc/repl_cron.cfg does not
exist, then replication activities are not monitored by this
MCS.

repl_cronInterval Interval in seconds at which the repl_cron job is

monitored. The default setting is 60.
Beginning with version 7.0, this setting has been
deprecated.

sshdFailEventIntervalMinutes Interval in minutes between publishing an ssh process

failure event if there is an error with the ssh process. The
default setting is 60.

sshdInterval Interval in seconds between monitoring the ssh process.

The default setting is 60.

sshWrapperScript Full path to the mcs_ssh_wrapper script. The default

setting is /usr/local/avamar/bin/mcs_ssh_wrapper.

webServicesInterval Interval in seconds at which the web services are

monitored. The default setting is 120.

webServicesScript Full path to the monitorWebServices.pl script. The default

setting is /usr/local/avamar/bin/monitorWebServices.pl.

xntpdFailEventIntervalMinutes Minimum interval in minutes at which the ntp process

failure event is published. The default setting is 60.

xntpdInterval Interval in seconds at which the ntp process is monitored.

The default setting is 300.

mcserver.xml 507
EMC CONFIDENTIAL
Important Files

com.avamar.mc.repl
The following table describes the Avamar policy-based replication settings in
com.avamar.mc.repl. This entire node added in version 7.0.

Table 397 com.avamar.mc.repl settings

Element Description

internal_accounts Specifies internal accounts that must always be replicated.

Default setting is AVI_BACKUPS, EM_BACKUPS, MC_BACKUPS,
MC_RETIRED, EBR_BACKUPS.

num_members_per_workorder Specifies the number of members allowed per work order. Valid
entries are positive integers and -1, which includes all members
in the group (that is, does not limit the number of members per
work order). The default setting is -1.

repl_adhoc_priority Specifies job priority when the replication job is first added to
job queue. Valid entries must are 0—5000. Higher numbers are
assigned higher priority. The default setting is 5000.

repl_enabled If true, policy-based replication is enabled. Default setting is

true.

repl_sched_priority Specifies job priority when the replication job is first added to
job queue. Valid entries must are 0—5000. Higher numbers are
assigned higher priority. The default setting is 0.

repl_window_hours Specifies an operational window for performing the replication.

Once the window is exceeded, the replication operation times
out. The default setting is 24 hours.

secured_port_offset When encryption is enabled, this offset is added to the base

client-server data port in order to facilitate connections
through fire walls. The default offset is 2000.

com.avamar.mc.rpt
The following table describes the Avamar reports settings in com.avamar.mc.rpt.

Table 398 com.avamar.mc.rpt settings

Element Description

ddr_nodes_insert_interval_sec Time interval for inserting Data Domain system data to

mcdb.ddr_node_space. The default setting is 10 minutes (600
seconds).
This element added in version 6.0.

nodelist_insert_interval_sec EMC internal use only. Do not edit.

508 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

com.avamar.mc.security
The following table describes security settings in com.avamar.mc.security. This node
added in version 7.1.

Table 399 com.avamar.mc.security settings

Element Description

login_failed_attempts Sets the maximum number of failed Avamar Administrator

login attempts. Once this number is exceeded, that user will
be prevented from logging in to Avamar Administrator for the
period of time specified by the
max_login_failed_delay_minutes setting. Default setting is 5
failed attempts.

max_login_failed_delay_minutes Sets the period of time a user must wait, after failing to log in
to Avamar Administrator, before they will be allowed to try
logging in again. Default setting is 5 minutes.

com.avamar.mc.um
The following table describes the user manager settings in com.avamar.mc.um.

Table 400 com.avamar.mc.um settings

Element Description

admin_can_direct_restores If true, then domain administrators can perform directed

restores.

restore_admin_can_direct_restores If true, then domain restore (read) only operators can

perform directed restores.

com.avamar.mc.vmware
The following table describes the VMware settings in com.avamar.mc.vmware. This node
added in version 5.0.

Table 401 com.avamar.mc.vmware settings (page 1 of 2)

Element Description

auto_sync_cache_before_backup_window_mins Controls when automatic caching of vCenter

information occurs. Default setting is 60
minutes before the backup window.
This element added in version 7.0.

connection_pool_size EMC internal use only. Do not edit.

container_recursion_protection_enabled EMC internal use only. Do not edit.

esx_protection_disabled If true, then standalone ESX hosts can be

added as vCenter clients. Default setting is
false.

eventsmonitor_check_frequency_millis EMC internal use only. Do not edit.

ignore_vc_cert If true, then this setting disables certificate

authentication when MCS communicates with
vCenter. The default setting is false.

mcserver.xml 509
EMC CONFIDENTIAL
Important Files

Table 401 com.avamar.mc.vmware settings (page 2 of 2)

Element Description

max_number_of_vcenters Sets the maximum number of vCenters that

can be added to this MCS. The default setting
is 5, which is the maximum number of
vCenters that can be supported by any single
MCS.
This element added in version 6.0.

maxVmFileSize_kb EMC internal use only. Do not edit.

multi-tenancy If true, MCS is aware that the vCenter is being

shared by multiple tenants. Default setting is
false.
This element added in version 7.1.

optimize_cache_initiation EMC internal use only. Do not edit.

proxy_selection_algorithm Controls the algorithm used to intelligently

select proxies for backup and restore
operations. Valid values are:
• ignore_associated_datastores—MCS
ignores Datastores associated with the
proxy plug-in and distributes work orders
across all avagents.
• hot_add_only— MCS only selects proxies
with hot-add capabilities.
• hot_add_preferred—MCS intelligently
selects proxies based on hot-add
capabilities. If no available proxy can
perform hot-add backups, then the MCS
will use proxies with network based backup
capabilities. This is the default setting.
This element added in version 7.1.

recycle_proxies_at_mcs_startup EMC internal use only. Do not edit.

vc_initiation_time_out_mins EMC internal use only. Do not edit.

vc_poll_frequency EMC internal use only. Do not edit.

vcd_vapp_support_enabled_for_mcgui EMC internal use only. Do not edit.

vmware_enabled EMC internal use only. Do not edit.

com.avamar.mc.wo
The following table describes the MCS scheduler settings in com.avamar.mc.wo.

Table 402 com.avamar.mc.wo settings (page 1 of 3)

Element Description

backup_window_increment Increment used to adjust the priority of a job using

the backup window priority strategy.

backup_window_num_periods Breaks the job backup window into N periods. At

the end of each period, the priority of the job is
increased by the value of
backup_window_increment.

510 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 402 com.avamar.mc.wo settings (page 2 of 3)

Element Description

cancel_extended_window_min Sets the extended cancel timeout value. The default

setting is 15 minutes.
This element added in version 4.0.

cancel_normal_window_min Sets the normal cancel timeout value. The default

setting is 5 minutes.
This element added in version 4.0.

completed_job_retention_hours Number of hours to save completed jobs in the

completed queue for easy viewing in the activity
monitor. The default setting is 24 hours.

emit_cacheprefix_for_datasets If true, then a cache prefix is added to work order

numbers. This default setting is false.
This element added in version 4.1.

enforce_backup_window If true, then a job cannot start or run outside of its

specified backup window.

enforce_max_backup_label_len If true, then backup labels are truncated to a

maximum of 48 characters. The default setting is
true.
This element added in version 4.1.1.

green_list_update_sec Interval in seconds between building the list of jobs

that are cleared to run.

gsan_only_maxconn Sets the maximum number of simultaneous storage

server (GSAN) connections.
EMC internal use only. Do not edit.
This element added in version 7.1.

max_completed_job_retention_entries Number of completed jobs in the completed queue

to retain for easy viewing in the activity monitor.

max_concurrent_jobs Maximum number of concurrent jobs for the entire

system.
The default setting is 250. This setting is correct for
a base (2x7) multi-node Avamar system. It is
derived by multiplying the maximum number of jobs
allowed per node (typically 20, as defined by
max_jobs_per_node) by the number of storage
nodes in each module (there are seven storage
nodes in a base multi-node Avamar system).

max_green_list_iter Number of times the green list is built so that a job

can stay on the list without being started (if bumped
off, it must wait until it is rescheduled later in the
backup window).

max_jobs_per_node Maximum number of concurrent jobs that a single

storage node is allowed to process.
The default setting is 80 jobs per node.

max_jobs_per_proxy Specifies the maximum number of backup and

restore jobs each proxy can simultaneously process.
The default setting is 8.
This element added in version 7.1.

no_work_response_sec Number of seconds to send to the client agent to

wait before checking for work.

mcserver.xml 511
EMC CONFIDENTIAL
Important Files

Table 402 com.avamar.mc.wo settings (page 3 of 3)

Element Description

percent_of_max_concurrent_jobs Maximum percentage of max_concurrent_jobs

capacity that should be used by the system.
The default setting is 90.
For example, applying the default setting of 90% to
the max_concurrent_jobs setting yields an actual
system capacity of 126 concurrent jobs allowed by
the system.

percent_of_max_concurrent_jobs_hfscheck EMC internal use only. Do not edit.

Maximum percentage of max_concurrent_jobs
capacity that should be used by the system during
checkpoint validations (HFS checks).
The default setting is 10.

priority_aging_delay_sec Number of seconds between incrementing the

priority for a job if using the priority aging
scheduling strategy.

replicator_no_work_sleep EMC internal use only. Do not edit.

report_disabled_client_job_as_fail If a client is disabled, but is still in an active backup

group, this setting controls whether the
unsuccessful backup for that client will be reported
as a failed backup, or skipped and not reported at
all. The default setting is true.
This element added in version 7.1.

use_backup_window_priority Scheduling strategy that increases the priority of a

job as the end of its backup window approaches.

use_client_mcsaddr_as_hfsaddr EMC internal use only. Do not edit.

use_priority_aging Simple scheduling strategy to increment a job's

priority every priority_aging_delay_sec.

userinfo_fetch_enable EMC internal use only. Do not edit.

vcb_proxy_no_work_sleep Number of seconds MCS will tell the proxy to sleep

when the proxy checks in and MCS has no work to
dispatch to it. The default setting is 15 seconds.
This element added in version 7.1.

mktime.custom
The mktime.custom file is an output file created by the asktime utility. This file is a
customized script used to produce localized ntpd configuration files.

mktime.out
The mktime.out file is an output file created by the mktime utility.

ntp.conf*
The ntp.conf* file is an output file created by the mktime utility.

512 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

probe.out
The probe.out file is generated by the probe utility. The probe utility verifies the IP
addresses assigned to each node by way of DHCP. Other Avamar utilities use probe.out to
resolve simple MODULE.NODE designations to IP addresses.



In Avamar 5.0 and later, the probe.xml file replaces the probe.out file.

The SYSPROBEDIR environment variable points to where probe.out is located. The default
location is /usr/local/avamar/var.
The probe.out file is not correctly generated if any of the utility or storage nodes are not
functioning correctly. When a probe.out file is created, it does not need to be changed
until you add or remove nodes on the Avamar server.

Reading a probe.out file

The first line of a probe.out file is always either NAT or NONAT. It specifies whether
addresses are using Network Address Translation (NAT) or not (NONAT).



Avamar no longer uses Network Address Translation (NAT) in the probe.out file. The
probe.xml file supports both (NAT) and multiple network interfaces.

This is a typical probe.out file:

NONAT
dpn52:10.0.52.5:10.0.52.10,10.0.52.11,10.0.52.13,10.0.52.14,10.0.52.16
dpn53:10.0.53.5:10.0.53.10,10.0.53.11,10.0.53.12,10.0.53.13,10.0.53.15

Beginning on the second line, there is one line for each module in the system. Module 0 is
listed on the second line, module 1 on the third line.
The format of each line is:
MODULE-NAME:UTILITY_NODE_IP:NODE_0_IP,...,NODE_N_IP

where MODULE-NAME is both the name of the module and DNS hostname of the utility
node for that module, and UTILITY_NODE_IP is the IP address of the utility node in the
module. The remaining entries are a comma-delimited list of storage node IP addresses in
that module.

Parsing and naming

Utilities that use the probe.out file parse each line and assign simplified MODULE.NODE
names to each of these IP addresses.
Utility nodes are designated by MODULE.s. The administrator node is designated by
MODULE.m (deprecated). Storage nodes are assigned numerical suffixes beginning with
MODULE.0 and continuing until all storage nodes are assigned a numerical suffix
(MODULE.n).
Utilities can then accept simplified MODULE.NODE values as inputs.

probe.out 513
EMC CONFIDENTIAL
Important Files

Physical versus logical node numbers

Two different sets of node numbers are used within the system:
◆ Physical
◆ Logical
MODULE.NODE designations generated by probe are physical because the ordering is
always according to IP address. If a storage node is removed from a multi-node server,
then the physical node numbers of all of the nodes with larger IP addresses in that module
decrease by one. Logical MODULE.NODE designations generated by the Avamar server are
assigned when the storage nodes are first powered up during system configuration and do
not change, even if the IP address of the node or of other nodes in the module change.
When an Avamar server is first placed in service, physical and logical node numbers
match. However, over the life of the system, nodes might be added and decommissioned
for various reasons. When this happens, physical and logical node numbers might get
out-of-sync.
The nodenumbers utility addresses this situation by comparing the physical node
numbers generated by parsing probe.out to the output of the avmaint nodelist command.
The output of nodenumbers is a table that correlates the physical and logical node
designations.
This sample nodenumbers output shows several nodes with out-of-sync physical and
logical node designations:
Nodenumbers Utility [v1.0] Mon Nov 18 11:11:42 PST 2013
Using /usr/local/avamar/var/probe.out on dpn22s.local.avamar.com
(10.0.22.5)
Writing /usr/local/avamar/var/nodenumbers.out
Running 'avmaint nodelist'.
HFSCreateTime=1034706694

DPN probe.out
Logical Node Physical Node IP Address
0.0 0.0 10.0.22.10
0.1 0.1 10.0.22.11
0.3 < 0.2 10.0.22.13 < OUT OF ORDER
0.4 0.3 10.0.22.14
0.6 < 0.4 10.0.22.16 < OUT OF ORDER

1.1 1.1 10.0.23.11

1.2 1.2 10.0.23.12
1.3 1.3 10.0.23.13
1.5 < 1.4 10.0.23.15 < OUT OF ORDER
1.7 < 1.0 < 10.0.23.10 < OUT OF ORDER

Output from nodenumbers is sorted by logical node designations. Physical node numbers
range from 0 to 4 because there are five storage nodes per module. Logical node numbers
would initially have been the same, but as nodes were added and decommissioned, new
logical node numbers are added, and there are holes where nodes were decommissioned.
Consider what might have happened with module 0 in the listing above to get the logical
and physical node numbers listed. We started with nodes 0.0 to 0.4 with IP addresses
10.0.22.10-14, respectively. Logical node 0.2 fails, and is replaced with logical node 0.5
with IP address 10.0.22.15. With the hole created by the loss of logical node 0.2, logical
node 0.3 becomes physical node 0.2, logical node 0.4 becomes physical node 0.3, and

514 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

the new logical node 0.5 is physical node 0.4. Then logical node 0.5 fails because of a bad
CPU fan, and is replaced with logical node 0.6 with IP address 10.0.22.16, which is
physical node 0.4.
Many programs either display node numbers, or accept node numbers as input. The
following table shows commands with the numbering scheme each displays or accepts as
input.

Table 403 Numbering schemes for utilities

Program or utility Physical numbering Logical numbering

Avamar Administrator Server Monitor x

avmaint utility x

check.dpn utility x

gsan.log file x

mapall utility x

nodenumbers utility x x

restart.dpn utility x

scn utility x

ssn utility x

start.dpn utility x

start.nodes utility x

Manually creating a probe.out file

This topic describes the proper structure for a manually created a probe.out file. Manually
creating a probe.out file is typically done to support static IP server environments.

Single-node server
Example probe.out listing:
NONAT
avamar-1:10.0.254.82,10.0.254.82:10.0.254.82

Line 1: NONAT is required. This is the only supported configuration at this time.
Line 2: Three parts, each part separated by a colon (:):
Part 1: Server name (avamar-1 in this example).
Part 2: Utility node IP address and utility node IP address (both 10.0.254.82 in this
example), separated by a comma (,).
Part 3: Server IP address again (10.0.254.82 in this example).

probe.out 515
EMC CONFIDENTIAL
Important Files

1xn multi-node server

Example probe.out listing:
NONAT
avamar-1:10.0.5.5,10.0.5.5:10.0.5.10,10.0.5.11,10.0.5.12

Line 1: NONAT is required. This is the only supported configuration at this time.
Line 2: Three parts, each part separated by a colon (:):
Part 1: Server name (avamar-1 in this example, often axion01 or similar).
Part 2: Utility node IP address and utility node IP address (10.0.5.5 in both cases),
separated by a comma (,).
Part 3: Storage node IP address list (10.0.5.10 through 10.0.5.12 in this example),
starting with physical node 0.0, each address separated by a comma (,).

2xn multi-node server

Example probe.out listing:
NONAT
avamar-1:10.0.5.5,10.0.5.5:10.0.5.10,10.0.5.11,10.0.5.12
avamar-2:10.0.6.5:10.0.6.10,10.0.6.11,10.0.6.12

Line 1: NONAT is required. This is the only supported configuration at this time.
Line 2: Three parts, each part separated by a colon (:):
Part 1: Module-0 ID (avamar-1 in this example).
Part 2: Module-0 utility node (0.s) IP address and utility node (0.m) IP address
(10.0.5.5 in both cases).
Part 3: Module 0 storage node IP address list (10.0.5.10 through 10.0.5.12 in this
example), starting with physical node 0.0, each address separated by a comma (,).
Line 3: Three parts, each part separated by a colon (:):
Part 1: Module-1 ID (avamar-2 in this example).
Part 2: Module-1 utility node (1.s) IP address (10.0.6.5 in this example). Note that
there is no MCS listed in module-1. There can only be one MCS per system.
Part 3: Module-1 storage node IP address list (10.0.6.10 through 10.0.6.12 in this
example), starting with physical node 1.0, each address separated by a comma (,).

516 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

probe.xml
The probe.xml file is a node resource database file generated either automatically by
using the nodedb utility or manually by using a text editor. The probe.xml file adheres to
the XML Document Object Model (DOM) conventions.
In Avamar 5.0 and later, the probe.xml file replaces the probe.out file. The probe.xml file,
like probe.out, stores the types and IP addresses of Avamar server nodes. In addition, the
probe.xml file supports both the Network Address Translation (NAT) and multiple network
interfaces.
The probe.xml file must have the following permissions (644):
◆ owner: read and write
◆ group: read
◆ others: read
The probe.xml file can co-exist with probe.out. During a server upgrade to Avamar 5.0 or
later, the upgrade process automatically creates the probe.xml file by using information
from the probe.out file. The convert-probe program also creates a probe.xml file by using
the probe.out file.
Utility node or single-node server processes can access the probe.xml file even if the
Avamar server subsystems are not running.

Elements and attributes used by the probe.xml file

The following table describes elements used by the probe.xml file. The “/” (slash) denotes
nesting.

Table 404 Elements used by the probe.xml file (page 1 of 2)

Element Description

dpn Top-level element.

dpn/module Second-level element. Specify one module element per Avamar

system.

dpn/module/node Third-level element. Specify one or more nodes per module.

dpn/module/node/ Fourth-level element. Specify one or more network-interface

network-interface elements per node. The network-interface element includes
attributes for the network interface.

dpn/module/node/ (Optional) Fifth-level element. Specify the types of functions

network-interface/uses allowed or denied by the network interface.

probe.xml 517
EMC CONFIDENTIAL
Important Files

Table 404 Elements used by the probe.xml file (page 2 of 2)

Element Description

dpn/module/node/ Fifth-level element. Specify at least one address element as a

network-interface/address child of a network-interface element.
The address element is a “real” (untranslated) address bound to
a local network interface such as eth0.

dpn/module/node/ Fifth-level element. Specify one or more externally translated

network-interface/nat-address addresses as a child of the network-interface element. External
backup clients use this address, for example.
An Avamar server-side application uses nat-address elements to
provide an Avamar client with an address from a set of storage
node addresses.
In the absence of a nat-address element, a client uses a
pre-configured “real” (untranslated) network-interface address.

Note: Utility nodes or single-node servers do not require a

nat-address element. (All clients use a pre-configured address to
communicate with the utility node or single-node server.)

The following table describes attributes for the elements.

Table 405 Attributes for probe.xml elements (page 1 of 2)

Element Attribute Description

dpn None The top-level element in probe.xml has no attributes.

module @name (Optional) Specifies the name of the utility node or single-node
server.
The value for the @name attribute must be unique across all
modules.
Applications verify the name of the utility node or single-node
server with the @name attribute.

node @connected (Optional) Uses Boolean values “true” or “false” to specify a

node as available or unavailable. The default setting is true.

Note: When a node is unavailable (disconnected), all nodes of

the same type shift their index position. For example, node 0.6
becomes node 0.5 and so forth.

@type Specifies the node type. Values are:

• utility
• storage
• access
• accelerator
• spare
• single-node server
• unclassified
Do not specify utility, storage, or spare nodes within a module
that includes a single-node server.
Do not specify a single-node server for a multi-node server
configuration. Instead, specify a utility node.

network-interface None The network-interface element has no attributes.

518 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

Table 405 Attributes for probe.xml elements (page 2 of 2)

Element Attribute Description

uses @allow Specifies the types of functions (uses) allowed or denied by the
@deny network interface. Types are:
• all—includes all uses (backup and internal)
• backup—refers to Avamar client/server backup operations
• internal—refers to internal or inter-node communications,
particularly those used by the gsan.
• none—excludes all uses (backup and internal)
Include types of uses in a comma-delimited list when
specifying more than one use.
If the uses element is absent from a network interface, then all
uses are permitted for the network interface.
If both the @allow and @deny attribute values specify the
same use, then the @deny attribute takes precedence.

address @value Specifies the IPv4 address of the network interface (for
example, 10.6.249.87). This address must be unique across all
network-interfaces elements.
Clients use this address if the nat-address element is not
present.

nat-address @initial Specifies an initial contact address for the utility node or
single-node server. An Avamar client provides this address to a
server-side application.

@target Specifies a target address for the client to use when contacting
a storage node.

Processing precedence
Programs that use probe.xml use the following processing precedence to locate a valid
probe.xml file:
1. If –-nodedb=FILE is supplied and a valid probe.xml file exists at that location, use it.
For example:
mapall –-nodedb=/usr/local/probe.xml

2. Search for a valid probe.xml file in the default location

(/usr/local/avamar/var/probe.xml).
3. If a valid probe.xml file cannot be found, and the --allow_legacy option is supplied
with either the --probefile=FILE or --probedir=PATH options, then an attempt is made
to locate a legacy legacy probe.out file as follows:
a. Search for a legacy probe.out FILE as specified by --allow_legacy --probefile=FILE.
b. Search for a legacy probe.out file in the location (PATH) specified by --allow_legacy
--probedir=PATH.
4. Process the location specified by the SYSPROBEDIR environment variable as follows:
a. Search for a valid probe.xml file.
b. If a valid probe.xml file is not found, search for a legacy probe.out file.

probe.xml 519
EMC CONFIDENTIAL
Important Files

Example script for creating probe.xml for a single-node server

The following script creates a probe.xml file for a single-node server named
avamar-1.example.com:
#!/usr/bin/perl
use node_db;
my $node_db = new node_db;
my $address = $node_db->mkAddressElement(value => '10.6.248.183');
my $network_interface = $node_db->mkNetworkInterfaceElement();
my $node =
$node_db->mkNodeElement_type_single_node_server();
my $module = $node_db->mkModuleElement(name => 'avamar-1.example.com');
my $doc = $node_db->mkDpnDocument();
$node_db->add_address(parent => $network_interface, element => $address);
$node_db->add_network_interface(parent => $node,
element => $network_interface);
$node_db->add_node(parent => $module, element => $node);
$node_db->add_module(parent => $doc, element => $module);
$node_db->write();

Running this script produces the following probe.xml file:

<dpn>
<module name="avamar-1.example.com">
<node type="single-node server">
<network-interface>
<address value="10.6.248.183"/>
</network-interface>
</node>
</module>
</dpn>

Example probe.xml file for multi-node server

The following example is a typical probe.xml file for a multi-node server:
<dpn>
<module name="alamedabeta">
<node type="utility">
<network-interface>
<uses allow="backup"/>
<address value="10.6.249.87"/>
</network-interface>
<network-interface>
<uses deny="backup"/>
<address value="10.6.249.5"/>
</network-interface>
</node>
<node type="storage">
<network-interface>
<address value="10.6.249.88"/>
<nat-address initial="192.168.99.1" target="192.168.100.73"/>
<nat-address initial="172.16.24.1" target="172.16.25.2"/>
</network-interface>
</node>
<node type="storage">
<network-interface>
<address value="10.6.249.89"/>
<nat-address initial="192.168.99.1" target="192.168.100.74"/>
<nat-address initial="172.16.24.1" target="172.16.25.3"/>
</network-interface>
</node>
<!-- Remaining storage nodes elided -->

520 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Files

<node type="accelerator">
<network-interface>
<address value="10.6.249.92"/>
</network-interface>
</node>
<node type="access">
<network-interface>
<address value="10.6.249.93"/>
</network-interface>
</node>
<node type="spare" connected="false">
<network-interface>
<address value="10.6.249.94"/>
</network-interface>
</node>
</module>
</dpn>

Equivalent information in the probe.out file would be as follows:

NONAT
alamedabeta:10.6.249.5,10.6.249.5:10.6.249.88,10.6.249.89

Example script for returning storage node addresses

The following script reads the example probe.xml file and returns a list of storage node
addresses:
#!/usr/bin/perl
use node_db;
$node_db = new node_db;
$node_db->read();
if (my $storage_node_list = $node_db->select_nodes(by_id => '#.#')) {
foreach my $storage_node (@{$storage_node_list}) {
my $address_list =
$node_db->get_node_ipv4_address_values($storage_node);
next unless $address_list;
next unless scalar(@{$address_list});
print(join("\n", @{$address_list}),"\n");
}
}

Running this script produces the following output:

10.6.249.87
10.6.249.5
10.6.249.88
10.6.249.89
10.6.249.92
10.6.249.93
10.6.249.94

probe.xml 521
EMC CONFIDENTIAL
Important Files

repl_cron.cfg
The repl_cron.cfg file is a flag file that is used by repl_cron to implement replication.
The repl_cron.cfg file is a flag file that contains various commands, options, and settings
that are passed at run time to the replicate utility by repl_cron.
A sample repl_cron.cfg file is provided in the /usr/local/avamar/bin directory. To use
replication, a live customized version must be placed in /usr/local/avamar/etc.
The repl_cron.cfg file can contain any valid replicate commands and options.

step-tickers*
The step-tickers* file is an output file created by the mktime utility.

usersettings.cfg
The usersettings.cfg file is a flag file. Flag files contain options that are passed to Avamar
utilities when they are invoked by this user. The usersettings.cfg file is typically found in
the /usr/local/avamar/etc directory on utility nodes.
The default usersettings.cfg file typically contains the entries in the following table.

Table 406 usersettings.cfg file entries

Entry Description

--server=AVAMARSERVER Network hostname for the Avamar server as defined in DNS.

--vardir=/usr/local/avamar/var Full path to the local var directory.

--bindir=/usr/local/avamar/bin Full path to the local bin directory.

--id=root User account exiting this utility session. Normally set to root.

--password=PASSWORD User account PASSWORD.

web.xml
The web.xml file is a configuration file that stores Avamar Enterprise Manager web server
configuration settings. This file is located in the
/usr/local/avamar-tomcat/webapps/cas/WEB-INF directory.
The following preference controls how long it takes for Avamar Enterprise Manager
sessions to time out after a period inactivity:
<session-config>
<session-timeout>4320</session-timeout>
<!-- this is in minutes. 72 hours -->
</session-config>

A setting of zero (0) disables session timeouts entirely.

522 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL

CHAPTER 5
Important Directories

The following topics describe important directories in the Avamar system:

◆ Multi-node server utility nodes.............................................................................. 524
◆ Multi-node server storage nodes ........................................................................... 524
◆ Single-node servers .............................................................................................. 524
◆ Client .................................................................................................................... 525

Important Directories 523

EMC CONFIDENTIAL
Important Directories

Multi-node server utility nodes

The following table lists important directories on the utility node of a multi-node server.

Table 407 Important directories on the utility node of a multi-node server

Directory Description

/home/admin Administrator (admin) user account home directory

/usr/local/avamar Avamar base installation directory

/usr/local/avamar/bin Command-line utilities (binaries and scripts)

/usr/local/avamar/var/avi Logs and other files related to the avinstaller

/usr/local/avamar/var/cron cron job log files

/usr/local/avamar/var/em Logs and other files related to Avamar Enterprise Manager

/usr/local/avamar/var/mc MCS log files

/usr/local/avamar-tomcat Files related to the Apache Tomcat web server

/usr/local/avamar-tomcat-6.0 Files related to the Apache Tomcat web server

/var/log/messages System log files

Multi-node server storage nodes

The following table lists important directories on the storage nodes of a multi-node server.

Table 408 Important directories on the storage nodes of a multi-node server

Directory Description

/data01/cur/gsan.log System log files

/usr/local/avamar Avamar base installation directory

/var/log/messages System log files

Single-node servers
The following table lists important directories on a single-node server.

Table 409 Important directories on a single-node server (page 1 of 2)

Directory Description

/data01/cur/gsan.log System log files

/home/admin Administrator (admin) user account home directory

/usr/local/avamar Avamar base installation directory

/usr/local/avamar/bin Command line utilities (binaries and scripts)

/usr/local/avamar/var/avi Logs and other files related to the avinstaller

/usr/local/avamar/var/cron cron job log files

524 EMC Avamar 7.1 Technical Addendum

 EMC CONFIDENTIAL
Important Directories

Table 409 Important directories on a single-node server (page 2 of 2)

Directory Description

/usr/local/avamar/var/em Logs and other files related to Avamar Enterprise Manager

/usr/local/avamar/var/mc MCS log files

/usr/local/avamar-tomcat Files related to the Apache Tomcat web server

/usr/local/avamar-tomcat-6.0 Files related to the Apache Tomcat web server

/var/log/messages System log files

Client
The following table lists important directories on a client.

Table 410 Important client directories

Directory Description

/usr/local/avamar Default Avamar base installation

directory (AIX, HP-UX, Linux, and
Solaris)

/usr/local/avamar/var/client Client log files

C:\Program Files\avs Default Avamar base installation

directory (Windows)

C:\Program Files\avs\var\clientlogs Client log files

Client 525
EMC CONFIDENTIAL
Important Directories

526 EMC Avamar 7.1 Technical Addendum