Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B
A
289
Understanding the AppAssure Command 
Line Management Utility
The AppAssure backup and disaster recovery product consists of several software components, including the 
AppAssure Agent, the AppAssure Core, and the AppAssure Command Line Management utility. The AppAssure 
Agent is responsible for volume snapshots and fast transfer of the data to the Core. The AppAssure Core, in 
turn, stores the snapshots along with a wide variety of enhanced features, such as bare metal restore (BMR) to 
dissimilar hardware, Virtual Standby, and replication, among others. To provide third-party access to manage 
system functionality, AppAssure includes a command line tool called AppAssure Command Line Management 
utility (aacmd). It permits scripting of the AppAssure Core management functions.
Figure 9. 
AppAssure Command Line Management is a Windows command line utility that lets users interact with the 
AppAssure Core server. It offers some of the same functions that are provided by the GUI element in the 
AppAssure Core Console. For example, AppAssure Command Line Management utility can mount recovery points 
or force a snapshot.
The AppAssure Command Line Management utility is embedded in every installation of the AppAssure Core. To 
open the AppAssure Command Line Management utility, go to the location of the AppAssure installed folders and 
double-click the aacmd.exe file.
In Command Line Mode, action flags can be passed to the AppAssure Command Line Management utility through 
a selection of command options and qualifiers to perform limited management functions. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B290 This section includes the following topics:
•Commands
•Localization
Commands
This section describes the commands and options available for the AppAssure Command Line Management 
utility. The following commands are available for use:
•Archive
•CancelActiveJobs
•CreateRepository
•Dismount
•Force
•ForceAttach
•ForceChecksum
•ForceLogTruncation
•ForceMount
•ForceReplication
•ForceRollup
•Help
•List
•Mount
•Pause [snapshot | vmexport | replication]
•Pr ote ct
•ProtectCluster
•RemoveAgent
•RemovePoints
•RestoreArchive
•Resume [snapshot | vmexport | replication]
•StartExport
•UpdateRepository
•Ve r s i o n
Archive
Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature 
in AppAssure supports extended retention for compliant and non-compliant data. The administrator can save an 
archive on the local storage or network location by specifying the -path parameter and credentials. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B291
Usage
The usage for the command is as follows:
/archive -core [host name] -user [user name] -password [password] -all | -
protectedserver [name | IP address] -path [location] -startdate [time string] -
enddate [time string] -archiveusername [name] -archivepassword [password] -comment 
[text]
Command Options
The following table describes the options available for the Archive command:
Examples:
Archive all recovery points with creation dates starting from 04/30/2012 02:55 PM for all machines on the Core:
>aacmd /archive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path 
d:\work\archive -startdate “04/30/2012 02:55 PM” -all
Archive recovery points that fall within a date range for two protected machines:
>aacmd /archive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -
protectedserver 10.20.30.40 20.20.10.1 -path d:\work\archive -startdate 
04/30/2012 02:55 PM -enddate 05/31/2012 11:00 AM Table 137. Archive command options
Option Description
-?Display this help message.
-coreOptional. Remote Core host machine IP address (with an optional port number). By 
default, the connection is made to the Core installed on the local machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none is provided, then the credentials for the 
logged-on user are used.
-allArchive all recovery points for all protected machines on the Core.
-protectedserverProtected machine with recovery points to be archived. You can specify several 
machine names enclosed in double quotes and separated by spaces.
-pathPath where archived data should be placed; for example: d:\work\archive or 
network path \\servername\sharename.
-startdateStart date for selecting recovery points by creation date. Value must be enclosed in 
double quotes.
-enddateOptional. End date for selecting recovery points by creation date. Value must be 
enclosed in double quotes. The current time system is used by default.
-archiveusernameOptional. User name for the remote machine. Required for network path only.
-archivepasswordOptional. Password to the remote machine. Required for network path only.
-commentOptional. Comment text must be enclosed in double quotes; for example: -
comment “comment goes here...”. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B292
CancelActiveJobs
Use the CancelActiveJobs command to cancel the execution of all in-progress jobs of a specific type, such 
as transfer or replication.
Usage
The usage for the command is as follows:
/cancelactivejobs -core [host name] -user [user name] -password [password] -jobtype 
[job type filter]]
Command Options
The following table describes the options available for the CancelActiveJobs command:
Example:
Cancel all transfer jobs on Core 10.10.10.10:
>aacmd /cancelactivejobs -core 10.10.10.10:8006 -user administrator -password 
23WE@#$sdd -jobtype transfer Table 138. CancelActiveJobs command options
Option Description
-?Display help on the command.
-coreOptional. Remote core host machine IP address (with an optional port number). By 
default, the connection is made to the core installed on the local machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote core host machine. If you specify a password, you 
must also provide a user name. If none is provided, the logged-in user’s credentials 
are used.
-protectedserverDetermines the protected machine on which the jobs should be canceled. 
-allSelect and cancel events of specified type for all protected servers.
-jobtypeOptional. Specifies job type filter. Available values are: 
•‘transfer’ (data transfer)
•‘repository’ (repository maintenance)
•‘replication’ (local and remote replications)
•‘backup’ (backup and restore)
•‘bootcdbuilder’ (create boot CDs)
•‘diagnostics’ (upload logs)
•‘exchange’ (Exchange Server files check)
•‘export’ (recovery point export)
•‘pushinstall’ (deploy agents)
•‘rollback’ (recovery point rollbacks)
•‘rollup’ (recovery point rollups)
•‘sqlattach’ (agent attachability checks)
•‘mount’ (mount repository)
By default, all jobs of the specified type are canceled. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B293
CreateRepository
Use the CreateRepository command to create a new repository on a local machine as well as on a share 
location.
Usage
The usage for the command when creating a repository on a local location is as follows:
/createrepository -name [repository name] -size [size allocated for repository] -
datapath [data path of repository] -metadatapath [metadata path of repository] -core 
[host name] -user [user name] -password [password]
The usage for the command when creating a repository on a share location is as follows:
/createrepository -name [repository name] -size [size allocated for repository] -
uncpath [path for data and metadata] -shareusername [user name for share location] -
sharepassword [password for share user name] -concurrentoperations [number of 
operations to occur at one time -core [host name] -user [user name] -password 
[password]
Command Options
The following table describes the options available for the CreateRepository command:
Table 139. CreateRepository command options
Option Description
-?Display help on the command.
-coreOptional. Remote core host machine IP address (with an optional port 
number). By default, the connection is made to the core installed on the local 
machine.
-userOptional. User name for the remote Core host machine. If you specify a user 
name, you must also provide a password. If none is provided, then the 
credentials for the logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a 
password, you also have to provide a user name. If none is provided, then the 
credentials for the logged-on user are used.
-protectedserverDetermines the protected machine on which the jobs should be canceled. 
-allSelect and cancel events of specified type for all protected servers.
-nameRepository name.
-sizeSize of repository storage location. Available units are b, Kb, Mb, Gb, Tb, and 
Pb.
-datapathFor local location only. Determines data path of repository storage location.
-metadatapathFor local location only. Determines metadata path of repository storage 
location.
-uncpathFor share location only. Determines data and metadata paths of repository 
storage location.
-shareusernameFor share location only. Determines the user name to the share location.
-sharepasswordFor share location only. Determines password to share location.
-commentOptional. Description of repository.
-concurrentoperationsOptional. Maximum number of operations that can be pending at one time. 
Va l u e  b y  d e f a u l t :  6 4 . 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B294
Examples:
Create repository at local location:
>aacmd /createrepository -name “Repository 1” -size 200 Gb -datapath d:
epository -
metadatapath d:
epository -core 10.10.10.10:8006 -user administrator -password 
23WE@#$sdd
Create repository at share location:
>aacmd /createrepository -name “Repository 1” -size 200 Gb -uncpath 
\\share
epository -shareusername login -sharepassword pass123 -comment “First 
repository.” -concurrentoperations 8 -core 10.10.10.10:8006 -user administrator 
-password 23WE@#$sdd
Dismount
Use the Dismount command to dismount a mounted recovery point specified by the Path command, dismount 
points for the selected agent by the -protectedserver parameter, or dismount all mounted recovery points 
(-all).
Usage
The usage for the command is as follows:
/dis[mount] -core [host name] -user [user name] -password [password] [-all | 
-protectedserver [name | IP address] | -path [location]
Command Options
The following table describes the options available for the Dismount command:
Example:
Dismount a recovery point that was mounted to folder c:\mountedrecoverypoint:
>aacmd /dismount -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path 
c:\mountedRecoveryPoint Table 140. Dismount command options
Option Description
-?Display this help message.
-coreOptional. Remote core host machine IP address (with an optional port number). By 
default, the connection is made to the Core installed on the local machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none is provided, then the credentials for the 
logged-on user are used.
-allDismount all mounted recovery points.
-protectedserverDismount all mounted recovery points for current agent.
-pathDismount selected mount point. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B295
Force
The Force command forces a snapshot of a specified protected server. Forcing a snapshot lets you force a data 
transfer for the current protected machine. When you force a snapshot, the transfer will start immediately or 
will be added to the queue. Only the data that has changed from a previous recovery point will be transferred. 
If there is no previous recovery point, all data on the protected volumes will be transferred.
Usage
The usage for the command is as follows:
/force [snapshot] default | [base] [-all | -protectedserver [name | IP address]] 
-core [host name] -user [user name] -password [password]
Command Options
The following table describes the options available for the Force command:
Example:
Force a snapshot for all machines on the Core:
>aacmd /force snapshot -core 10.10.10.10 -user administrator -password 23WE@#$sdd -
all
ForceAttach
The ForceAttach command lets you force a SQL database files attachability check. When you force an 
attachability check, the transfer starts immediately.
Usage
The usage for the command is as follows:
/forceattach -core [host name] -user [user name] -password [password] 
-protectedserver [name | IP address] -rpn [number | numbers] | -time [time string] Table 141. Force command options
Option Description
-?Display this help message.
-forceOptional. Type of snapshot to create. Available values: snapshot (incremental 
snapshot) and base (base image snapshot). By default, an incremental snapshot is 
performed.
-coreOptional. Remote Core host machine IP address (with an optional port number). By 
default, the connection is made to the Core installed on the local machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none is provided, then the credentials for the 
logged-on user are used.
-allForce snapshots for all machines on the core.
-protectedserverForce a snapshot for a specific protected machine. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B296
Command Options
The following table describes the options available for the ForceAttach command:
Example:
Perform attachability checks for recovery points with numbers 5 and 7:
>aacmd /forceattach -core 10.10.10.10 -user administrator -password 23WE@#$sdd -
protectedserver 10.10.5.22 -rpn 5 7
ForceChecksum
The ForceChecksum command lets you force an integrity check of any Exchange Message Databases (MDBs) 
present on the specified recovery point or points. When you force a checksum check, the command begins 
immediately.
Usage
The usage for the command is as follows:
/forcechecksum -core [host name] -user [user name] -password [password] -
protectedserver [name | IP address] -rpn [number | numbers] -time [time string]
Command Options
The following table describes the options available for the ForceChecksum command: Table 142. ForceAttach command options
Option Description
-?Display this help message.
-coreOptional. Remote Core host machine IP address (with an optional port number). By 
default, the connection is made to the Core installed on the local machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none is provided, then the credentials for the 
logged-on user are used.
-protectedserverOptional. Protected machine against which to perform the attachability check.
-rpnOptional. The sequential number of a recovery point against which to perform 
checks (run command /list rps to obtain the numbers). To perform checks against 
multiple recovery points with a single command, you can specify several numbers 
separated by spaces.
-timeOptional. Select a recovery point by its creation time. You must specify the exact 
time in the format “mm/dd/yyyy hh:mm tt” (for example, “2/24/2012 09:00 AM”). 
Keep in mind to specify the date and time values of the time zone set on your PC.
Table 143. ForceChecksum command options
Option Description
-?Display this help message.
-coreOptional. Remote Core host machine IP address (with an optional port number). By 
default, the connection is made to the Core installed on the local machine. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B297
Example:
Perform a checksum check for recovery points with numbers 5 and 7:
>aacmd /forcechecksum -core 10.10.10.10 -user administrator -password 23WE@#$sdd -
protectedserver 10.10.5.22 -rpn 5 7
ForceLogTruncation
Forcing log truncation lets you perform this job one time, on-demand. It immediately truncates the logs for the 
specified SQL Server agent machine.
Usage
The usage for the command is as follows:
/[forcelogtruncation | flt] -core [host name] -user [user name] -password [password] 
-protectedserver [name | IP address]
Command Options
The following table describes the options available for the ForceLogTruncation command: -userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none is provided, then the credentials for the 
logged-on user are used.
-protectedserverOptional. Protected machine against which to perform the checksum check.
-rpnOptional. The sequential number of a recovery point against which to perform 
checks (run command /list rps to obtain the numbers). To perform checks against 
multiple recovery points with a single command, you can specify several numbers 
separated by spaces.
-timeOptional. Select a recovery point by its creation time. You must specify the exact 
time in the format “mm/dd/yyyy hh:mm tt” (for example, “2/24/2012 09:00 AM”). 
Keep in mind to specify the date and time values of the time zone set on your PC.
Table 144. ForceLogTruncation command options
Option Description
-?Display this help message.
-coreOptional. Remote Core host machine IP address (with an optional port number). By 
default, the connection is made to the Core installed on the local machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none is provided, then the credentials for the 
logged-on user are used.
-protectedserverOptional. Protected machine against which to perform log file truncation. Table 143. ForceChecksum command options
Option Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B298
Example:
Force log truncation for a protected server:
>aacmd /forcelogtruncation -core 10.10.10.10 -user administrator -password 
23WE@#$sdd -protectedserver 10.10.20.20
ForceMount
Use the ForceMount command to conduct an one-time recovery point mountability check. This determines 
whether or not the specified recovery point or recovery points can be mounted and used to restore backed up 
data. You must list either one or more specific recovery points on which to conduct the check, or a time range 
during which the recovery points were created.
Usage
The usage for the command is as follows:
/forcemount -core [host name] -user [user name] -password [password] 
-protectedserver [name | IP address] -rpn [number | numbers] | -time [time string]
Command Options
The following table describes the options available for the ForceMount command:
Example:
Perform mountability checks for recovery points with numbers 5 and 7:
>aacmd /forcemount -core 10.10.10.10 -user administrator -password 23WE@#$sdd -
protectedserver 10.10.20.20 -rpn 5 7 Table 145. ForceMount command options
Option Description
-?Display this help message.
-coreOptional. Remote Core host machine IP address (with an optional port number). By 
default, the connection is made to the Core installed on the local machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you must also provide a password. If none is provided, then the credentials for the 
logged-on user are used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none is provided, then the credentials for the 
logged-on user are used.
-protectedserverOptional. Protected machine against which to perform log file truncation.
-rpnOptional. The sequential number of a recovery point against which to perform 
checks (run command /list rps to obtain the numbers). To perform checks against 
multiple recovery points with a single command, you can specify several numbers 
separated by spaces.
-timeOptional. Select a recovery point by its creation time. You must specify the exact 
time in the format “mm/dd/yyyy hh:mm tt” (for example, “2/24/2012 09:00 AM”). 
Keep in mind to specify the date and time values of the time zone set on your PC.