Escolar Documentos
Profissional Documentos
Cultura Documentos
Technical Addendum
P/N 300-013-350
REV 03
EMC CONFIDENTIAL
Copyright © 2001- 2012 EMC Corporation. All rights reserved. Published in the USA.
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.
CONTENTS
Preface
avmaint ...................................................................................................... 73
avmaint access ..................................................................................... 83
avmaint atrestencryption ...................................................................... 84
avmaint autorestart............................................................................... 85
avmaint cancelremovebadhashes ......................................................... 86
avmaint cat ........................................................................................... 87
avmaint checklogs ................................................................................ 87
avmaint checkpoint............................................................................... 88
avmaint config ...................................................................................... 90
avmaint conversion............................................................................... 98
avmaint crunch ..................................................................................... 99
avmaint decommission ....................................................................... 100
avmaint ducp ...................................................................................... 101
avmaint findbadhashes ...................................................................... 101
avmaint garbagecollect ....................................................................... 103
avmaint gcstatus................................................................................. 104
avmaint gendata ................................................................................. 105
avmaint getclientmsgs ........................................................................ 106
avmaint geterrors ................................................................................ 106
avmaint getrefby ................................................................................. 107
avmaint hfscheck................................................................................ 108
avmaint hfscheckstatus ...................................................................... 113
avmaint hfscheckthrottle .................................................................... 116
avmaint infomessage .......................................................................... 118
avmaint kill ......................................................................................... 119
avmaint logscan.................................................................................. 119
avmaint lookup ................................................................................... 122
avmaint ls ........................................................................................... 123
avmaint lscp ....................................................................................... 124
avmaint networkconfig........................................................................ 127
avmaint nodelist ................................................................................. 128
avmaint perf........................................................................................ 129
avmaint ping ....................................................................................... 133
avmaint poolcheck.............................................................................. 134
avmaint rebuildstripe .......................................................................... 135
avmaint removebadhashes ................................................................. 136
avmaint rmcp ...................................................................................... 137
avmaint sched .................................................................................... 139
avmaint sessions ................................................................................ 146
avmaint stats ...................................................................................... 146
avmaint stripels .................................................................................. 148
avmaint suspend ................................................................................ 149
avmaint test ........................................................................................ 149
avmaint testintegrity ........................................................................... 150
avmaint timesync................................................................................ 151
avmaint timing .................................................................................... 152
avmaint tracehash .............................................................................. 153
avmgr ....................................................................................................... 154
avregister.................................................................................................. 165
avregister.bat............................................................................................ 165
avscc ........................................................................................................ 166
avsetup_avamarbin .................................................................................. 168
avsetup_avi.pl .......................................................................................... 168
avsetup_connectemc.pl ............................................................................ 168
avsetup_ems ............................................................................................ 169
avsetup_mccli........................................................................................... 169
avsetup_mcs ............................................................................................ 170
avsetup_mds ............................................................................................ 172
avsetup_snmp .......................................................................................... 173
avsetup_webstart ..................................................................................... 174
avsetup_wrapper ...................................................................................... 175
avtar ......................................................................................................... 176
avtar.bin ................................................................................................... 199
axion_install ............................................................................................. 199
axionfs...................................................................................................... 202
backup_upgrade_files............................................................................... 205
btfix .......................................................................................................... 206
capacity.sh ............................................................................................... 207
change-passwords .................................................................................... 209
change_nodetype ..................................................................................... 210
check.dpn................................................................................................. 211
check.mcs................................................................................................. 214
checklib.pm .............................................................................................. 215
clean_db.pl............................................................................................... 215
clean.dpn ................................................................................................. 218
convert-probe ........................................................................................... 219
copy-ata-drive ........................................................................................... 219
copy-checkpoint........................................................................................ 222
cp_cron..................................................................................................... 224
cplist ........................................................................................................ 225
cps ........................................................................................................... 227
create_newconfigs .................................................................................... 229
cron_env_wrapper .................................................................................... 229
dbcreate_mds........................................................................................... 230
dbload.sh ................................................................................................. 231
dbmaint.sh ............................................................................................... 231
dbpurge.sh ............................................................................................... 232
dbUpdateActivitiesExt.pl........................................................................... 233
decommission.node ................................................................................. 234
delete-snapups......................................................................................... 234
disktest.pl ................................................................................................ 236
dpn.pm..................................................................................................... 237
dpncron.pm .............................................................................................. 237
dpnctl ....................................................................................................... 237
dpnfsctl .................................................................................................... 247
dpnnetutil................................................................................................. 248
dpnsummary............................................................................................. 256
dpn-time-config ........................................................................................ 258
dt and dtsh ............................................................................................... 261
dump_accounts ........................................................................................ 263
dumpmaintlogs ........................................................................................ 264
emserver.sh.............................................................................................. 264
emwebapp.sh ........................................................................................... 267
errchk ....................................................................................................... 268
evening_cron_run ..................................................................................... 269
expire-snapups ......................................................................................... 269
gathergsankeydata ................................................................................... 271
gcblitz....................................................................................................... 272
gc_cron..................................................................................................... 273
gc_report .................................................................................................. 275
Index
TABLES
Title Page
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 representative if a product does not function properly or does not
function as described in this document.
Note: This document was accurate at publication time. New versions of this document
might be released on the EMC online support website. Check the EMC online support
website 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.
03 July 31, 2012 Updated “Where to get help” on page 22 in the Preface.
A02 June 15, 2012 Updated “Avamar-only advanced command options for the
avtar command” on page 189.
A01 April 25, 2012 First release of Avamar 6.1
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
DANGER indicates a hazardous situation which, if not avoided, will result in death or
serious injury.
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
CAUTION, used with the safety alert symbol, indicates a hazardous situation which, if not
avoided, could result in minor or moderate injury.
NOTICE is used to address practices not related to personal injury.
IMPORTANT
An important notice contains information essential to software or hardware operation.
Typographical conventions
EMC uses the following type style conventions in this document:
Normal Used in running (nonprocedural) text for:
• Names of interface elements, such as names of windows, dialog boxes,
buttons, fields, and menus
• Names of resources, attributes, pools, Boolean expressions, buttons,
DQL statements, keywords, clauses, environment variables, functions,
and utilities
• URLs, pathnames, filenames, directory names, computer names, links,
groups, service keys, file systems, and notifications
Bold Used in running (nonprocedural) text for names of commands, daemons,
options, programs, processes, services, applications, utilities, kernels,
notifications, system calls, and man pages
Used in procedures for:
• Names of interface elements, such as names of windows, dialog boxes,
buttons, fields, and menus
• What the user specifically selects, clicks, presses, or types
Italic Used in all text (including procedures) for:
• Full titles of publications referenced in text
• Emphasis, for example, a new term
• Variables
Courier Used for:
• System output, such as an error message or script
• URLs, complete paths, filenames, prompts, and syntax when shown
outside of running text
Courier bold Used for specific user input, such as commands
Courier italic Used in procedures for:
• Variables on the command line
• User input variables
<> Angle brackets enclose parameter or variable values supplied by the user
[] 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
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.
Live chat
To engage EMC Customer Service 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 Service, 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.
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 Service.
Your comments
Your suggestions will help us continue to improve the accuracy, organization, and overall
quality of the user publications. Send your opinions of this document to:
BSGDocumentation@emc.com
CHAPTER 1
Advanced Technical Information
The following topics present advanced technical information for EMC® Avamar® that is
not found in other Avamar documentation:
◆ Checkpoints............................................................................................................ 26
◆ Checkpoint verification ........................................................................................... 26
◆ Client agent and plug-in management ..................................................................... 37
◆ Event throttling ....................................................................................................... 38
◆ Retention types....................................................................................................... 39
◆ Server dynamic load balancing ............................................................................... 41
◆ Storage file types .................................................................................................... 42
◆ Timezone notes ...................................................................................................... 43
Checkpoints
A checkpoint is a saved copy of the server that can be used to restart the system. A
checkpoint directory 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 directory is constructed on every disk of every
node on the system. Note that every node means that 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 created like
that through 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 Filesystem check (HFS check) is an internal operation that verifies the
integrity of a checkpoint. Once a checkpoint has passed an HFS check, it has been
determined to be internally consistent as of the time of the check; subsequent disk or
other hardware failures can obsolete this determination.
The actual 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.
“Automatic stripe repair” on page 32 provides additional information.
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 roll-back 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 roll-back 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
roll-back 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 roll-back target.
Full valid HFS check A full and valid HFS check is such that the checkpoint can be confidently
asserted as a roll-back 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.
Checkpoint verification 27
EMC CONFIDENTIAL
Advanced Technical Information
Operational overview
This topic describes how to start, control (throttle), stop, and get status for an HFS check.
Throttling
An HFS check consumes extensive amounts of server resources. You can throttle an HFS
check to reduce contention with normal server operation. “HFS check throttling” on
page 30 provides additional information.
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 and then rerun
running. HFS check.
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_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.
Checkpoint verification 29
EMC CONFIDENTIAL
Advanced Technical Information
Option Description
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. “Rolling HFS checks”
on page 35 provides additional information.
The following table shows detailed information for each check type.
Check Depth Full and valid? Importance Ordering CXOR set cache
Reduced 9, 7, 4 Yes 3 - -
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 of
itself restricts metadata checks to forward ordered checkpoints.
Checkpoint verification 31
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.
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.
Recurring repairs, especially in the same stripe, might indicate a more serious problem.
Report this behavior to EMC Technical 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. Additional information
is available in “avmaint config” on page 90.
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.20070727130018"
start-time="1186061631" end-time="1186061740" elapsed-time="109"
check-start-time="1186061691" check-end-time="1186061701"
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.
kind abort Stripe check aborted (see log files for additional information).
offline Stripe offline due to hard disk (media) error or missing file.
Checkpoint verification 33
EMC CONFIDENTIAL
Advanced Technical Information
Other indications
If corrupted stripes are detected, then the following results occur, depending on the
command.
Command Indication
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
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.
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 defining
how many data stripes are to be checked.
--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.
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).
modified=0 or 2 N1 P'
modified=1 N0 P'
Checkpoint verification 35
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.
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.
Initial behavior
Following initial software installation, the agents and plug-ins definition file is read into
the MCS database. System administrators can then extend this list of known agents and
plug-ins by adding new build records, as well as editing existing version or build records to
grant or deny various privileges on a version-by-version or build-by-build basis.
Upgrade behavior
A new agents and plug-ins definition file is installed each time Avamar server software is
upgraded. When the server is restarted following the upgrade, information in the new
agents and plug-ins definition file is merged with the existing MCS database entries.
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" />
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.
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 rendering by-week and
by-month Avamar File System (AvFS) views, replicating only weekly, monthly or yearly
backups, or locating certain types of backups in the Backup Management and Backup and
Restore windows.
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.
Retention types 39
EMC CONFIDENTIAL
Advanced Technical Information
The following table shows which retention types are programmatically assigned to
backups performed during this month. Some backups are omitted for clarity.
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
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.
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.
*.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.
Timezone notes
When you select a local timezone for an Avamar server consider the following notes:
◆ Use a timezone that is compatible with the maintenance window, as discussed in
“Maintenance window compatibility” on page 43.
◆ Consult the local site administrator for a timezone recommendation, as discussed in
“Consult the local site administrator” on page 43.
◆ Check whether the timezone observes daylight savings time (DST), as discussed in
“Daylight savings time considerations” on page 43.
◆ Where possible, avoid local timezones that ignore local DST laws, as discussed in
“Avoid local timezones that ignore local DST laws” on page 44.
◆ Do not use GMT as the local timezone for England, as discussed in “Do not use GMT as
local timezone for England” on page 44.
◆ Select the capital city or nearest large city for small countries, as discussed in “Select
capital city or nearest large city for small countries” on page 44.
◆ Review the additional resources listed in “Additional timezone resources” on
page 44.
Timezone notes 43
EMC CONFIDENTIAL
Advanced Technical Information
Alternatively you can consult authoritative web sites to make this determination. For
example: http://www.timeanddate.com/worldclock.
CHAPTER 2
Command Reference
The following topics document Avamar command line programs, scripts, and libraries:
◆ Run locations .......................................................................................................... 48
◆ Boolean option behavior and syntax ....................................................................... 48
◆ Wildcards................................................................................................................ 49
◆ 5minute_cron_run .................................................................................................. 50
◆ 10minute_cron_run ................................................................................................ 50
◆ ascd........................................................................................................................ 51
◆ asktime................................................................................................................... 52
◆ avacl....................................................................................................................... 59
◆ avagent.bin............................................................................................................. 61
◆ avidbmaint.pl ......................................................................................................... 67
◆ avinstaller.pl ........................................................................................................... 68
◆ avldap .................................................................................................................... 69
◆ avlockboxcfg........................................................................................................... 71
◆ avmaint .................................................................................................................. 73
◆ avmgr ................................................................................................................... 154
◆ avregister.............................................................................................................. 165
◆ avregister.bat........................................................................................................ 165
◆ avscc .................................................................................................................... 166
◆ avsetup_avamarbin .............................................................................................. 168
◆ avsetup_avi.pl ...................................................................................................... 168
◆ avsetup_connectemc.pl ........................................................................................ 168
◆ avsetup_ems ........................................................................................................ 169
◆ avsetup_mccli....................................................................................................... 169
◆ avsetup_mcs ........................................................................................................ 170
◆ avsetup_mds ........................................................................................................ 172
◆ avsetup_snmp ...................................................................................................... 173
◆ avsetup_webstart ................................................................................................. 174
◆ avsetup_wrapper .................................................................................................. 175
◆ avtar ..................................................................................................................... 176
◆ avtar.bin ............................................................................................................... 199
◆ axion_install ......................................................................................................... 199
◆ axionfs.................................................................................................................. 202
◆ backup_upgrade_files........................................................................................... 205
◆ btfix ...................................................................................................................... 206
◆ capacity.sh ........................................................................................................... 207
◆ change-passwords ................................................................................................ 209
◆ change_nodetype ................................................................................................. 210
◆ check.dpn ............................................................................................................. 211
◆ check.mcs............................................................................................................. 214
◆ checklib.pm .......................................................................................................... 215
◆ clean_db.pl........................................................................................................... 215
◆ clean.dpn ............................................................................................................. 218
◆ convert-probe ....................................................................................................... 219
◆ copy-ata-drive ....................................................................................................... 219
Command Reference 45
EMC CONFIDENTIAL
Command Reference
◆ copy-checkpoint.................................................................................................... 222
◆ cp_cron................................................................................................................. 224
◆ cplist .................................................................................................................... 225
◆ cps ....................................................................................................................... 227
◆ create_newconfigs ................................................................................................ 229
◆ cron_env_wrapper ................................................................................................ 229
◆ dbcreate_mds....................................................................................................... 230
◆ dbload.sh ............................................................................................................. 231
◆ dbmaint.sh ........................................................................................................... 231
◆ dbpurge.sh ........................................................................................................... 232
◆ dbUpdateActivitiesExt.pl....................................................................................... 233
◆ decommission.node ............................................................................................. 234
◆ delete-snapups..................................................................................................... 234
◆ disktest.pl ............................................................................................................ 236
◆ dpn.pm................................................................................................................. 237
◆ dpncron.pm .......................................................................................................... 237
◆ dpnctl ................................................................................................................... 237
◆ dpnfsctl ................................................................................................................ 247
◆ dpnnetutil............................................................................................................. 248
◆ dpnsummary......................................................................................................... 256
◆ dpn-time-config .................................................................................................... 258
◆ dt and dtsh ........................................................................................................... 261
◆ dump_accounts .................................................................................................... 263
◆ dumpmaintlogs .................................................................................................... 264
◆ emserver.sh.......................................................................................................... 264
◆ emwebapp.sh ....................................................................................................... 267
◆ errchk ................................................................................................................... 268
◆ evening_cron_run ................................................................................................. 269
◆ expire-snapups ..................................................................................................... 269
◆ gathergsankeydata ............................................................................................... 271
◆ gcblitz................................................................................................................... 272
◆ gc_cron................................................................................................................. 273
◆ gc_report .............................................................................................................. 275
◆ gen-ssl-cert ........................................................................................................... 276
◆ gethostbyname ..................................................................................................... 277
◆ getlogs.................................................................................................................. 277
◆ getnodelogs.......................................................................................................... 278
◆ getsnapupstats ..................................................................................................... 278
◆ health_check.pl .................................................................................................... 280
◆ hfscheck_cron....................................................................................................... 282
◆ hfscheck_kill......................................................................................................... 286
◆ hfsclean................................................................................................................ 288
◆ hfssetup ............................................................................................................... 288
◆ initacnt ................................................................................................................. 288
◆ initialize_connectemc ........................................................................................... 289
◆ java_update.sh ..................................................................................................... 290
◆ java_update_avi.sh............................................................................................... 290
◆ lm ......................................................................................................................... 291
◆ load_accounts ...................................................................................................... 292
◆ logmrg .................................................................................................................. 293
◆ mapall .................................................................................................................. 294
◆ mcdbmaint.sh....................................................................................................... 297
◆ mcdbsql.sh........................................................................................................... 298
◆ mcconfigfirewall_snmp ......................................................................................... 299
◆ mcddrcopy_sshkey ............................................................................................... 300
◆ mcddrcreate_sshkey ............................................................................................. 300
◆ mcddrsetup_sshkey.............................................................................................. 300
◆ mcddrsnmp .......................................................................................................... 301
◆ mcfeature ............................................................................................................. 302
◆ mcflush.pl............................................................................................................. 302
◆ mcgui.bat ............................................................................................................. 303
◆ mcgui.sh............................................................................................................... 304
◆ mcgui_login.bat .................................................................................................... 304
◆ mcserver.sh .......................................................................................................... 306
◆ mcsmon_run......................................................................................................... 310
◆ mcsnmp................................................................................................................ 311
◆ mcsnmp_cron ....................................................................................................... 311
◆ mds_ctl................................................................................................................. 312
◆ metadata_cron...................................................................................................... 312
◆ mktime ................................................................................................................. 313
◆ modify-snapups.................................................................................................... 315
◆ mondo .................................................................................................................. 317
◆ monmcs................................................................................................................ 317
◆ morning_cron_run................................................................................................. 318
◆ nodedb................................................................................................................. 319
◆ nodenumbers ....................................................................................................... 335
◆ opstatus.dpn ........................................................................................................ 337
◆ permctl ................................................................................................................. 337
◆ pingmcs................................................................................................................ 338
◆ probe.................................................................................................................... 339
◆ probeaux .............................................................................................................. 340
◆ probedump........................................................................................................... 340
◆ probesingle........................................................................................................... 341
◆ propagate-gsan..................................................................................................... 342
◆ psregrep ............................................................................................................... 342
◆ pull-checkpoint ..................................................................................................... 343
◆ rebuild.node ......................................................................................................... 344
◆ repl_cron .............................................................................................................. 348
◆ replicate ............................................................................................................... 349
◆ resite .................................................................................................................... 358
◆ restart.dpn............................................................................................................ 367
◆ resume_crons ....................................................................................................... 372
◆ rollback.dpn.......................................................................................................... 372
◆ rununtil................................................................................................................. 374
◆ sched.sh............................................................................................................... 375
◆ scn ....................................................................................................................... 376
◆ securedelete ......................................................................................................... 379
◆ showperfhistory .................................................................................................... 380
◆ shutdown.dpn ...................................................................................................... 382
◆ site_inventory ....................................................................................................... 384
◆ ssn ....................................................................................................................... 386
◆ start.dpn............................................................................................................... 389
47
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.
Wildcards
Avamar command line utilities that accept PATTERN as a value, as well as the avtar files
and directory list provided in “File and directory list” on page 178 can use the regular
expression (regex) glob operators, also known as wildcards, that are listed in the following
table. Limitations are noted where applicable.
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.
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.
Wildcards 49
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, discussed on page 338, 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.
Option Description
--debug Shows example session information but does not perform the specified actions.
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, which is discussed on page 429. 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.
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, discussed on page 310,
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.
Option Description
--debug Shows example session information but does not perform the specified actions.
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, which is discussed on page 429. 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.
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, discussed on page 367, or start.dpn,
discussed on page 389.
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.
Option Description
--basedir=PATH Specifies the full PATH of the ascd top-level (root) directory. The default
setting is /usr/local/avamar.
--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.
ascd 51
EMC CONFIDENTIAL
Command Reference
Option Description
--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. Additional information is available in
“license LICENSEFILE” on page 79.
--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. Additional information is available in “probe.xml” on
page 482.
--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. Additional information is available in “avmaint logscan” on
page 119.
--sslport=PORT Specifies the SSL data PORT. The default setting is 29000.
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.
Option Description
--debug Shows example session information but does not perform the specified
actions.
--nodedb=FILE Specifies the full path to a valid probe.xml file, discussed on page 482.
The default is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.
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.
Option Description
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.
◆ This program requires a valid probe.xml file, discussed on page 482, to resolve
MODULE.NODE designations to IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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.
asktime 53
EMC CONFIDENTIAL
Command Reference
Files produced
The asktime command produces the following files.
File Description
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.
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).
asktime 55
EMC CONFIDENTIAL
Command Reference
asktime 57
EMC CONFIDENTIAL
Command Reference
Troubleshooting information
The following table describes how to recover from common problems encountered when
running asktime.
Any error involving finding or Verify that you are using the proper probe command by typing:
reading the probe.xml file which probe
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.
where TIME-STRING is any time string that is acceptable to GNU date. For example:
• 14:40
• ‘Mon, Nov 28 2005 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.
avacl
The avacl command locates the .avamarmetafile file and restores encapsulated filesystem
metadata to restored files and directories. The metadata content varies by filesystem. 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 filesystem 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.
avacl 59
EMC CONFIDENTIAL
Command Reference
Synopsis
avacl [--delete] [--noacls] [--norecurse] [--quiet] [--rootdir=PATH]
[--version]
Options
The following options are available for the avacl command.
Option Description
--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.
--rootdir=PATH Specifies the root directory to start processing. The default setting is the
current working directory.
Notes
Consider the following notes for the avacl command:
◆ Beginning with version 4.1, filesystem 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.
avagent.bin
The avagent.bin command is the client background process that passes backup and
restore requests to the Avamar server.
On Microsoft Windows platforms, avagent.bin must run as a non-interactive service.
Therefore, command line interaction with avagent.bin is not supported on Microsoft
Windows platforms.
Synopsis
avagent.bin [--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]
[--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.bin command.
Option Description
avagent.bin 61
EMC CONFIDENTIAL
Command Reference
Option Description
Same as --register.
--notryagain Does not force the client to wait when the server tells the
client to try again later.
Option Description
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 Service for additional
information before using them.
Table 26 Avamar-only advanced command options for the avagent.bin command (page 1 of 4)
Option Description
avagent.bin 63
EMC CONFIDENTIAL
Command Reference
Table 26 Avamar-only advanced command options for the avagent.bin command (page 2 of 4)
Option Description
Table 26 Avamar-only advanced command options for the avagent.bin command (page 3 of 4)
Option Description
avagent.bin 65
EMC CONFIDENTIAL
Command Reference
Table 26 Avamar-only advanced command options for the avagent.bin command (page 4 of 4)
Option Description
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.
Option Description
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.
Option Description
--restore Restores flushed avidb data from the Avamar server. Can be used with one
or more restore options, discussed in “Restore options” on page 67.
--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.
--update Updates the avidb and relevant preferences after a software upgrade.
Restore options
The following options can be used with the --restore command.
Option Description
avidbmaint.pl 67
EMC CONFIDENTIAL
Command Reference
Option Description
--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.
Option Description
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.
The user authentication mechanisms that can be configured are listed in the following
table.
Authentication Description
mechanism
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 user 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] }
avldap 69
EMC CONFIDENTIAL
Command Reference
Commands
The following commands are available for the avldap Perl script.
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.
--help Displays help. Use an option to display help about a specific command.
Options
The following options are available for the avldap Perl script.
Option Description
--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.
avlockboxcfg
The avlockboxcfg command is used to configure and manage the Avamar RSA Lockbox.
The EMC Avamar Product Security Guide provides additional information about 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.
Command Description
avlockboxcfg 71
EMC CONFIDENTIAL
Command Reference
Command Description
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.
Option Description
--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.
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 | ls LOCATION |
lscp | nodelist | perf {reset | status} | ping | resume | rm PATH |
sessions | stat OBJECT | stats | stripels STRIPELIST | suspend |
tunnellist}
Commands
Supply one and only one of the following commands on each command line.
Command Description
avmaint 73
EMC CONFIDENTIAL
Command Reference
Command Description
ducp CP-ID Lists the hard drive space consumed by a specific checkpoint (CP-ID).
A complete discussion of avmaint ducp behavior and syntax is
available in “avmaint ducp” on page 101.
gcstatus Returns the status for an ongoing or the most recently completed
garbage collect process.
A complete discussion of avmaint gcstatus behavior and syntax is
available in “avmaint gcstatus” on page 104.
geterrors NODE-ID Return errors from the specified NODE-ID, which can be obtained
using the nodelist command, which is discussed on page 128.
A complete discussion of avmaint geterrors behavior and syntax is
available in “avmaint geterrors” on page 106.
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.
A complete discussion of avmaint perf behavior and syntax is
available in “avmaint perf” on page 129.
Command Description
rm PATH Removes the specified persistent store map element, where PATH is
the location of a persistent store map element on the server.
stats Returns the status of all stripes by sending a message to each stripe
and receiving back some information about each stripe that
responds.
A complete discussion of avmaint stats behavior and syntax is
available in “avmaint stats” on page 146.
stripels STRIPELIST Displays file data for specified list of stripes (STRIPELIST).
A complete discussion of avmaint stripels behavior and syntax is
available in “avmaint stripels” on page 148.
suspend Temporarily halts client activities and denies new client requests.
A complete discussion of avmaint suspend behavior and syntax is
available in “avmaint suspend” on page 149.
Global options
The following global options are available for the avmaint command.
Option Description
--help Shows full online help (commands, options and full descriptions),
then exits.
avmaint 75
EMC CONFIDENTIAL
Command Reference
Option Description
--helpxml Shows full online help (commands, options and full descriptions)
in XML format, then exits.
--hfsport=PORT Sets the Avamar server PORT number. The default setting is 27000.
--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).
--tryagain If server is idle, try completing this operation later. This is the
default setting.
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 Service for additional information
before using them..
Command Description
access MODE Sets the server access MODE to one of the following:
• admin
• normal
• readmigrate
• readonly
• sync
A complete discussion of avmaint access behavior and syntax
is available in “avmaint access” on page 83.
avmaint 77
EMC CONFIDENTIAL
Command Reference
Command Description
getrefby TYPE HASH Returns all hashes of a specified TYPE that reference this
HASH.
A complete discussion of avmaint getrefby behavior and
syntax is available in “avmaint getrefby” on page 107.
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.
Command Description
license LICENSEFILE Creates 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.
A complete discussion of avmaint logscan behavior and
syntax is available in “avmaint logscan” on page 119.
lookup [H | P | U] HASH Looks up the supplied HASH and returns information about
the associated index and data stripes.
A complete discussion of avmaint lookup behavior and
syntax is available in “avmaint lookup” on page 122.
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.
avmaint 79
EMC CONFIDENTIAL
Command Reference
Command Description
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.
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.
A complete discussion of avmaint testintegrity behavior and
syntax is available in “avmaint testintegrity” on page 150.
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 Service for additional
information before using them.
Table 39 Avamar-only advanced command options for the avmaint command (page 1 of 3)
Option Description
--acport=PORT Specifies the client agent data port number. The default setting is
28002.
Same as --listenport=PORT.
Table 39 Avamar-only advanced command options for the avmaint command (page 2 of 3)
Option Description
--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.
--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.
--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.
--rotatelogcount=NUM Specifies the rotation count (NUM) of avmaint log file. The default
setting is 10.
avmaint 81
EMC CONFIDENTIAL
Command Reference
Table 39 Avamar-only advanced command options for the avmaint command (page 3 of 3)
Option Description
--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.
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.
Command Description
perfstatus [NODE-ID] Deprecated in version 4.1 in favor of the avmaint perf command,
discussed on page 129.
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.
Option Description
Notes
If the Avamar username and password are present in the .avamar file, discussed on
page 432, 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.
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 Service 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.
Parameter Description
Command options
The following command option is available for the avmaint access command.
Option Description
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 83
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
Service 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.
Option Description
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.
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.
Option Description
--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.
Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.
avmaint 85
EMC CONFIDENTIAL
Command Reference
Files
The following file is associated with the avmaint autorestart command.
File Description
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 cancelremovebadhashes
The avmaint cancelremovebadhashes command cancels a pending find/delete bad hash
operation and returns the server to a fully operation state. Additional information is
available in “avmaint findbadhashes” on page 101 and “avmaint removebadhashes” on
page 136.
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 Service 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.
Parameter Description
Command options
The following command options are available for the avmaint cat command.
Option Description
Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.
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 Service for additional information before using it.
Synopsis
avmaint checklogs [{cp.nnnn |--full}] [{--delete |--keep}]
--avamaronly --xmlperline=NUM GLOBAL-OPTIONS
avmaint 87
EMC CONFIDENTIAL
Command Reference
Command options
The following command options are available for the avmaint checklogs command.
Option Description
--full Specifies that the action should be performed on all 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.
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 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 Service 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.
Option Description
--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.
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).
avmaint 89
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 Service 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 | 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 |
sslport=PORT | vmstatdelay=NUM | vmstatprofile{PROFILE-NAME | NUM}
--avamaronly GLOBAL-OPTIONS
Parameters
Supply one and only one of the following parameters on each command line for
avmaint config.
Parameter Description
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).
Parameter Description
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.
Additional information about the avmaint checklogs command
is available in “avmaint checklogs” on page 87.
commtimeout=NUM Specifies the number (NUM) of seconds used for internal server
communication timeouts. The default setting is 30.
avmaint 91
EMC CONFIDENTIAL
Command Reference
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.
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.
Parameter Description
maxcompdatastripe=SIZE Sets the maximum composite data stripe SIZE to this number of
elements.
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.
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).
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.
avmaint 93
EMC CONFIDENTIAL
Command Reference
Parameter Description
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.
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.
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.
Parameter Description
vmstatdelay=NUM Specifies the number (NUM) of seconds between vmstat log file
write operations. The default setting is 60 seconds.
avmaint 95
EMC CONFIDENTIAL
Command Reference
Parameter Description
Global options
“Global options” on page 75 provides a complete list of options that can be used with any
avmaint command.
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.
Parameter Description
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 97
EMC CONFIDENTIAL
Command Reference
avmaint conversion
The avmaint conversion command converts older format data stripes to 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 Service 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.
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).
--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.
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 Service for additional information before using it.
Synopsis
avmaint crunch {limit LIMIT | status | reset | rollover |
resetandrollover | factoryreset} [--restricted | unrestricted]
--avamaronly GLOBAL-OPTIONS
Parameters
Supply one and only one of the following parameters on each command line for the
avmaint crunch command.
Parameter Description
limit LIMIT Changes the daily amount of asynchronous crunching in accordance withe
the supplied LIMIT value, where LIMIT is a singed 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
Command options
The following command option is available for the avmaint crunch command.
Option Description
--avamaronly Enables commands and options that are normally intended for use by
expert users only. Contact EMC Customer Service for additional
information.
You must supply --avamaronly for this command to work.
avmaint 99
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 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.
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 Service 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.
Parameter Description
NODE-ID If a NODE-ID (for example, 0.1, 0.2) is supplied, that node 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 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.
Parameter Description
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, discussed on page 136, 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 Service 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,
discussed on page 136, completes.
If you must revert to fully operational server state before running avmaint
removebadhashes, use avmaint cancelremovebadhashes, discussed on page 86, to undo
this entire find/delete bad hash operation.
Synopsis
avmaint findbadhashes [H] HASH --avamaronly GLOBAL-OPTIONS
avmaint 101
EMC CONFIDENTIAL
Command Reference
Parameters
The following parameters are available for the avmaint findbadhashes command.
Parameter Description
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 garbagecollect
The avmaint garbagecollect command starts a garbage collect 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 Service for additional information before using it.
Synopsis
avmaint garbagecollect [--gccount=NUM] [--kill=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.
Option Description
avmaint 103
EMC CONFIDENTIAL
Command Reference
Option Description
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 collect process.
Synopsis
avmaint gcstatus [--full] GLOBAL-OPTIONS
Command options
The following command options are available 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 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 Service 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.
Option Description
--pending=NUM Specifies the number (NUM) of simultaneous write requests. The default
setting is 10.
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 105
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.
Option Description
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 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.
Parameter Description
NODE-ID Return errors from the specified NODE-ID, which can be obtained by using the
nodelist command discussed on page 128.
Command options
The following command options are available 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.
--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.
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 Service for additional information before using it.
Synopsis
avmaint getrefby {H | R | U} HASH --avamaronly GLOBAL-OPTIONS
avmaint 107
EMC CONFIDENTIAL
Command Reference
Parameters
The following parameters are available for the avmaint getrefby command.
Parameter Description
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 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 Service for additional information before using it.
“Checkpoint verification” on page 26 provides additional detailed technical information
about the HFS check feature.
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.
Option Description
--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).
avmaint 109
EMC CONFIDENTIAL
Command Reference
Option Description
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 68 Deprecated command options for the avmaint hfscheck 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.
avmaint 111
EMC CONFIDENTIAL
Command Reference
Table 68 Deprecated command options for the avmaint hfscheck command (page 2 of 2)
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 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. “HFS check throttling” on
page 30 provides additional information.
◆ 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, discussed on page 113.
◆ To stop a currently-running HFS, use avmaint hfscheckstop, discussed on page 78, or
hfscheck_kill, discussed on page 286.
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.20051215003909"
status="hfscheck"
start-time="1134607161"
end-time="0"
elapsed-time="246"
check-start-time="1134607407"/>
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.
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.
avmaint 113
EMC CONFIDENTIAL
Command Reference
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.20081125001344"
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>
Attribute Description
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.
Attribute Description
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
Attribute Description
The actual errors generated can be obtained with the avmaint geterrors --alternate
command, discussed on page 106. “Common hfscheck error codes” on page 28 provides
additional information.
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 Service 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.
Option Description
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.
Option Description
avmaint 117
EMC CONFIDENTIAL
Command Reference
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.
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 Service 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.
Parameter Description
Command options
The following command options are available for the avmaint infomessage command.
Option Description
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 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.
Parameter Description
Command options
The following command option is available 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.
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 Service for additional information before using it.
avmaint logscan 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.
avmaint 119
EMC CONFIDENTIAL
Command Reference
Synopsis
avmaint logscan {local | server } [LOGSCANFILE] --avamaronly
GLOBAL-OPTIONS
Parameters
The following parameter is available for the avmaint logscan command.
Parameter Description
LOGSCANFILE If supplied, Specifies the new enhanced server log scanning parameters
information and returns old information. LOGSCANFILE must conform to the
format specified in “Input file” on page 120.
If not supplied, the current logscan input file is returned.
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.
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="<Code>.+<Type>.+<Severity>.+<Category>
;.+<HwSource>.+<Summary>"/>
</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="<Code>.+<Type>.+<Severity>.+<Category>
;.+<HwSource>.+<Summary>"/>
</logscanpattern>
The following table describes each avmaint logscan input file XML attribute.
Attribute Description
logscanfilelist 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 is limited to a maximum of eight log file descriptors.
logscanfile 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.
logscanfile prefix Optional text string that is prefixed to each Avamar event generated
from a detected pattern in the scanned log file.
logscanfile 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.
logscanpattern exclude Optional attribute that specifies a list of POSIX 1003.2 regular
expressions that are excluded (ignored).
logscanpattern severity Format this entry of interest as one of the following Avamar event types:
• error — Error
• info — Informational
• msg — Message
• warning — Warning
logscanpattern 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.
avmaint 121
EMC CONFIDENTIAL
Command Reference
Attribute Description
logscanpattern 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
logscanpattern prefix Optional text string that is prefixed to each log file entry detected by this
pattern.
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 Service 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.
Parameter Description
Command options
The following command option is available 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 Filesystem (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.
avmaint ls
The avmaint ls command 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.
Parameter Description
Command options
The following command options are available for the avmaint ls command.
Option Description
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 123
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.
Option Description
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.
Option Description
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"?>
<checkpointlist nodecount="8">
<checkpoint
tag="cp.20071029223027"
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>
Attribute Description
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).
avmaint 125
EMC CONFIDENTIAL
Command Reference
Attribute Description
validchecks If TRUE, this HFS check was successful; If FALSE, this HFS check failed.
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 Service 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.
Parameter Description
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,
which is discussed on page 482.
◆ 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 127
EMC CONFIDENTIAL
Command Reference
avmaint nodelist
The avmaint nodelist command returns status of all nodes.
Synopsis
avmaint nodelist [--short] GLOBAL-OPTIONS
Command options
The following command option is available for the avmaint nodelist command.
Option Description
--short Returns an abbreviated report that does not contain configuration, checkpoint,
garbage collect, or HFS check information.
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.
Ready Transitional state that might or might not be due to normal operation.
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.
Bit Description
m Maintenance is allowed.
h HFS is writable.
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.
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 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, discussed on page 380, 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
avmaint 129
EMC CONFIDENTIAL
Command Reference
Commands
Supply one and only one of the following commands on each command line for the
avmaint perf command.
Command Description
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"
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"/>
avmaint 131
EMC CONFIDENTIAL
Command Reference
Each state attribute within the perfhistory element for each disk can have the following
values.
Value Meaning
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 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.
Option Description
STRIPE-ID Restricts the output to only the specified stripe id, for example
0.0-3
--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.
avmaint 133
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 discussed on page 146.
◆ 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 Service for additional information before using it.
Synopsis
avmaint poolcheck --avamaronly [--xmlperline=NUM]
Options
The following options are available for the avmaint poolcheck command.
Option Description
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.
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="2009-Sep-21 22:23:25">
<response nodeid="0.3" code="MSG_ERR_NONE">
<filepoolcheckresults check-started="2009-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="2009-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="2009-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="2009-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>
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 Service for additional information before using it.
Synopsis
avmaint rebuildstripe {STRIPE-ID | --full} [--force] --avamaronly
GLOBAL-OPTIONS
avmaint 135
EMC CONFIDENTIAL
Command Reference
Parameters
Supply one and only one of the following parameters on each command line for the
avmaint rebuildstripe command.
Parameter Description
STRIPE-ID Rebuilds only this stripe. Another rebuild is not allowed until this stripe is finished
rebuilding.
Command options
The following command option is available for the avmaint rebuildstripe command.
Option Description
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
avmaint removebadhashes
The avmaint removebadhashes command removes a set of hashes that are tied to a
specific verification token. Requires that you first run avmaint findbadhashes, discussed
on page 101, 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 Service for additional information before using it.
Synopsis
avmaint removebadhashes VERIFICATION --avamaronly GLOBAL-OPTIONS
Parameters
The following parameter is available for the avmaint removebadhashes command.
Parameter Description
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 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 Service 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.
Parameter Description
avmaint 137
EMC CONFIDENTIAL
Command Reference
Command options
The following command option is available for the avmaint rmcp command.
Option Description
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 100 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.
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 [--waittime=SEC] [--balancemin=NUM]
| conversion [OPTIONS] | cp [OPTIONS] [--delete={TRUE | FALSE}]
| 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.
Parameter Description
conversion [OPTIONS] Specifies which settings to use for the next stripe conversion
operation, where OPTIONS is one or more valid avmaint
conversion option, discussed on page 98.
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.
avmaint 139
EMC CONFIDENTIAL
Command Reference
Parameter Description
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 (5.0 and later)
ordering (cp, gc, hfscheck).
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 102 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).
--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.
avmaint 141
EMC CONFIDENTIAL
Command Reference
Other options
The following other options are available for the avmaint sched command.
Option Description
--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 FALSE
This option added in version 6.0.
--permanent If supplied with avmaint sched cp, 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 cp, gc, and hfscheck 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
Africa/Timbuktu Africa/Tripoli Africa/Tunis
avmaint 143
EMC CONFIDENTIAL
Command Reference
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 145
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.
Option Description
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 105 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.
Table 105 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.
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 discussed on page 133.
◆ 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 147
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.
Parameter Description
Command options
Supply one and only one of the following command options on the command line for the
avmaint stripels command.
Option Description
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.
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.
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 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 Service for additional information before using it.
Synopsis
avmaint test {readerrors | writeerrors | ioerrors | networkerrors}
--disknum=NUM [--latency=USECS] --nodenum=NODE --percent=NUM
--avamaronly GLOBAL-OPTIONS
avmaint 149
EMC CONFIDENTIAL
Command Reference
Parameters
Supply one and only one of the following parameters on each command line for the
avmaint test command.
Parameter Description
Command options
The following command options are available for the avmaint test command.
Option Description
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 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 Service 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.
Parameter Description
Command options
The following command options are available 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 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 Service for additional information before using it.
Synopsis
avmaint timesync [--count=NUM] [--repair] [--timeout=SEC] --avamaronly
GLOBAL-OPTIONS
avmaint 151
EMC CONFIDENTIAL
Command Reference
Command options
The following command options are available for the avmaint timesync command.
Option Description
--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.
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 Service 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.
Parameter Description
addhashdata Returns average elapsed time required to add a new hash to the hash filesystem.
gethashdata Returns average elapsed time required to read a hash from the hash filesystem.
ispresent Returns average elapsed time required to verify whether a hash exists in the hash
filesystem.
ping Returns average elapsed time required to establish communication with a node.
refcheck Returns average elapsed time required to verify integrity of the hash filesystem.
Command options
The following command options are available for the avmaint timing command.
Option Description
--maxsize=NUM Specifies the maximum chunk size. The default setting is 8192.
--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.
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 Service 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.
Parameter Description
avmaint 153
EMC CONFIDENTIAL
Command Reference
Command options
The following command options are available for the avmaint tracehash command.
Option Description
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.
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 Service only. Do not under any circumstances instruct non-EMC
personnel to use avmgr without prior approval from EMC Customer Service.
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}
Commands
Supply one and only one of the following commands on each command line for the avmgr
command.
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.
avmgr 155
EMC CONFIDENTIAL
Command Reference
Command Description
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).
gets Returns statistics. Information includes accumulative statistics for all clients in the
domai,n 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.
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.
Command Description
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.
Options
The following options are available for the avmgr command.
Option Description
avmgr 157
EMC CONFIDENTIAL
Command Reference
Option Description
--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.
--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.
Option Description
--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.
--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.
avmgr 159
EMC CONFIDENTIAL
Command Reference
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.
Option Description
--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.
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 Service for additional information
before using them..
Command Description
avmgr 161
EMC CONFIDENTIAL
Command Reference
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 Service for additional information before
using them.
Table 121 Avamar-only advanced command options for the avmgr command (page 1 of 2)
Option Description
--bindir=PATH Sets the directory containing Avamar binary files. The default
setting is /root.
--conntimeout=SEC Sets the socket connect timeout in seconds (SEC). The default
setting is 60 seconds.
--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.
--noconfig Does not read any configurations files while parsing flags. Same as
--ignoreconfig.
Table 121 Avamar-only advanced command options for the avmgr command (page 2 of 2)
Option Description
--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.
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.
Option Description
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.
avmgr 163
EMC CONFIDENTIAL
Command Reference
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 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 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" />
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.
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.
avregister 165
EMC CONFIDENTIAL
Command Reference
avscc
The avscc command responds to plug-in browsing, backup and restore requests passed to
it from the local avagent.bin service, discussed on page 61, and performs the actual work
associated with these requests. It is typically located in Avamar Client for Windows
C:\Program Files\avs\bin directory, runs as a service on Avamar Client for Windowss and is
invoked by users from the Windows system tray.
The avscc command is not intended to be run directly from the command line. The
information provided in this topic is for reference purposes only.
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.
Option Description
--acport=PORT Specifies the data PORT that the Windows client agent uses to
directly communicate with the local avagent.bin service.
Option Description
--flagfile=FILE Specifies a FILE containing a list of options and values that are
processed by avagent.bin as if they were included on the
command line. The default setting is
/usr/local/avamar/etc/usersettings.cfg.
--logfile=FILE Used with the --log option to specify the full path and filename
of the alternative log file.
avscc 167
EMC CONFIDENTIAL
Command Reference
Notes
The avscc.cfg file, discussed on page 435, is a flag file that contains options that are
passed to avscc when it is invoked. This flag file is located in the Avamar client var
directory. avscc.cfg is typically located in C:\Program Files\avs\var on Windows clients
and /usr/local/avamar/var on UNIX clients.
avsetup_avamarbin
The avsetup_avamarbin command creates the Avamar File System (AvFS) avamarbin
directories, which contain the platform-specific versions of the avacl program discussed
on page 59.
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.
Option Description
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_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.
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.
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.
Option Description
--app_root PATH Sets the application top level directory (that is $AVAMAR_ROOT).
The default setting is /usr/local/avamar.
--mcsaddr AVAMARSERVER Specifies which MCS to use to process Avamar Administrator CLI
commands.
This option added in version 4.0.
avsetup_ems 169
EMC CONFIDENTIAL
Command Reference
Option Description
--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.
--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_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.
Option Description
avsetup_mcs 171
EMC CONFIDENTIAL
Command Reference
Option Description
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
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, discussed on
page 312, 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.
Option Description
--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.
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_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]
avsetup_snmp 173
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the avsetup_snmp command.
Option Description
--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.
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.
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.
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.
Commands
Supply one and only one of the following commands on each command line for the
avsetup_wrapper command.
Command Description
help Shows help, then exits. Same as supplying the --help option.
Environment variables
The avsetup_wrapper command uses the following environment variables.
avsetup_wrapper 175
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}
Commands
Supply one and only one of the following commands on each avtar command line.
Command Description
--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.
avtar 177
EMC CONFIDENTIAL
Command Reference
Table 135 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.
“Wildcards” on page 49 provides additional information.
The default behavior is to recursively process all subdirectories.
Options
The following options are available for the avtar command.
Table 136 Command options for the avtar command (page 1 of 11)
Option Description
Table 136 Command options for the avtar command (page 2 of 11)
Option Description
avtar 179
EMC CONFIDENTIAL
Command Reference
Table 136 Command options for the avtar command (page 3 of 11)
Option Description
NUM-FILES/CACHE-PAGE-ESTIMATE
where:
• NUM-FILES is the number of files with sizes
greater than the value set for the
cache-musthave-threshold option.
• CACHE-PAGE-ESTIMATE is an estimate of the
number of cache pages.
The default is 64.
Table 136 Command options for the avtar command (page 4 of 11)
Option Description
avtar 181
EMC CONFIDENTIAL
Command Reference
Table 136 Command options for the avtar command (page 5 of 11)
Option Description
Table 136 Command options for the avtar command (page 6 of 11)
Option Description
avtar 183
EMC CONFIDENTIAL
Command Reference
Table 136 Command options for the avtar command (page 7 of 11)
Option Description
Table 136 Command options for the avtar command (page 8 of 11)
Option Description
avtar 185
EMC CONFIDENTIAL
Command Reference
Table 136 Command options for the avtar command (page 9 of 11)
Option Description
Table 136 Command options for the avtar command (page 10 of 11)
Option Description
avtar 187
EMC CONFIDENTIAL
Command Reference
Table 136 Command options for the avtar command (page 11 of 11)
Option Description
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 Service for additional
information before using them.
Table 137 Avamar-only advanced command options for the avtar command (page 1 of 7)
Option Description
--blocksize=BYTES Sets the number of bytes to read from one file at a time
during a backup. The default setting is 131072.
--checkrestoresize= If TRUE, then target disk is checked for adequate free space
{TRUE | FALSE} before starting a restore. The default setting is TRUE.
avtar 189
EMC CONFIDENTIAL
Command Reference
Table 137 Avamar-only advanced command options for the avtar command (page 2 of 7)
Option Description
--compthreshold=MAGIC Sets the composite block sticky byte magic number. The
default setting is 1152.
--controlport=PORT Sets the control port number. The control port is a socket
connection that avtar uses to monitor stats requests.
--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.
--dirthreshold=MAGIC Sets the directory block sticky byte magic number. The
default setting is 8192.
Table 137 Avamar-only advanced command options for the avtar command (page 3 of 7)
Option Description
--fixedatomsize=BYTES Sets the fixed size for atomic chunks (disables sticky).
avtar 191
EMC CONFIDENTIAL
Command Reference
Table 137 Avamar-only advanced command options for the avtar command (page 4 of 7)
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.
--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.
Table 137 Avamar-only advanced command options for the avtar command (page 5 of 7)
Option Description
--maxprefetch=SIZE Used with --parallel to set how much data each prefetch
thread is allowed to read before blocking occurs. The
default setting is 2048KB (2 MB).
--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.
--noconfig Does not read any configurations files while parsing flags.
Same as --ignoreconfig.
avtar 193
EMC CONFIDENTIAL
Command Reference
Table 137 Avamar-only advanced command options for the avtar command (page 6 of 7)
Option Description
--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.
Table 137 Avamar-only advanced command options for the avtar command (page 7 of 7)
Option Description
--usearchiveattr Forces backup of any files for which the operating system
archive bit is set.
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.
Option Description
avtar 195
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, discussed on page 432, then --id=USER@AUTH and
--password=PASSWORD are not required on the command line.
Examples
Although the following examples wrapsto 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 snaps 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
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.
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 197
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.
Table 139 Scribt subprocessing clauses for the avtar command (page 1 of 2)
Clause Description
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, or an empty string if desc=TEXT is not
defined.
$AVAMAR_VARDIR, $AVAMAR_BINDIR and $AVAMAR_SYSDIR
contain values corresponding to avtar --vardir, --bindir, and
--sysdir options, respectively.
exit-on-error=BOOL If BOOL is true, exit this process if the sub script exits with a
non-zero exit code. The default setting is false.
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","arg1 with spaces","arg2
with spaces"
Table 139 Scribt subprocessing clauses for the avtar command (page 2 of 2)
Clause 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-seconds=7200 on the avtar
command line sets the script timeout to 7200 seconds (2 hours).
create-stdout-pipe=BOOL If BOOL is true, create a stdout pipe with script. The default
setting is false.
create-stderr-pipe=BOOL 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, as
discussed on page 176.
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]
avtar.bin 199
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the axion_install command.
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.
--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.
--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.
Option Description
--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.
--timeout=SEC Specifies the timeout length in seconds (SEC) for Avamar services
running checks.
--version=VERSION Specifies the release tarball VERSION to use (for example, v4.0.1.100,
4.0.1.100).
Environment variables
The axion_install command uses the following environment variables.
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.
axion_install 201
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 filesystem feature on the Avamar server, use
dpnctl, discussed on page 237.
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.
Option Description
Option Description
--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.
--help Shows full online help (options and full descriptions), then
exits.
axionfs 203
EMC CONFIDENTIAL
Command Reference
Option Description
--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.
--singlethreaded Wraps all axionfs callbacks with a mutex. This is not the
default setting.
Notes
The --avamarmetadata and --avamarmetafile options are typically defined in the
/usr/local/avamar/var/axionfs.cmd configuration file.
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 Service for additional
information before using them.
Table 143 Avamar-only advanced command options for the axionfs command
Option Description
backup_upgrade_files
The backup_upgrade_files command backs up critical Avamar configuration files so that a
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.
Option Description
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
backup_upgrade_files 205
EMC CONFIDENTIAL
Command Reference
◆ /etc/resolv.conf
◆ /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
btfix
The btfix program prepares Avamar server logfiles for use by EMC Customer Service 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 use 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
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.
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.
Notes
This command added in version 4.1.
capacity.sh 207
EMC CONFIDENTIAL
Command Reference
Example
The following command lists capacity utilization for the past 10 days:
capacity.sh --days=10
Date New Data #BU Removed #GC Net Change
---------- ---------- ----- ---------- ----- ----------
2011-10-06 1364 mb 7 0 mb 1 1364 mb
2011-10-07 2827 mb 7 0 mb 1 2827 mb
2011-10-08 60186 mb 7 0 mb 1 60186 mb
2011-10-09 60187 mb 7 0 mb 1 60187 mb
2011-10-10 60187 mb 7 0 mb 1 60187 mb
2011-10-11 60196 mb 7 0 mb 1 60196 mb
2011-10-12 60187 mb 7 0 mb 1 60187 mb
2011-10-13 60187 mb 7 0 mb 1 60187 mb
2011-10-14 60187 mb 7 -46801 mb 2 13385 mb
2011-10-15 60189 mb 7 -99541 mb 1 -39351 mb
---------- ---------- ----- ---------- ----- ----------
Average 48570 mb -14634 mb 136.4 mb
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.
Option Description
--debug Enables debug mode, which shows messages programmers can use to
debug program execution.
--probedir=PATH Specifies the PATH to the directory that contains a legacy probe.out file.
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.
◆ 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.
change-passwords 209
EMC CONFIDENTIAL
Command Reference
◆ 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_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]
Options
The following options are available for the change_nodetype command.
Option Description
--system Configures and enables all necessary system services, such as, dhcpd, nfs, http,
and so forth.
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 Service.
check.dpn
The check.dpn command performs system integrity checks. It can be run directly and is
also called by start.dpn, which is discussed on page 389.
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]
check.dpn 211
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the check.dpn command.
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.
--nodedb=FILE Specifies the full path to a valid probe.xml file, which is discussed on
page 482.
The default is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.
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.
Option Description
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, discussed on page 482, to resolve
MODULE.NODE designations into actual IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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.
check.dpn 213
EMC CONFIDENTIAL
Command Reference
Examples
The following command runs all preinstall checks:
check.dpn --preinstall
The following command runs status checks defined in the cron/5min subdirectory:
check.dpn --checks=cron/5min
check.mcs
The check.mcs command performs integrity checks on the MCS. It can be run directly and
is called by mcserver.sh, discussed on page 306, 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.
Command Description
Options
The following option is available for the check.mcs command.
Option Description
checklib.pm
The checklib.pm file is a Perl module used by mcsmon_run, discussed on page 310,
monmcs, discussed on page 317, and pingmcs, discussed on page 338.
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,
discussed in “emserver.xml” on page 440.
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 (see “emserver.xml”
on page 440 and “mcserver.xml” on page 454). Edit those files to change the default
parameters, or use command line options to temporarily override the parameters.
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).
checklib.pm 215
EMC CONFIDENTIAL
Command Reference
Synopsis
clean_db.pl [--activities=DAYS]
[--activitiesfrom=DATE --activitiesto=DATE] [--audits=DAYS]
[--events=DAYS] [--nodespace=DAYS] [--nodeutil=DAYS]
Options
Supplying any of the following options for clean_db.pl overrides the default parameters
defined by emserver.xml and mcserver.xml.
Table 154 Command options for the clean_db.pl Perl script (page 1 of 2)
Option Description
Table 154 Command options for the clean_db.pl Perl script (page 2 of 2)
Option Description
Notes
This command added in version 3.7.1. Additional parameters and command line
arguments added in versions 6 and 6.1.
clean_db.pl 217
EMC CONFIDENTIAL
Command Reference
Pruning logic
A RECORDS parameter for a table (e.g. clean_db_events_records), in either a settings file or
on the command line, overrides the table’s DAYS parameter (e.g. 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.
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 Service.
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.
Option Description
--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, discussed on page 482. “Physical versus logical
node numbers” on page 478 provides additional information.
--norollback Does not remove certain temporary files that might remain
following a server rollback.
convert-probe
The convert-probe command converts a legacy probe.out file, discussed on page 477, to
an XML format. The new file is named probe.xml, which is discussed on page 482.
Synopsis
convert-probe [--debug] [--help] [--in=PATH] [--out=PATH] [--verbose]
Options
The following options are available for the convert-probe command.
Option Description
--debug Enables debug mode, which shows messages programmers can use to debug
program execution.
The default is --nodebug.
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.
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)
convert-probe 219
EMC CONFIDENTIAL
Command Reference
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.
Option Description
--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.
--liloconfig=FILE Specifies the lilo configuration FILE for destination hard drive.
--nocheck Does not perform source check or destination read-only bad block check.
--src=hdX Specifies the source hard drive (hdX). The default setting is hda.
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.
◆ 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):
◆ 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
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-ata-drive 221
EMC CONFIDENTIAL
Command Reference
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.
Option Description
--nodes=NODELIST Copies only selected source nodes. The default setting is #.#.
Option Description
--sprobedir=DIR Specifies the directory (DIR) for the existing source probe.xml file.
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.20030616081500 from the source Avamar
server to destination Avamar server specified using the --destination option:
copy-checkpoint --destination=avamar-1s,avamar-2s
--checkpoint=cp.20030616081500
This multi-line example copies checkpoint cp.20030616081500 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.20030616081500
The following example copies checkpoint cp.20030616081500 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.20030616081500
copy-checkpoint 223
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, discussed on page 88.
Synopsis
cp_cron [--nodelete] [--nolist] [--waittime=SEC]
Options
The following options are available for the cp_cron command.
Option Description
--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.
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.
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.
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.
cplist 225
EMC CONFIDENTIAL
Command Reference
Option Description
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.
Option Description
Output
Output conforms to the following format:
CHECKPOINT DATE CHECKED VALIDITY CHECK TYPE DELETABLE NODES
REFCOUNT/NODECOUNT NUMNODES STRIPES NUMSTRIPES
For example:
cp.20070402185644 Mon Apr 2 11:56:44 2007 valid hfs del nodes 6/6
stripes 414
Attribute Values
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.
Example
cplist
cp.20081116154531 Sun Nov 16 07:45:31 2011 valid hfs --- nodes 2/3 stripes
2008113013571
cp.20081117155032 Mon Nov 17 07:50:32 2011 valid --- --- nodes 2/3 stripes 13578
cp.20081117184533 Mon Nov 17 10:45:33 2011 valid rdc --- nodes 2/3 stripes 13578
cp.20081130203620 Sun Nov 30 12:36:20 2011 valid --- --- nodes 2/2 stripes 13586
cp.20081201161132 Mon Dec 1 08:11:32 2011 valid rdc --- nodes 2/2 stripes 13586
cp.20081201203712 Mon Dec 1 12:37:12 2011 valid --- --- nodes 2/2 stripes 13586
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
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.
Option Description
cps 227
EMC CONFIDENTIAL
Command Reference
Option Description
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.20090208070906
0.000 /data02/cp.20090208070906
0.000 /data03/cp.20090208070906
0.135 (null)/cp.20090207072952
0.141 /data02/cp.20090207072952
0.468 /data03/cp.20090207072952
0.123 (null)/cp.20090205070905
0.139 /data02/cp.20090205070905
0.462 /data03/cp.20090205070905
create_newconfigs
The create_newconfigs command reads the values from a config_info file, discussed on
page 437, 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.
Option Description
CRONJOB Specifies which cron job to run. Valid Avamar cron jobs are:
• 10minute_cron_run, discussed on page 50
• 5minute_cron_run, discussed on page 50
• cp_cron, discussed on page 224
• evening_cron_run, discussed on page 269
• gc_cron, discussed on page 273
• hfscheck_cron, discussed on page 282
• morning_cron_run, discussed on page 318
--debug Shows example session information but does not perform the specified actions.
create_newconfigs 229
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, which
is discussed on page 312.
Synopsis
dbcreate_mds [--force] [--nocreatedb]
Options
The following options are available for the dbcreate_mds command.
Option Description
--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.
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.
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.
Scripts
The dbmaint.sh shell script accepts one and only one of the following script files with the
--script=FILE option.
Table 168 Script files for the dbmaint.sh shell script (page 1 of 2)
Script Description
dbload.sh 231
EMC CONFIDENTIAL
Command Reference
Table 168 Script files for the dbmaint.sh shell script (page 2 of 2)
Script Description
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.
Notes
This shell script added in version 1.2. It supersedes and obsoletes mcdbmaint.sh,
discussed on page 297, and mcdbsql.sh, discussed on page 298.
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) 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}
Options
The following options are available 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.
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
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.
dbUpdateActivitiesExt.pl 233
EMC CONFIDENTIAL
Command Reference
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.
Option Description
--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.
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.
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.
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.
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 Service. Contact EMC Customer Service for
additional information.
◆ After deleting backups with this command, you should immediately run
dbUpdateactivitiesExt.pl, discussed on page 233, 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).
◆ 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
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
delete-snapups 235
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 172 Command options for the disktest.pl Perl script (page 1 of 2)
Option Description
--filesize=SIZE Specifies the SIZE of files in bytes. The default setting is 100K.
--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.
--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.
Table 172 Command options for the disktest.pl Perl script (page 2 of 2)
Option Description
--seeksperfile=NUM Specifies the number (NUM) of seeks per file. The default setting is
100.
--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, discussed on page 224, gc_cron,
discussed on page 273, and hfscheck_cron, discussed on page 282.
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}
Commands
Supply one and only one of the following commands on each command line for dpnctl.
Option Description
help Shows help, then exits. Same as supplying the --help option.
dpn.pm 237
EMC CONFIDENTIAL
Command Reference
Option Description
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 filesystem (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.
Options
The following options are available for the dpnctl command.
Option Description
Option Description
dpnctl 239
EMC CONFIDENTIAL
Command Reference
Option Description
Option Description
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.
Option Description
dpnctl 241
EMC CONFIDENTIAL
Command Reference
Notes
Consider the following notes for the dpnctl program:
◆ This program requires a valid probe.xml file, discussed on page 482, to resolve
MODULE.NODE designations into actual IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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 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.
Files
The dpnctl program uses the following files.
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 243
EMC CONFIDENTIAL
Command Reference
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 245
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:
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.
This performs the necessary system setup operations, including installing the init.d
startup script and running chkconfig.
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, discussed on page 237, 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.
Command Description
help Shows help, then exits. Same as supplying the --help option.
dpnfsctl 247
EMC CONFIDENTIAL
Command Reference
Options
The following options are available 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.
Environment variables
The dpnfsctl command uses the following environment variable.
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.
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.
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.
Log files
All log files are located in /usr/local/avamar/var/log/.
utility node dpnnetutil.log This is a detailed master log file for dpnnetutil.
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.
Files modified
The files in the following table are modified by dpnnetutil.
Update
Filename type Attributes updated Description
dpnnetutil 249
EMC CONFIDENTIAL
Command Reference
Update
Filename type Attributes updated Description
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.
The dpnnetutil program writes the configuration details to the
/usr/local/avamar/probe.xml file.
5. Use the nodedb print command, discussed on page 330, to view the contents of
probe.xml.
dpnnetutil 251
EMC CONFIDENTIAL
Command Reference
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:
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.
dpnnetutil 253
EMC CONFIDENTIAL
Command Reference
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.
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
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
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)
dpnnetutil 255
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.
Option Description
--help Shows full online help (commands, options and full descriptions),
then exits.
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.
◆ 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.
Attribute Description
Host Client hostname as defined in DNS. This is the client that is backing up data to the
Avamar server.
Root Starting location (top level directory) in the client filesystem for 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.
PcntCommon Data deduplication percentage during this backup. This is derived by way of the
following formula:
100 - (TotalBytes/ModSent)
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
dpnsummary 257
EMC CONFIDENTIAL
Command Reference
Attribute Description
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, discussed on page 313, 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.
here_services=IP Specifies the IP address of this Avamar server utility (services) node.
herenode_zero=IP Specifies the IP address of this Avamar server storage node zero.
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.
Option Description
--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).
dpn-time-config 259
EMC CONFIDENTIAL
Command Reference
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 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"
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.
Option Description
-f=NUM | -files=NUM | -p=NUM Number (NUM) of files to write. The default setting is 1.
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 2003 hostname=node-10-0-53-10
(node-10-0-53-10.local.avamar.com)
Wed Jan 29 19:49:40 2003 -dir=/data01
Wed Jan 29 19:49:40 2003 -patterns=1
Wed Jan 29 19:49:40 2003 -pass=1
Wed Jan 29 19:49:40 2003 -f=4
Wed Jan 29 19:49:40 2003 -bs=1048576 (KB:1024 mb:1048576
gb:1073741824) Wed Jan 29 19:49:40 2003 -fs=1073741824 Wed Jan 29
19:49:40 2003 Seed = 34464415 Wed Jan 29 19:49:40 2003 pattern=0 Wed
Jan 29 19:49:40 2003 filename=dt.0 Wed Jan 29 19:51:34 2003
filename=dt.0 (W:7659 G:3500) Wed Jan 29 19:51:34 2003 filename=dt.1
Wed Jan 29 19:53:32 2003 filename=dt.1 (W:7672 G:3601) Wed Jan 29
19:53:32 2003 filename=dt.2 Wed Jan 29 19:55:28 2003 filename=dt.2
(W:7697 G:3507) Wed Jan 29 19:55:28 2003 filename=dt.3 Wed Jan 29
19:57:15 2003 filename=dt.3 (W:6979 G:3269) Wed Jan 29 19:57:15 2003
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.*"
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, discussed on page 292,
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.
Option Description
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.
dump_accounts 263
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.
Option Description
--days=NUM Specifies the number (NUM) of days for which to print log
files.
Notes
This command added in version 5.0.
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}
Commands
Supply one and only one of the following commands on each command line for
emserver.sh.
Command Description
--help Shows full online help (commands, options and full descriptions), then exits.
--restart Shuts down all EMS services and restarts them. Each restart is logged.
--status Returns status of each EMS service and any available performance statistics.
--testwebapp Provides status of the Apache Tomcat service, which is installed along with
the EMS.
Options
The following options are available for the emserver.sh shell script.
Table 195 Command options for the emserver.sh shell script (page 1 of 2)
Option Description
--label=LABEL Specifies the flush label name from which to restore the EMS.
emserver.sh 265
EMC CONFIDENTIAL
Command Reference
Table 195 Command options for the emserver.sh shell script (page 2 of 2)
Option Description
--labelnum=NUM Specifies the flush sequence number (NUM) from which to restore
the EMS.
--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.
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.
Command Description
--restart Performs a stop, then a start. Equivalent to running emwebapp.sh --stop, then
emwebapp.sh --start.
Notes
The emwebapp.sh shell script must be run as root.
emwebapp.sh 267
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 Service 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 Service 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
(errchk-2011-03-07-0958.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 Service. While not all errors are serious, they should be reviewed by EMC
Customer Service. 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 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
Service.
◆ 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 Service.
◆ 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 Service. 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-2003-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-2003-03-19-1207.txt
evening_cron_run
The evening_cron_run program runs the evening cron job. It invokes cp_cron, discussed
on page 224, and gc_cron, discussed on page 273, and is itself intended to be invoked by
cron_env_wrapper, discussed on page 229.
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.
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 ...]
evening_cron_run 269
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the expire-snapups command.
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.
--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.
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.”
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.
Option Description
Files
The gathergsankeydata command uses the following files.
File Description
gathergsankeydata 271
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.
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.
--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.
--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 collects. 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.
Option Description
--thresholds=NUM Specifies the warning, read-only, and stop thresholds. The default settings
vary by model.
--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.
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, discussed on page 103.
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.
Option Description
--gccount=NUM Specifies the number (NUM) of index stripes per node to garbage
collect. The default setting is 16.
gc_cron 273
EMC CONFIDENTIAL
Command Reference
Option Description
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.
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, discussed on page 98, on exit and passing in the --convcount and
--convtime options.
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.
Option Description
--suppress If supplied, suppress any entries where zero bytes were freed.
--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.
gc_report 275
EMC CONFIDENTIAL
Command Reference
Example
gc_report
GARBAGE COLLECT GENERAL SUMMARY
/usr/local/avamar/var/cron/gc.log:
DATE #PASSES AVG BYTES FREED TOTAL BYTES FREED
2010/03/22-22:07:59 3 5,073,338,666 15,220,015,998
2010/03/23-10:08:21 3 4,264,684,525 12,794,053,575
2010/03/24-10:09:14 7 1,447,075,233 10,129,526,633
2010/03/26-10:06:25 57 138,388,837 7,888,163,702
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.
Option Description
--debug Shows example session information but does not perform the specified actions.
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
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
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, discussed on page 278, 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, discussed on page 449, 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]
gethostbyname 277
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the getlogs command.
Option Description
getnodelogs
The getnodelogs command is invoked by getlogs, discussed on page 277, 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.
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
Service 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.
Value Description
Value Description
Synopsis
getsnapupstats --path=LOCATION [--id=USER@AUTH]
[{--ap=PASSWORD | --password=PASSWORD}] [OPTIONS] [--max=n]
Options
The following options are available for the getsnapupstats command.
Option Description
OPTIONS avmgr or avtar options, discussed on page 154 and page 176,
respectively. These options are passed directly to avmgr and avtar
without interpretation.
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.
getsnapupstats 279
EMC CONFIDENTIAL
Command Reference
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
my-client.tgz created. You may delete the local temporary directory 'my-client'.
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 avupos command automates the OS upgrade from RHEL3 (32-bit version) to RHEL4
(64-bit version) on nodes running Avamar release 3.x. The EMC Avamar 4.1 System
Upgrade Manual provide more information about 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.
Option Description
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.
Output
The following excerpt is an example of the output from the health_check.pl program:
===========================================
==== Health Check Summary ====
===========================================
Logfile: /tmp/health.20110312-1405
Total Number of Errors: 3
Errors to be reviewed:
20110312-1405.49: ERROR: Last hfscheck was not successful! (errcode=4004)
20110312-1405.49: ERROR: Garbage collecting less than 10GB per pass! (averaging 3.79 GB)
20110312-1405.51: ERROR: Error(s) found in err.log file.
Please review /tmp/health.20110312-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 281
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. “Checkpoint verification” on
page 26 provides additional detailed technical information about the HFS check feature.
Beginning with version 5.0, this command has been deprecated in favor of avmaint
hfscheck, discussed on page 108.
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.
Option Description
Option Description
hfscheck_cron 283
EMC CONFIDENTIAL
Command Reference
Option Description
--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.
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 210 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.
Table 210 Deprecated command options for the hfscheck_cron command (page 2 of 2)
Option Description
--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.
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.
hfscheck_cron 285
EMC CONFIDENTIAL
Command Reference
Output
A description of hfscheck_cron output is available in “avmaint hfscheckstatus” on
page 113.
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.
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.
--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.
Option Description
--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.
--password=PASSWORD Specifies the PASSWORD for the --id account. Same as --ap and
--pswd.
--pswd=PASSWORD Specifies the PASSWORD for the --id account. Same as --ap and
--password.
--savesysinfo If supplied, special storage server (GSAN) cleanliness tests are run.
This is the default setting.
hfscheck_kill 287
EMC CONFIDENTIAL
Command Reference
Option Description
hfsclean
The hfsclean command deletes all data currently stored in the Avamar server. It is used by
restart.dpn, discussed on page 367, start.dpn, discussed on page 389, 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.
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.
Option Description
Option Description
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.
Option Description
--config=PATH Specify the path to configuration file that contains attribute/value pairs.
Notes
This command added in version 6.0.
initialize_connectemc 289
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.
Command Description
mccli Update JRE used by Avamar Management Console Command Line Interface (MCCLI).
Options
The following option is available for the java_update.sh command.
Option Description
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.
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.
lm 291
EMC CONFIDENTIAL
Command Reference
Option Description
--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.
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.
load_accounts
The load_accounts command reads one or more files previously generated by
dump_accounts, which is discussed on page 263, 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.
Option Description
Option Description
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.
logmrg
The logmrg command can only be run after getlogs, which is discussed on page 277. 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.
Option Description
--duration=HOURS Used with --start to merge logs for number of HOURS after the start time.
--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 is
gsan.log.
--logout=LOCATION Specifies the LOCATION to store the merged output. The default is stdout.
--nodedb=FILE Specifies the full path to a valid probe.xml file, discussed on page 482.
The default is /usr/local/avamar/var/probe.xml.
logmrg 293
EMC CONFIDENTIAL
Command Reference
Option Description
--start=DATETIME Starts merging logs beginning tat the specified date and time (DATETIME).
You can truncate this value to the desired resolution.
If time is present, it must follows a dash (-).
mapall
The mapall command runs the same command on all of the nodes in the Avamar server. It
uses probe.xml, discussed on page 482, 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. “Elements and attributes used by the probe.xml file” on
page 482 provides additional information.
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.
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.
--bg Runs COMMAND in the background and does not wait for it to complete.
--checkpointdir=DIR Specifies the directory (DIR) where the data is located on each /data0?
mount. The default location is 'cur'.
--error Does not continue if error occurs. The default behavior is to terminate
script session after an error occurs.
--givestatus
--hfsdir=PATH Specifies the root location where the /data0? data mounts are located
on the storage nodes. The default setting is '/'.
mapall 295
EMC CONFIDENTIAL
Command Reference
Option Description
--ping_only Checks node connectivity using an ICMP ping test. By default, the
mapall program runs 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.
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.
Option Description
Notes
Consider the following notes for the mapall command:
◆ Before Avamar 5.0, the mapall program used probe.out, discussed on page 477, 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, discussed on page 428, 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, discussed on page 429. 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’
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,
discussed on page 231.
It performs the same functions as mcdbsql.sh, discussed on page 298. 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}
mcdbmaint.sh 297
EMC CONFIDENTIAL
Command Reference
Options
The mcdbmaint.sh shell script accepts one and only one of the following .sgl files as a
command line option.
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.
dbmaint.sql Frees unused hard drive space by running an SQL vacuum command
against the mcdb.
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.
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,
discussed on page 231.
It performs the same functions as mcdbmaint.sh, discussed on page 297. 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.
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.
dbmaint.sql Frees unused hard drive space by running an SQL vacuum command
against the mcdb.
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.
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.
mcconfigfirewall_snmp 299
EMC CONFIDENTIAL
Command Reference
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 user 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 300.
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 300.
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/
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.
Command Description
Options
The following options are available for the mcddrsnmp shell script.
Option Description
mcddrsnmp 301
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.
Option Description
Notes
This command added in version 4.1.
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 226 Command options for the mcflush.pl Perl script (page 1 of 2)
Option Description
Table 226 Command options for the mcflush.pl Perl script (page 2 of 2)
Option Description
--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.
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 227 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 (/).
-mcsuserid USER-ID Specifies the Avamar administrative user account (USER-ID) to use to
launch the Avamar Administrator graphical management console.
mcgui.bat 303
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.
Option Description
-domain DOMAIN Specifies the top-level client domain for this Avamar Administrator
session. The default setting is root (/).
-mcsuserid USER-ID Specifies the Avamar administrative user account (USER-ID) to use to
launch the Avamar Administrator graphical management console.
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 229 Command options for the mcgui_login.bat DOS batch file (page 1 of 2)
Option Description
MCS-USER-ID Specifies the Avamar administrative user account (MCS-USER-ID) to use to log in
to Avamar Administrator.
Table 229 Command options for the mcgui_login.bat DOS batch file (page 2 of 2)
Option Description
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 230 Return codes for the mcgui_login.bat DOS batch file
Code Description
0 Command succeeded.
1 Command failed.
Event codes
The following event codes are returned by the mcgui_login.bat DOS batch file.
Table 231 Event codes for the mcgui_login.bat DOS batch file
mcgui_login.bat 305
EMC CONFIDENTIAL
Command Reference
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.
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}
Commands
Supply one and only one of the following commands on each command line for the
mcserver.sh shell script.
Command Description
--help Shows full online help (commands, options and full descriptions), then
exits.
--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.
--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.
mcserver.sh 307
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the mcserver.sh shell script.
Table 233 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.
--hfsport=PORT Used with --restore to restore from the Avamar server at this data
PORT.
--labelnum=NUM Used with --restore to specify which existing MCS backup (flush)
should be used for the restore operation.
--noinstallcron Used with --start to specify that dpn user crontab should not be
installed. This is not the default setting.
Table 233 Command options for the mcserver.sh shell script (page 2 of 2)
Option Description
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.
◆ 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.
mcserver.sh 309
EMC CONFIDENTIAL
Command Reference
◆ 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.
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?
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
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.20110117.111101 in this
example), type the following on a single command line:
mcserver.sh --restore --flushtype=local
--flushfile=mcflush.20110117111101
mcsmon_run
The mcsmon_run command runs monmcs, discussed on page 317, 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.
Command Description
Options
The following option is available for the mcsnmp command.
Option Description
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.
mcsnmp 311
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.
Option Description
--dumpfile=FILE Used with --dump to specify location of output file for the dump.
Used with --load to specify which dump file to load.
--update Update the metadata search database and preferences following an access
node software upgrade.
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.
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, discussed on page 52, 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.
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.
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.
Option Description
mktime 313
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,
discussed on page 52, 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, discussed on
page 428, 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, discussed on page 406, 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, discussed on page 52, does this automatically.
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.
Command Description
Options
The following options are available for the modify-snapups command.
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.
modify-snapups 315
EMC CONFIDENTIAL
Command Reference
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.
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 Service. Contact EMC Customer Service for
additional information.
◆ After modifying backups with this program, you should immediately run
dbUpdateactivitiesExt.pl, discussed on page 233, 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).
◆ 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, discussed on page 234.
◆ Invoking modify-snapups --mode=expire is the same as running the expire-snapups
program, discussed on page 269.
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
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
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.
Option Description
--dryrun Shows example session information but does not perform the specified actions.
monmcs
The monmcs command obtains MCS status by running mcserver.sh --status.
Synopsis
monmcs [--mail]
mondo 317
EMC CONFIDENTIAL
Command Reference
Options
The following option is available 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.
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, discussed on page 229.
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.
Option Description
--debug Shows example session information but does not perform the specified actions.
morning_cron_run
The morning_cron_run command runs the morning cron job. morning_cron_run calls
cp_cron, discussed on page 224, gc_cron, discussed on page 273, and hfscheck_cron,
discussed on page 282, and is intended to be invoked by cron_env_wrapper, discussed
on page 229.
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.
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, discussed on
page 248, which also updates other system files, before using nodedb.
In Avamar 5.0 and later versions, the probe.xml file, discussed on page 482, replaces the
probe.out file, discussed on page 477.
Synopsis
nodedb {add node | add if | create | delete if | delete module
| delete nat | delete node | print | update if | update module
| update node}
Commands
Supply one and only one of the following commands with nodedb.
Command Description
delete nat Deletes a Network Address Translation (NAT) entries from all network
interfaces.
A complete discussion of delete nat behavior and syntax is available in
“nodedb delete nat” on page 329.
nodedb 319
EMC CONFIDENTIAL
Command Reference
Command Description
Global options
The following global options are available for the nodedb command.
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).
--nolegacy Updates the legacy node resource database (probe.out) after updating
the new node resource database (probe.xml).
The default 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.
$SYSNODEDB Path of the node resource database file. This file need not be named
probe.xml.
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.
Use the following command to show which node resource database file is selected:
nodedb print --say
nodedb 321
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.
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.
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.
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.
“Module and node reference notation” on page 321 provides
more information.
nodedb 323
EMC CONFIDENTIAL
Command Reference
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>
Notes
This command added in version 5.0.
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 250 Command options for the nodedb add node command
Option Description
--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.
--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.
“Module and node reference notation” on page 321 provides
more information.
Use --after | --before | --replace with this option.
nodedb 325
EMC CONFIDENTIAL
Command Reference
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>
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>
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>
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>
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.
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.
Option Description
---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.
nodedb 327
EMC CONFIDENTIAL
Command Reference
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 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.
Option Description
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.
Synopsis
nodedb delete module --index=INDEX
Command options
The following command option is available for the nodedb delete module command.
Table 253 Command options for the nodedb delete module command
Option Description
Example
To delete a module at index 0, type:
nodedb delete module --index=0
Notes
This command added in version 5.0.
Synopsis
nodedb delete nat --nat=INITIAL-ADDRESS[=TARGET-ADDRESS]
Command options
The following command option is available for the nodedb delete nat command.
Table 254 Command options for the nodedb delete nat command
Option Description
Example
To delete a nat-address element for IP address 192.168.100.12, type:
nodedb delete nat --nat=192.168.100.12
nodedb 329
EMC CONFIDENTIAL
Command Reference
Notes
This command added in version 5.0.
Synopsis
nodedb delete node --node=NODE-ID
Command options
The following command option is available for the nodedb delete node command.
Table 255 Command options for the nodedb delete node command
Option Description
--node=NODE-ID Specifies a node by using its module and physical node number. “Module and
node reference notation” on page 321 provides more information.
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 print
The nodedb print command displays all or selected parts of the probe.xml file, discussed
on page 482. 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.
Option Description
Modifiers
The --nodes=NODELIST option can use one or more of the following modifiers.
Table 257 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
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 including the full path and
filename of the node resource database in use, type:
nodedb print --say
nodedb 331
EMC CONFIDENTIAL
Command Reference
Notes
This command added in version 5.0.
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.
Option Description
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
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=
Notes
This command added in version 5.0.
Synopsis
nodedb update module --index=INDEX --new-name=NAME
Command options
The following command options are available for the nodedb update module command.
Table 259 Command options for the nodedb update module command
Option Description
nodedb 333
EMC CONFIDENTIAL
Command Reference
Example
nodedb update module --index=0 --new-name=avamar01
Notes
This command added in version 5.0.
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 260 Command options for the nodedb update node command
Option Description
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.
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.
“Physical versus logical node numbers” on page 478 provides additional information.
The nodenumbers program compares the contents of the probe.out file, discussed on
page 477, to the output of the avmaint nodelist command, which is discussed on
page 128. 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.
Option Description
nodenumbers 335
EMC CONFIDENTIAL
Command Reference
Option Description
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.
Option Description
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, discussed on page 477, to resolve
MODULE.NODE designations into actual IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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 2003
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 2002 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.
opstatus.dpn
The opstatus.dpn command returns Avamar server operational status as one of the
following messages or exit codes.
server unresponsive 3
Synopsis
opstatus.dpn [--help] [--quiet]
Options
The following options are available for the opstatus.dpn command.
Option Description
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
non-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.
permctl
Te 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]
opstatus.dpn 337
EMC CONFIDENTIAL
Command Reference
Commands
Supply one and only one of the following commands on each permctl command line.
Command Description
Options
The following options are available for the permctl command.
Option Description
--debug Shows example session information but does not perform the specified
actions.
--quietly When supplied with fix command, does not report on fixed ownership or
permissions.
pingmcs
The pingmcs command pings the MCS.
Synopsis
pingmcs [--mail]
Options
The following option is available 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, discussed on page 477, 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, discussed on page 319, to generate a probe.xml
file. Additional information is available in “probe.xml” on page 482.
Synopsis
probe [--admin=IP-ADDR] [--help] [--mcs=IP-ADDR] [--nat] [--nodes=NUM]
[--probedir=PATH] [--single] [--sort={ascending | descending}]
AVAMARSERVER
Options
The following options are available for the probe command.
Option Description
--nodes=NUM Specifies the number (NUM) of nodes to probe. The default setting is all.
probe 339
EMC CONFIDENTIAL
Command Reference
Notes
Consider the following notes for the probe command:
◆ This command reads a default operating system user ID from the SYSPROBEUSER
environment variable, discussed on page 429. 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, discussed on page 428 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, discussed on page 339.
Documentation for this script is provided for reference purposes only. Do not run probeaux
directly from the command line.
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.
Option Description
Notes
This program requires a valid probe.out file to resolve MODULE.NODE designations into
actual IP addresses. The SYSPROBEDIR environment variable, discussed on page 428,
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.
probesingle
The probesingle command generates a probe.out file, discussed on page 477, on
single-node servers only. It is functionally equivalent to running probe --single, which is
discussed on page 339.
Synopsis
probesingle [--help] [--probedir=PATH] AVAMARSERVER
Options
The following options are available for the probesingle command.
Option Description
probesingle 341
EMC CONFIDENTIAL
Command Reference
Notes
By default, probe.out is saved in the /usr/local/avamar/var directory. If the SYSPROBEDIR
environment variable, discussed on page 428, is set, then probe.out is saved to that
location.
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, discussed on page 367. 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, discussed on page 237, 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.
Option Description
--debug Shows example session information but does not perform the specified
actions.
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.
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.
pull-checkpoint
The pull-checkpoint command retrieves selected checkpoints tar bundles that were
previously saved using store-checkpoint, discussed on page 402.
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.
Option Description
--debug Shows example session information but does not perform the specified
actions.
--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.
--srckey=FILE Specifies the path to source Avamar server OpenSSH dpnid key FILE.
pull-checkpoint 343
EMC CONFIDENTIAL
Command Reference
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
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.
Option Description
--copy Copies files to the storage nodes. This is the default setting.
--debug Shows example session information but does not perform the
specified actions.
--force Forces the server to be run even if there are stripes present on the
node. 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 '/'.
--kill Terminates any running Avamar processes before starting. This is not
the default setting.
rebuild.node 345
EMC CONFIDENTIAL
Command Reference
Option Description
--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. Additional information is available in
“avmaint logscan” on page 119.
--sslport=PORT Specifies the SSL data PORT. The default setting is 29000.
--usealtlogdir If set, uses the alternative log directory name as defined with the
altlogdir option of the gsan command.
--wait Calls wait.dpn, discussed on page 422, 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 Service for additional
information before using them.
Table 275 Avamar-only advanced command options for the rebuild.node command
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=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 276 Deprecated command options for the rebuild.node command (page 1 of 2)
Option Description
rebuild.node 347
EMC CONFIDENTIAL
Command Reference
Table 276 Deprecated command options for the rebuild.node command (page 2 of 2)
Option Description
Notes
Consider the following notes for the rebuild.node command:
◆ Do not use both start.nodes, discussed on page 397, 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, discussed on page 482, to resolve
MODULE.NODE designations into actual IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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.
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, discussed on page 487.
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, discussed on page 348. The replicate
program performs some housekeeping functions, then invokes replicate using settings
stored in the repl_cron.cfg configuration file, discussed on page 487. 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
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, discussed on page 487. Therefore, these values do not typically have
to be included in the repl_cron.cfg configuration file or on the command line.
Value Description
replicate 349
EMC CONFIDENTIAL
Command Reference
Value Description
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.
Command Description
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.
Descriptor Description
--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.
replicate 351
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the replicate command.
Option Description
Option Description
--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.
replicate 353
EMC CONFIDENTIAL
Command Reference
Option Description
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 Service for additional
information before using them.
Table 281 Avamar-only advanced command options for the replicate command (page 1 of 3)
Option Description
--allsnapups If set false, only the most recent backup for each client is
replicated. The default setting is true.
--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.
Table 281 Avamar-only advanced command options for the replicate command (page 2 of 3)
Option Description
--copysnapups If set false, new accounts are created on the destination server but
no backups are copied. The default setting is true.
--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.
replicate 355
EMC CONFIDENTIAL
Command Reference
Table 281 Avamar-only advanced command options for the replicate command (page 3 of 3)
Option Description
--threshold=NUM Sets the atomic block sticky byte magic number (NUM). The default
setting is 30000.
This option added in version 4.0.
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 (/).
Descriptor Description
003 NDMP
008 Replication
Valid 4- or 5-digit operating system designators are listed in the following table.
Descriptor Description
1000 Linux
4000 HP-UX
9000 Debugging
11000 FreeBSD
For example:
◆ 009 is a 3-digit plug-in ID that designates all DB2 backups, regardless of operating
system. Therefore, both IBM AIX and Microsoft Windows operating systems would be
included or excluded.
◆ 2000 is a 4-digit Solaris operating system designator. Therefore, Solaris filesystem
backups as well as Oracle backups originating from databases hosted on Solaris
platforms would be included or excluded.
◆ 8003 is a 4-digit compound designator that specifies only EMC Celerra NDMP
backups.
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.
replicate 357
EMC CONFIDENTIAL
Command Reference
This command should be run in the background with nohup so that you can log out of the
system without interrupting this replication job.
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,
discussed on page 248.
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.
Option Description
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.
◆ Expect and ignore the following error messages in the log file:
database "mcdb" already exists (from MCS)
User or account already exists (from EMS)
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)
resite 359
EMC CONFIDENTIAL
Command Reference
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:
mcserver.sh --flush
8. When prompted for a password, type the root password and press Enter.
9. Type:
resite
Answer each of the remaining questions with information you collected in step 1 .
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:
resite 361
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:
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:
resite 363
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:
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:
resite 365
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.
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:
tail /usr/local/avamar/var/resite.log
28. Ensure that resite has completed without errors before resuming normal server
operation.
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.
Option Description
--checkpointdir=DIR Specifies the directory (DIR) where the data is located on each
/data0? mount. The default location is 'cur'.
restart.dpn 367
EMC CONFIDENTIAL
Command Reference
Option Description
--copy Copies files to the storage nodes. This is not the default setting.
--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.
Option Description
--rollbackdir=DIR Specifies which checkpoint directory (DIR) to use for the server
rollback.
--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. Additional information is available
in “avmaint logscan” on page 119.
--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.
--usealtlogdir If set, uses the alternative log directory name as defined with
the altlogdir option of the gsan command.
restart.dpn 369
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 Service for additional
information before using them.
Table 286 Avamar-only advanced command options for the restart.dpn command
Option Description
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.
Option Description
--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.
restart.dpn 371
EMC CONFIDENTIAL
Command Reference
Notes
Consider the following notes for the restart.dpn command:
◆ This program requires a valid probe.xml file, discussed on page 482, to resolve
MODULE.NODE designations into actual IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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, discussed on page 348, is affected.
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, discussed on page 225, 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.
Option Description
--copy If supplied, files are copied to the storage nodes. This is the
default behavior.
--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.
rollback.dpn 373
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.
Option Description
Notes
This program requires a valid probe.xml file to resolve MODULE.NODE designations into
actual IP addresses. The SYSPROBEDIR environment variable, discussed on page 428,
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.
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.
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.
--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.
sched.sh 375
EMC CONFIDENTIAL
Command Reference
Examples
sched.sh
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.
More information about the use of optional nodes is available in “probe.xml” on
page 482.
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. “Elements and attributes used by the probe.xml file” on
page 482 provides more information.
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.
Option Description
--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.
scn 377
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 292 Avamar-only advanced command options for the scn command
Option Description
Notes
Consider the following notes for the scn command:
◆ Before Avamar 5.0, the scn program used probe.out, discussed on page 477, 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, discussed on page 428, 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, discussed on page 429. If SYSPROBEUSER is not set, then
remote commands are run as user admin.
Examples
Consider a typical scp command line:
scp admin@10.0.22.10:/data01/cur/gsan.opt .
The equivalent scn command allows you to use MODULE.NODE syntax as follows:
scn 0.0:/data01/cur/gsan.opt .
securedelete
The securedelete command is a public interface to avmgr getb and delb commands,
discussed on page 154, 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.
Command Description
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.
Option Description
Notes
This command added in version 5.0.
securedelete 379
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.
showperfhistory
The showperfhistory command runs the avmaint perf status command, discussed on
page 129, 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
showperfhistory [--noreset] [--zeroaverages]
Options
The following options are available for the showperfhistory command.
Option Description
--noreset Suppresses display of suggested the avmaint perf reset command, discussed
on page 129, 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.
Column Description
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.
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.
showperfhistory 381
EMC CONFIDENTIAL
Command Reference
Column Description
Event-Bits Shows numeric encoding for the set of events listed in the Events column.
shutdown.dpn
The shutdown.dpn command shuts down the Avamar server. It wraps avmaint commands,
which are discussed starting on page 73.
Synopsis
shutdown.dpn [--kill] [--nocheckhfs] [--nocheckserver]
[{--now | --nowait}] [--pollinterval=SEC]
Options
The following options are available 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.
--nocheckserver Causes shutdown.dpn to not wait for all Avamar server processes to
gracefully exit before performing the shutdown.
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.
Option Description
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.
shutdown.dpn 383
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
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
==================
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 : 2005
ID : 1
Status : Ok
State : Ready
Layout : RAID-5
site_inventory 385
EMC CONFIDENTIAL
Command Reference
BIOS Information
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, discussed on
page 482.
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. “Elements and attributes used
by the probe.xml file” on page 482 provides more information.
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.
Option Description
--n Shows example session information but does not perform the
specified actions.
--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.
ssn 387
EMC CONFIDENTIAL
Command Reference
Option Description
--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.
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.
Option Description
Notes
Consider the following notes for the ssn program:
◆ Before Avamar 5.0, the ssn program used probe.out, discussed on page 477, 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, discussed on page 482, to resolve
MODULE.NODE designations into IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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, discussed on page 429. If SYSPROBEUSER is not set, then
remote commands are run as user admin.
Examples
Consider a typical ssh command line:
ssh admin@10.0.22.10 ’COMMAND’
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,
discussed on page 367.
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}]
start.dpn 389
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the start.dpn command.
Option Description
Option Description
start.dpn 391
EMC CONFIDENTIAL
Command Reference
Option Description
--noinit Does not run initacnt and avmaint init (pre 1.2.1
behavior). The default setting is --init.
--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.
Option Description
start.dpn 393
EMC CONFIDENTIAL
Command Reference
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 Service for additional information before
using them.
Table 302 Avamar-only advanced command options for the start.dpn command
Option Description
--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 node’s 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.
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 303 Deprecated command options for the start.dpn command (page 1 of 3)
Option Description
Table 303 Deprecated command options for the start.dpn command (page 2 of 3)
Option Description
start.dpn 395
EMC CONFIDENTIAL
Command Reference
Table 303 Deprecated command options for the start.dpn command (page 3 of 3)
Option Description
Notes
Consider the following notes for the start.dpn command:
◆ If the Avamar username and password are present in the .avamar file, discussed on
page 432, then --id=USER@AUTH and --password=PASSWORD are not required on the
command line.
◆ This program requires a valid probe.xml file, discussed on page 482, to resolve
MODULE.NODE designations into actual IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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.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.
Option Description
--checkpointdir=DIR Specifies the directory where the data is on each /data0? mount. The
default setting is cur.
--copy Copies files to the storage nodes. This is the default setting.
--hfsdir=PATH Specifies the root location where the /data0? data mounts are located
on the storage nodes. The default setting is '/'.
--kill Terminates any running Avamar processes before starting. This is not
the default setting.
--newdatacenter Specifies that this new node is in a new module (datacenter) that is
being created.
start.nodes 397
EMC CONFIDENTIAL
Command Reference
Option Description
--usewritelogheaders Enables a feature that periodically updates the server writelog header
to prevent writelog corruption. 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 Service for additional
information before using them.
Table 305 Avamar-only advanced command options for the start.nodes command
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=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.
Option Description
Notes
This program requires a valid probe.xml file, discussed on page 482, to resolve
MODULE.NODE designations into actual IP addresses. The SYSPROBEDIR environment
variable, discussed on page 428, 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.
stats.sh 399
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,
discussed on page 73.
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.
Option Description
INTERVAL Time INTERVAL in seconds between status updates. typing zero (0)
returns a single status report and exits (does not loop).
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.
Status Description
Ready Transitional state that might or might not be due to normal operation.
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.
Bit Description
m Maintenance is allowed.
h HFS is writable.
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.
status.dpn 401
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, discussed on page 343, 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.
Option Description
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.20030616080300
--cp=cp.20030616080900 --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.20030616080300 --cp=cp.20030616080900 --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.
Synopsis
stunctl [--debug] [--help] [--nodes=DESCRIPTOR] [--sslport=PORT]
[--verbose] {help | restart | start | status | stop}
stunctl 403
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the stunctl 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.
--nodes=DESCRIPTOR Specifies which nodes should be affected by this stunctl action, where
DESCRIPTOR is one or more logical node designations. “Physical versus
logical node numbers” on page 478 provides additional information.
--sslport=PORT Specifies the SSL data PORT. The default setting is 29000.
Commands
Supply one and only one of the following commands on each command line for the stunctl
command.
Command Description
help Shows help, then exits. Same as supplying the --help option.
Environment variables
The stunctl command uses the following environment variable.
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
suspend_crons
The suspend_crons command suspends activity of any of the Avamar server cron scripts.
Currently, only repl_cron, discussed on page 348, is affected. The execution of suspended
scripts can be continued with the resume_crons script, discussed on page 372.
Synopsis
suspend_crons [--autoonly]
Options
The following option is available 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, discussed on page 229, 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.
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.
Command Description
suspend_crons 405
EMC CONFIDENTIAL
Command Reference
Options
The following options are available for the swraidctl command.
Option Description
--debug Shows example session information but does not perform the specified actions.
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, discussed on page 52, 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.
Option Description
--configdir=DIR Specifies the directory (DIR) containing time configuration files created
by mktime, discussed on page 313. 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.
--nodedb=FILE Specifies the full path to a valid probe.xml file, discussed on page 482.
The default is /usr/local/avamar/var/probe.xml.
This option added in version 5.0.
Option Description
--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. “Physical versus logical node numbers” on page 478 provides
additional information.
--set=DATE-TIME Sets the initial date and time (DATE-TIME) value for /bin/date --set.
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.
Option Description
Notes
This program requires a valid probe.xml file to resolve MODULE.NODE designations into
actual IP addresses. The SYSPROBEDIR environment variable, discussed on page 428,
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, discussed on page 313.
Files modified on Avamar nodes by the timedist command include:
◆ /etc/ntp.conf
◆ /etc/ntp/step-tickers
◆ /etc/localtime
◆ /etc/sysconfig/clock
timedist 407
EMC CONFIDENTIAL
Command Reference
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.
Troubleshooting
The following table describes how to recover from common problems encountered when
running timedist.
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,
discussed on page 389.
Documentation for this script is provided for reference purposes only. Do not run
timerange directly from the command line.
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, discussed on page 406, or the ntpd_keepalive
cron job and should not be run directly from the command line.
Synopsis
timesyncmon {--install | --keep_alive | --shutdown}
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.
Command Description
Options
The following options are available for the timesyncmon command.
Option Description
--debug Shows example session information but does not perform the
specified actions.
timesyncmon 409
EMC CONFIDENTIAL
Command Reference
Option Description
Notes
This program runs in one of three modes.
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.
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
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, discussed on page 237, 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.
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.
Commands
Supply one and only one of the following commands on each command line for the
tomcatctl command.
Command Description
help Shows help, then exits. Same as supplying the --help option.
Environment variables
The tomcatctl command uses the following environment variables.
tomcatctl 411
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.
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.
Option Description
--debug Shows example session information but does not perform the specified
actions.
--node=IP-ADDR Specifies where the SSH keys will be copied, where IP-ADDR is target node’s IP
address.
truncate
The truncate command truncates the contents of a file. The hfscheck_kill program,
discussed on page 286, 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, discussed on page 389.
Documentation for this script is provided for reference purposes only. Do not run truncate
directly from the command line.
ugcheck
The ugcheck command checks each node for upgrade-readiness. It checks each storage
node that is listed in the probe.xml, discussed on page 482, 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.
Option Description
ugcheck 413
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.
Option Description
--src=DIRECTORY Uses DIRECTORY as the source of operating system image tarballs instead of
/data01/ugprep.
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
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.
Option Description
--os_src=PATH Specifies the location of the OS image tarball when it is located in a directory
other than /data01/ugprep/.
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.
ugprep 415
EMC CONFIDENTIAL
Command Reference
Table 331 Maintenance partition files migrated or updated by the ugprep command
File Description
/rootalt/etc/sysconfig/network-scripts/ifcfg-eth* Copies of
/etc/sysconfig/network-scripts/ifcfg-eth*,
network interface configuration files.
The ugprep program migrates or updates the following Avamar storage server files.
Table 332 Storage server files migrated or updated by the ugprep command
File Description
File Description
Table 334 NTP files migrated or updated by the ugprep command (page 1 of 2)
File Description
ugprep 417
EMC CONFIDENTIAL
Command Reference
Table 334 NTP files migrated or updated by the ugprep command (page 2 of 2)
File Description
File Description
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/
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/
ugprep 419
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.
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.
--hfs If supplied, wait applies to HFS stripes. This is the default setting.
--multiday If supplied, continue to wait after a rollover. This is not the default
setting.
--persistent If supplied, wait applies to persistent store stripes. This is not the
default setting.
--rollover If supplied, issue the avmaint crunch rollover, discussed on page 99,
before waiting.
Option Description
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.
Option Description
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, discussed on
page 432, 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, discussed on
page 428, 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.
wait.crunch 421
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, discussed on page 367.
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.
Option Description
--hfsport=PORT Sets the Avamar server PORT number. The default setting is 27000.
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.
Command Description
init Stops the web server if it is running and then performs some initialization.
2. When prompted for a password, type the root password and press Enter.
website 423
EMC CONFIDENTIAL
Command Reference
Ignore any FAILED status indications during web server shutdown. This is normal.
Ignore any FAILED status indications during web server shutdown. This is normal.
The Please click here to transfer to the secure login page appears.
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.
zzdpn 425
EMC CONFIDENTIAL
Command Reference
CHAPTER 3
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, which is discussed on page 482.
SYSPROBEDIR
This variable stores the path to a directory where a valid probe.out file is located. The
probe.out file is discussed in “probe.out” on page 477. If not set, then
/usr/local/avamar/var is used. Utilities that use SYSPROBEDIR are listed in the following
table.
asktime page 52
SYSPROBEUSER
This variable stores an operating system user ID. If set, certain utilities run as that user.
Utilities that use SYSPROBEUSER are listed in the following table.
If not set, then the utility runs as user admin. Typical user IDs stored by this variable are:
root, admin, or dpn.
SYSPROBEUSER 429
EMC CONFIDENTIAL
Environment Variables
CHAPTER 4
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, which is discussed on page 487.
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, which is discussed on
page 61, 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">
com.avamar.asn.module.datastore
The following table describes the elements for com.avamar.asn.module.datastore.
Element Description
upgrade_script_startswith aviupgrade
com.avamar.avi
The following table describes the elements for com.avamar.avi.
Element Description
tomcatDir Location of the symlink to the Tomcat server directory, which points
to the actual Tomcat server directory.
avinstaller.xml 433
EMC CONFIDENTIAL
Important Files
com.avamar.avi.repo
The following table describes the elements for com.avamar.avi.repo.
Element Description
com.avamar.avigui
The following table describes the elements for com.avamar.avigui.
Element Description
com.avamar.mc.compatibility
The following table describes the elements for com.avamar.mc.compatibility.
Element Description
com.avamar.mc.dpn
The following table describes the elements for com.avamar.mc.dpn.
Element Description
Element Description
com.avamar.mc.mcsvars
The following table describes the elements for com.avamar.mc.mcsvars.
Element Description
avscc.cfg
The avscc.cfg file is a flag file that contains options that are passed to avscc. which is
discussed on page 166, when it is invoked. This flag file is located in the Avamar client var
directory. The avscc.cfg file is typically located in C:\Program Files\avs\var on Windows
clients and /usr/local/avamar/var on UNIX clients.
avscc.cfg 435
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, discussed on
page 389. The EMC Avamar Server Software Installation Guide provides more information
about avw_install.
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, discussed on page 202, 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.20051215000403"
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>
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, discussed on page 229, 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.
Entry Description
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.
Entry Description
NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.
config_info 437
EMC CONFIDENTIAL
Important Files
Entry Description
NAMESERVERIP IP address of the customer DNS server. This entry can be blank.
Entry Description
NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.
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.
Entry Description
CATNAME Network hostname as defined in DNS for this Avamar CAT server.
NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.
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.
Entry Description
NETINFO Subnet and subnet mask of this server. For example, 192.168.0.0/16.
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.
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.
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 439
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">
com.avamar.asn
The following table describes the global EMS settings in com.avamar.asn.
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.
Element Description
service_context_port Data port used for EMS service communication. The default setting is
8780.
com.avamar.asn.module.datastore
The following table describes the EMS database settings in
com.avamar.asn.module.datastore.
Element Description
clean_db_start Specifies the start time for each daily clean_db.pl cron session, which is
discussed on page 215.
database_port Data port used to access EMS database. The default setting is 5556.
com.avamar.asn.module.mail
The following table describes the EMS mail settings in com.avamar.asn.module.mail..
Element Description
com.avamar.asn.service
The following table describes the EMS message service settings in
com.avamar.asn.service.
Element Description
emserver.xml 441
EMC CONFIDENTIAL
Important Files
com.avamar.mc
The following table describes the EMS settings in com.avamar.mc.
Element Description
crontab_file EMC internal use only. Do not edit. This element added in version 4.0.
com.avamar.mc.ca
The following table describes com.avamar.mc.ca settings.
Element Description
Element Description
emserver.xml 443
EMC CONFIDENTIAL
Important Files
Element Description
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.
com.avamar.mc.compatibility
The following table describes com.avamar.mc.compatibility settings.
Element Description
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.
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.
Element Description
Element Description
com.avamar.mc.event
The following table describes the EMS event service settings in com.avamar.mc.event.
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.
com.avamar.mc.mcvars
The following table describes the EMS program directory and file locations in
com.avamar.mc.mcvars.
Element Description
emserver.xml 445
EMC CONFIDENTIAL
Important Files
Element Description
/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.
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
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,
discussed on page 271. 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-2005001041" 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
(bhcompile@tweety.build.redhat.com) (gcc version 3.2.3 20030502
(Red Hat Linux 3.2.3-42)) #1 Wed Aug 18 20:58:25 EDT 2004"
memsize="1578557440" tzname="PDT"
localtime="Thu Sep 29 15:33:57 2005" />
</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, which is discussed on
page 90. This behavior can also be controlled by supplying the --maxlogsize=MB and
--maxlogfiles=N options with either start.dpn or restart.dpn commands, discussed in
“start.dpn” on page 389 and “restart.dpn” on page 367.
gsankeydata.xml 447
EMC CONFIDENTIAL
Important Files
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 in node /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-2005001041"
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.
/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.
/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.
logs.DATE.tar
The logs.DATE.tar file is generated by the getlogs utility, discussed on page 277. 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, discussed on page 477.
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.
Element Description
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.
Element Description
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.
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.
mcclient.xml 451
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.
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.
<MCSConfig default="local">
<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 453
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.
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="event">
<node name="lm">
<node name="mcsdk">
<node name="mcsm">
<node name="mcsvars">
<node name="mon">
<node name="rpt">
<node name="um">
<node name="vmware">
<node name="wo">
com.avamar.asn
The following table describes the global MCS settings in com.avamar.asn.
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.
com.avamar.asn.module.datastore
The following table describes the MCS database settings in
com.avamar.asn.module.datastore.
Element Description
mcserver.xml 455
EMC CONFIDENTIAL
Important Files
Element Description
Element Description
mcserver.xml 457
EMC CONFIDENTIAL
Important Files
Element Description
com.avamar.asn.module.mail
The following table describes the module mail settings in com.avamar.asn.module.mail.
Element Description
smtpHost Outgoing SMTP mail server name. The default setting is mail.
com.avamar.asn.service
The following table describes the MCS message service settings in
com.avamar.asn.service.
Element Description
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.
Element Description
em_port Data port used to communicate with the local EMS. The
default setting is 8778.
This element added in version 5.0.
mcserver.xml 459
EMC CONFIDENTIAL
Important Files
Element Description
com.avamar.mc.burm
The following table describes com.avamar.mc.burm settings.
Element Description
com.avamar.mc.connectemc
The following table describes the ConnectEMC settings in com.avamar.mc.connectemc.
This entire node added in version 5.0.
Element Description
com.avamar.mc.cr
The following table describes the client registration settings in com.avamar.mc.cr.
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.
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.
mcserver.xml 461
EMC CONFIDENTIAL
Important Files
Element Description
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.
com.avamar.mc.datadomain
The following table describes com.avamar.mc.datadomain settings. This entire node
added in version 6.0.
Element Description
ddr_poller_interval_sec Frequency at which Data Domain systems are polled for data.
The default setting is 60 seconds.
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 ssr ssh cli
commands. The default setting is
/usr/local/avamar/lib/ddr_key.
Element Description
com.avamar.mc.dpn
The following table describes the Avamar client settings for the MCS in
com.avamar.mc.dpn.
Element Description
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.
mcserver.xml 463
EMC CONFIDENTIAL
Important Files
Element Description
dpnxslfile Relative path to the XSLT file for translating the avmaint nodelist
output to internal document format necessary for proper Avamar
server status display.
flush_cacheflag Set to --nocache if caching should not be used on flush from MCS.
Element Description
flush_logfile Optional log file for flushes. If not specified, no log is produced.
flush_path avmgr path where flush backups are stored (optional). If not
specified, then the default is /MC_BACKUPS.
flushOverdueMinutes Generate a system event if an MCS flush does not occur within this
number of hours. The default setting is 120.
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_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.
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.
mcserver.xml 465
EMC CONFIDENTIAL
Important Files
Element Description
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.
Element Description
backuponlyID User account reserved for performing on-demand backups initiated from
Avamar Administrator clients.
MCUSERID User account that MCS should use for most activities.
restoreonlyID User account reserved for performing on-demand restores initiated from
Avamar Administrator clients.
com.avamar.mc.event
The following table describes the MCS event service settings in com.avamar.mc.event.
Element Description
eventCatalogPath Location of the XML definitions for the event catalogs. The
path is relative to the MCS install directory.
mcserver.xml 467
EMC CONFIDENTIAL
Important Files
Element Description
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.lm
The following table describes the license manager settings in com.avamar.mc.lm.
Element Description
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.
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.
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).
Element Description
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.
Depricated in 6.0 Service Pack 1.
com.avamar.mc.mcsm
The following table describes the MCS manager settings in com.avamar.mc.mcsm.
Element Description
capForecastDataDays Future time period in days for which capacity is forecast. The default
setting is 30 days.
The 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).
The 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%.
The 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.
The element added in version 4.1.
hcMonitorIntervalMin Specifies how often the MCS performs a server health check. The
default setting is 1 day (that is, once daily).
The element added in version 4.1.
mcserver.xml 469
EMC CONFIDENTIAL
Important Files
Element Description
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).
The 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.
The element added in version 4.1.
com.avamar.mc.mcsvars
The following table describes the MCS program directory and file locations in
com.avamar.mc.mcsvars.
Element Description
Element Description
com.avamar.mc.mon
The following table describes the MCS monitoring settings in com.avamar.mc.mon.
Element Description
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.
mcserver.xml 471
EMC CONFIDENTIAL
Important Files
Element Description
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.
Element Description
mcserver.xml 473
EMC CONFIDENTIAL
Important Files
com.avamar.mc.rpt
The following table describes the Avamar reports settings in com.avamar.mc.rpt.
Element Description
com.avamar.mc.um
The following table describes the user manager settings in com.avamar.mc.um.
Element Description
com.avamar.mc.vmware
The following table describes the VMware settings in com.avamar.mc.vmware. This node
added in version 5.0.
Element Description
com.avamar.mc.wo
The following table describes the MCS scheduler settings in com.avamar.mc.wo.
Element Description
mcserver.xml 475
EMC CONFIDENTIAL
Important Files
Element Description
mktime.custom
The mktime.custom file is an output file created by the asktime utility, discussed on
page 52. 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, discussed on page 313.
ntp.conf*
The ntp.conf* file is an output file created by the mktime utility, discussed on page 313.
probe.out
The probe.out file is generated by the probe utility, discussed on page 339. 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 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.
Avamar no longer uses Network Address Translation (NAT) in the probe.out file. The
probe.xml file supports both (NAT) and multiple network interfaces. More information is
available in “probe.xml” on page 482.
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.
probe.out 477
EMC CONFIDENTIAL
Important Files
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, discussed on page 335, addresses this situation by comparing
the physical node numbers generated by parsing probe.out to the output of the
avmaint nodelist command, discussed on page 128. 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 2002
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
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
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.
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
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 479
EMC CONFIDENTIAL
Important Files
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 (,).
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 (,).
probe.xml
The probe.xml file is a node resource database file generated either automatically by
using the nodedb utility, discussed on page 319, 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.
Element Description
probe.xml 481
EMC CONFIDENTIAL
Important Files
Element Description
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.
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
probe.xml 483
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>
probe.xml 485
EMC CONFIDENTIAL
Important Files
repl_cron.cfg
The repl_cron.cfg file is a flag file that is used by repl_cron, discussed on page 348, 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, discussed on page 349, 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. A list of valid
commands and options that can be included in this flag file is available in “replicate” on
page 349.
step-tickers*
The step-tickers* file is an output file created by the mktime utility, discussed on
page 313.
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.
Entry Description
--id=root User account exiting this utility session. Normally set to root.
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>
web.xml 487
EMC CONFIDENTIAL
Important Files
CHAPTER 5
Important Directories
Directory Description
Directory Description
Single-node servers
The following table lists important directories on a single-node server.
Directory Description
Directory Description
Client
The following table lists important directories on a client.
Directory Description
/usr/local/avamar Default Avamar base installation directory (AIX, HP-UX, Linux and
Solaris)
Client 491
EMC CONFIDENTIAL
Important Directories
INDEX
mcddrsetup_sshkey 300, 301 407, 414, 421, 428, 450, 477, 478, 479, 480, 481,
mcddrsnmp 301 482, 484, 486
mcfeature 302 probe.xml 52, 53, 58, 85, 127, 212, 213, 218, 219, 222,
mcflush.pl 302 223, 225, 240, 242, 243, 249, 250, 251, 255, 287,
mcgui_login.bat 304, 305, 306 293, 294, 295, 296, 313, 314, 319, 320, 321, 324,
mcgui.bat 303 326, 327, 330, 331, 335, 336, 339, 346, 348, 369,
mcgui.sh 304 372, 373, 374, 376, 377, 378, 386, 387, 388, 389,
mcserver.sh 170, 214, 241, 244, 246, 306, 307, 308, 309, 392, 396, 397, 399, 406, 407, 413, 420, 421, 422,
310, 317, 360 428, 477, 478, 482, 483, 484, 485, 486
mcserver.xml 38, 168, 171, 172, 215, 216, 217, 307, 454, probeaux 340
455 probedump 340, 341, 428
mcsmon_run 50, 215, 310 probesingle 341
mcsnmp 311 propagate-gsan 342
mcsnmp_cron 311 psregrep 342, 343
mds_ctl 230, 312 pull-checkpoint 343, 344, 402
metadata_cron 172, 312, 473
mktime 54, 258, 313, 314, 406, 407, 408, 428, 429, 477,
R
487
rebuild.node 344, 345, 347, 348
mktime.custom 54, 408, 477
repl_cron 206, 209, 254, 348, 349, 357, 372, 405, 474, 487
mktime.out 477
repl_cron.cfg 209, 348, 349, 357, 487
modify-snapups 315, 316, 317
replicate 194, 269, 270, 349, 350, 351, 352, 354, 355, 356,
mondo 317
357, 487
monmcs 215, 310, 317, 318
resite 358, 359, 360, 367, 452
monthly_cron_run 318
restart.dpn 51, 245, 246, 247, 288, 342, 367, 370, 371, 372,
morning_cron_run 206, 229, 318
389, 403, 422, 428, 447, 480
resume_crons 372, 405
N rollback.dpn 246, 372, 373, 374, 428
nodedb add if 319, 323, 324 rununtil 374
nodedb add node 324, 325, 326, 327
nodedb create 320, 327, 328
S
nodedb delete if 328
sched.sh 375, 376
nodedb delete module 329
scn 207, 376, 377, 378, 428, 429, 480
nodedb delete nat 329
securedelete 379, 380
nodedb delete node 330
showperfhistory 129, 130, 380, 381
nodedb print 251, 321, 330, 331
shutdown.dpn 246, 382, 383, 403
nodedb update if 332, 333
site_inventory 384
nodedb update module 333, 334
ssn 377, 386, 387, 388, 389, 428, 429, 480
nodedb update node 334
start.dpn 51, 211, 288, 389, 390, 392, 394, 396, 403, 408,
nodenumbers 335, 336, 428, 479, 480
412, 428, 436, 447, 480
ntp.conf* 477
start.nodes 288, 348, 397, 398, 399, 403, 428, 480
stats.sh 399
O status.dpn 241, 400, 401
opstatus.dpn 241, 244, 337 step-tickers* 487
store-checkpoint 343, 402, 403
stunctl 403, 404
P
suspend_crons 405
permctl 337, 338
swraidctl 405, 406
pingmcs 50, 215, 338
SYSNODEDB 321, 428
probe 52, 53, 58, 85, 127, 206, 209, 212, 213, 218, 219,
SYSPROBEDIR 53, 58, 213, 223, 242, 249, 296, 314, 321,
222, 223, 225, 226, 240, 241, 242, 243, 249, 250,
335, 336, 340, 341, 342, 348, 372, 374, 377, 378,
251, 255, 271, 287, 289, 293, 294, 295, 296, 297,
387, 388, 389, 396, 399, 407, 408, 421, 428, 477,
313, 314, 319, 320, 321, 324, 326, 327, 328, 330,
484
331, 335, 336, 339, 340, 341, 342, 346, 348, 369,
SYSPROBEUSER 50, 51, 255, 288, 289, 294, 296, 314, 336,
371, 372, 373, 374, 376, 377, 378, 386, 387, 388,
340, 346, 369, 377, 378, 384, 388, 389, 393, 422,
389, 392, 395, 396, 397, 399, 406, 407, 408, 413,
429
414, 420, 421, 422, 428, 450, 477, 478, 479, 480,
481, 482, 483, 484, 485, 486
probe.out 53, 209, 213, 219, 222, 226, 241, 295, 296, 297, T
313, 319, 320, 327, 328, 335, 336, 339, 340, 341, timedist 54, 314, 406, 407, 408, 409, 428
342, 371, 374, 377, 378, 387, 388, 389, 395, 399, timerange 408
U
ugcheck 413
ugcopy 414
ugprep 414, 415, 416, 417, 418, 419
usersettings.cfg 72, 210, 349, 417, 432, 487
W
wait.crunch 420, 421
wait.dpn 346, 369, 422
web.xml 487
website 175, 241, 423, 424
Z
zzdpn 425