Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B349
Example:
Put volumes of a server under protection:
>Start-ProtectCluster -repository Repository 1 -clustername 10.10.9.120 
-clusterusername administrator -clusterpassword 12345 -clusterport 5002 
-clustervolumes c: d: -clusternodes nodename 10.10.10.10 volumes “c:” “e:”
Start-RestoreArchive
Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature 
in AppAssure is used to support the 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 command 
and credentials.
Usage
The usage for the command is as follows:
Start-RestoreArchive –path -repository [-all] | -protectedserver [machine name] or 
[IP]] -core [host name] -user [user name] -password [password]
Command Options
The following table describes the options available for the Start-RestoreArchive command: -repositoryName of a repository on the Core where the protected machines data is stored. The 
name must be enclosed in double quotes.
-clusternameThe name of the cluster to protect.
-clusterusernameUser name for the cluster to be protected.
-clusterpasswordPassword to the cluster to be protected.
-clusterportPort number for the cluster to be protected.
-clustervolumesList of volumes to protect. Values must be in double quotes and separated by a 
space. Do not use trailing slashes in volume names. For example, “c:”, “d”.
-clusternodesList of cluster nodes with volumes to protect. First specify label “nodename” and 
then type the name of the node. Then, specify label “volumes” and then type a list 
of volumes for the node.
For example: “nodename”, “10.10.10.10”, “volumes”, “c:”, “e:”, 
“nodename”, “10.10.10.11,” “volumes”, “c:”
Table 197. Start-RestoreArchive command options
Option Description
-?Display this help message.
-pathLocation path. Example path: ‘D:\work\archive’ or network path: 
‘\\servername\sharename’.
-repositoryRepository of the Core for the unprotected machine.
-allArchive the recovery points for all of the machines on the Core.
-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. Table 196. Start-ProtectCluster command options
Option Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B350
Example:
Archive all recovery points for all machines on the Core:
>Start-RestoreArchive -path D:\work\archive -startdate Example 04/30/2012 –all
Start-VBExport
The start-VBExport command initiates the launch of a virtual export from the selected recovery point to an 
Oracle VirtualBox server virtual machine.
Required parameters include the name of the protected machine containing recovery points to export; the 
name of the virtual machine you are exporting to; the amount of RAM to be allocated on the virtual machine; 
the host name and port of the Linux server host, and the path to the local, network, or Linux folder where the 
resulting virtual machine files will be stored.
Usage
The usage for the command is as follows:
Start-VBExport -core -user [user name] -password [password] -protectedserver 
[machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | 
-time [time string] -vmname [virtual machine name] [-ram [total megabytes] | 
-usesourceram] -linuxhostname [linux hostname] -hostport [linux port] -targetpath 
[location] pathusername [user name] - pathpassword [password]
Command Options
The following table describes the options available for the Start-VBExport command: -passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-protectedserverArchive of recovery points for the specified machine.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you also have to provide a password. If none are provided, then the logged-on users 
credentials will be used.
-archiveusernameOptional. Required for network path only.
-archivepasswordOptional. Required for network path only.
Table 198. Start-VBExport 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 also have to provide a password. If none are provided, then the logged-on users 
credentials will be used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-protectedserverProtected machine with recovery points to be exported. Table 197. Start-RestoreArchive command options
Option Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B351
Example:
Export all volumes from the latest recovery point on machine 10.10.12.97 to a VM called NewVirtualBoxVM:
>Start-VBExport -protectedserver 10.10.12.97 -vmname NewVirtualBoxVM -ram 
usesourceram -targetpath D:/exports -volumesOptional. List of volume names to be exported. If not specified, all volumes in the 
specified recovery points will be exported. Values must be enclosed in double 
quotes, each separated by a space. do not use trailing slashes in volume names. For 
example, specify “C:” not “C:/”
-rpnOptional. The sequential number of a recovery point to be exported. (You can use 
the Get-RecoveryPoints command to obtain recovery point numbers.)
NOTE: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most 
recent recovery point will be exported.
-timeOptional. Determines recovery point to be selected for export. You need to specify 
exact time in the format “MM/DD/YYYY hh:mm tt” (for example: “04/24/2015 
09:00 AM”).” Specify date time values of the time zone set on your local machine.
NOTE: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most 
recent recovery point will be exported.
-vmnameWindows name of the virtual machine.
-ramAllocate specific amount of RAM on the virtual server.
-usesourceramOptional. Allocate the same amount of RAM on the virtual server as the source 
protected machine.
-linuxhostnameLinux VirtualBox server hostname.
-hostportLinux VirtualBox server port.
-targetpathLocal or network or Linux path to the folder where the virtual machine files are to 
be stored.
-pathusernameUser name for network machine. Only required when you specify network path in 
parameter -targetpath.
-pathpasswordPassword for network machine. Only required when you specify network path in 
parameter -targetpath.
-accountusernameOptional. Use if you can specify a user account to register the exported virtual 
machine. For local or network machine only.
-accountpasswordOptional. Use only when you specify a user account to register the exported virtual 
machine using parameter -accountusername. For local or network machine 
only. Table 198. Start-VBExport command options
Option Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B352
Start-VMExport
The start-VMExport command initiates the launch of a virtual export from the selected recovery point to a 
VMware Workstaation server virtual machine.
Required parameters include the name of the protected machine containing recovery points to export; the 
name of the virtual machine you are exporting to; the amount of RAM to be allocated on the virtual machine; 
and the path to the local or network, folder where the resulting virtual machine files will be stored.
Usage
The usage for the command is as follows:
Start-VMExport -core -user [user name] -password [password] -protectedserver 
[machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | 
-time [time string] -vmname [virtual machine name] [-ram [total megabytes] | 
-usesourceram] -linuxhostnme [linux hostname] -hostport [linux port] -targetpath 
[location] pathusername [user name] - pathpassword [password]
Command Options
The following table describes the options available for the Start-VMExport command:
Table 199. Start-VMExport 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 also have to provide a password. If none are provided, then the logged-on users 
credentials will be used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-protectedserverProtected machine with recovery points to be exported.
-volumesOptional. List of volume names to be exported. If not specified, all volumes in the 
specified recovery points will be exported. Values must be enclosed in double 
quotes, each separated by a space. do not use trailing slashes in volume names. For 
example, specify “C:” not “C:/”
-rpnOptional. The sequential number of a recovery point to be exported. (You can use 
the Get-RecoveryPoints command to obtain recovery point numbers.
NOTE: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most 
recent recovery point will be exported.
-timeOptional. Determines recovery point to be selected for export. You need to specify 
exact time in the format “MM/DD/YYYY hh:mm tt” (for example: “04/24/2015 
09:00 AM”).” Specify date time values of the time zone set on your local machine.
NOTE: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most 
recent recovery point will be exported.
-vmnameWindows name of the virtual machine.
-ramAllocate specific amount of RAM on the virtual server.
-usesourceramOptional. Allocate the same amount of RAM on the virtual server as the source 
protected machine.
-targetpathLocal or network or Linux path to the folder where the virtual machine files are to 
be stored. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B353
Example:
Export all volumes from the latest recovery point on machine 10.10.12.97 to a VM called NewVMwareVM:
>Start-VBExport -protectedserver 10.10.12.97 -vmname NewVMWareVM -ram usesourceram -
targetpath D:/exports 
Suspend-Replication
The Suspend-Replication command lets an administrator pause replication.
A user can pause replication in three ways:
•Pause replication on the master Core for all protected machines (-outgoing parameter)
The administrator must specify the remote machine name with outgoing replication pairing to pause 
outgoing replication on the master Core.
>Suspend-replication -outgoing 10.10.12.10
•Pause replication on the master Core for a single protected machine (-protectedserver parameter)
>Suspend-replication -protectedserver 10.10.12.97
•Pause replication on the target Core (-incoming parameter)
If the local Core is a target Core, the administrator can pause replication by specifying the master Core 
using the –incoming parameter.
Command Options
The following table describes the options available for the Suspend-Replication command: -pathusernameUser name for network machine. Only required when you specify network path in 
parameter -targetpath.
-pathpasswordPassword for network machine. Only required when you specify network path in 
parameter -targetpath.
-versionOptional. Use if you can specify a user account to register the exported virtual 
machine. For local or network machine only.
-versionVersion of VMware Tools to use. Valid versions are: 7, 8, 9, and 10.
Table 200. Suspend-Replication command options
Option Description
-?Display this help message.
-allPauses all protected machines on the selected Core.
-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.
-pause [snapshots], [replication] or [vmexport].
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-protectedserverPause the current protected server.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you also have to provide a password. If none are provided, then the logged-on users 
credentials will be used. Table 199. Start-VMExport command options
Option Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B354
Example:
Pause outgoing replication on the remote Core with the IP address: 10.10.1.15, for the single protected machine 
with the IP address: 10.10.1.76:
>Suspend-replication –core 10.10.1.15 –protectedserver 10.10.1.76
Pause outgoing replication from the local Core to remote target with the IP address: 10.10.1.63 for all 
protected machines:
>Suspend-replication –outgoing 10.10.1.63
Pause incoming replication from 10.10.1.82 on the remote Core with the IP address: 10.10.1.15 (Administrator 
is able to pause incoming replication only for whole machine):
>Suspend-replication –core 10.10.1.15 –incoming 10.10.1.82
Stop-ActiveJobs
The Stop-ActiveJobs cancels active jobs for A specified protected machine.
Usage
The usage for the command is as follows:
Stop-ActiveJobs [-protectedserver [machine name | IP address] | -core [host name]] 
-user [user name] -password [password] -jobtype [jobtype]
Command Options
The following table describes the options available for the Stop-ActiveJobs command: -incomingHost name of the remote Core that replicates to the Core machine. Replication is 
suspended for all protected machines on the remote Core.
-outgoingHost name of the remote target core to which data is replicating. Replication is 
suspended for all protected machines on the remote core.
Table 201. Stop-ActiveJobs command options
Option Description
-?Display this help message.
-allSelect and cancel events of the specified type for all protected machines.
-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 also have to provide a password. If none are provided, then the logged-on users 
credentials will be used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-userOptional. User name for the remote Core host machine. If you specify a user name, 
you also have to provide a password. If none are provided, then the logged-on users 
credentials will be used. Table 200. Suspend-Replication command options
Option Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B355
Example:
Stop transfer job in protected machine:
>Stop-ActiveJobs –protectedserver 10.10.1.76 -jobtype transfer
Stop all jobs for a specific protected machine:
>Stop-ActiveJobs –protectedserver 10.10.1.76 -all 
Suspend-Snapshot
The Suspend-Snapshot command lets an administrator pause snapshots.
Usage
The usage for the command is as follows:
Suspend-Snapshot -core [host name] -user [user name] -password [password] -all | 
-protectedserver [name | IP address] -time [time string]
Command Options
The following table describes the options available for the Suspend-Snapshot command: -passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-protectedserverDetermines protected machine on which jobs should be canceled.
-jobtypeOptional. Specifies job type filter. Available values are: ‘transfer’ (data transfer), 
‘repository’ (repository maintenance), ‘replication’ (local and remote replications), 
‘backup’ 9backup and restore), ‘bootcdbuilder’ (create boot CDs), 
‘diagnostics’(upload logs), ‘exchange’ (Exchange Server files check), ‘export 
(recovery point export), ‘pushinstall’ (deploy Agent software to protected 
machines), ‘rollback’ (restore data from recovery point), ‘rollup’ (recovery point 
rollup’s), ‘sqlattach’ (agent attachability checks), ‘mount’ (not repository). By 
default, all jobs of the specified type are canceled.
Table 202. Suspend-Snapshot command options
Option Description
-?Display this help message.
-allPauses all protected machines on the selected Core.
-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 also have to provide a password. If none are provided, then the logged-on users 
credentials will be used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-timeThe time in the format ‘Day-Hours-Minutes’ when the snapshots will be 
resumed (only for snapshots pause). Table 201. Stop-ActiveJobs command options
Option Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B356
Example:
Pause snapshots for the protected machine with IP 10.10.10.4 for the local Core with a certain time to resume:
>Suspend-Snapshot -protectedserver 10.10.10.4 –time 3-20-50
Suspend-VMExport
The Suspend-VMExport command lets an administrator pause exports to virtual machines.
Usage
Suspend-VMExport -core [host name] -user [user name] -password [password] -all | -
protectedserver [name | IP address] 
Command Options
The following table describes the options available for the Suspend-VMExport command:
Example:
Suspend VM export for the protected machine with IP 10.10.10.4 for the local Core:
>Suspend-VMExport -protectedserver 10.10.12.25
Update-Repository
The Update-Repository command adds an extent to an existing repository. The size specified must be 
between 250 Mb and 16 Tb.
Usage
Update-Repository -name [repository name] -size [size] [[[-datapath [datapath] 
-metadatapath [metadata path]] | [-uncpath [UNC path] -shareusername [share user 
name] -sharepassword [share password]]] -core [host name] -user [user name] 
-password [password] Table 203. Suspend-VMExport 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 also have to provide a password. If none are provided, then the logged-on users 
credentials will be used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-allPauses all protected machines on the selected Core.
-protectedserverPause the current protected server. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B357
Command Options
The following table describes the options available for the Update-Repository command:
Example:
Add an extent to the repository of the minimum size:
>Update-Repository -name Repository1 -size 250Mb -datapath C:\Repository\Data -
metadatapath C:
epository\Metadata 
Localization
When running on the same machine on which AppAssure Core is installed, the AppAssure PowerShell module 
bases its display language on the language set for the AppAssure Core. In this release, supported languages 
include English, Chinese (Simplified), French, Korean, German, Japanese, Portuguese (Brazil), and Spanish.
If the AppAssure PowerShell module is installed on a separate machine, English is the only language supported. Table 204. Update-Repository 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 also have to provide a password. If none are provided, then the logged-on users 
credentials will be used.
-passwordOptional. Password to the remote Core host machine. If you specify a password, you 
also have to provide a user name. If none are provided, then the logged-on users 
credentials will be used.
-nameRepository name.
-sizeSize of repository extent. Available units are: b, Kb, Mb, Gb, Tb, Pb.
-datapathFor local location only. Determines data path of repository extent.
-metadatapathFor local location only. Determines metadata path of repository extent.
-uncpathFor share location only. Determines data and metadata paths of repository extent.
-shareusernameFor share location only. Determines login to share location.
-sharepasswordFor share location only. Determines password to share location. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B358
Qualifiers
The following table describes the qualifiers available for AppAssure PowerShell Module.
Table 205. 
Qualifier Usage
-core Host name of the Core.
Default: Localhost
-ProtectedServer 
Host name/IP address of the AppAssure Agent.
Default: Localhost if multiple servers protected, otherwise the 
single server protected.
-Mode 
Recovery Point Mount mode.
Default: Read.
-Volumes 
Snapshot volume letter from AppAssure Agent.
Default: All.
-User 
User name used to connect to the AppAssure Core.
This is typically the service user.
-Domain 
Domain to which the user defined in /User belongs.
-Password 
Password of the user defined in /User.
-Path 
For example: C:\AppAssureMount.