Chat now with support
Chat with Support

Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

Rapid Recovery overview and system requirements Command Line Management Utility PowerShell Module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets
Add-CredentialsVaultAccount AddEncryptionKeytoProtectedMachine Add-EsxAutoProtectObjects Add-EsxVirtualMachines Add-HyperVClusterSharedVirtualDisks Add-HyperVClusterVirtualMachines Add-HyperVVirtualMachines Disable-HyperVAutoProtection Edit-ActiveBlockMapping Edit-AzureVirtualStandby Edit-EsxiVirtualStandby Edit-EsxServerProtectionRules Edit-ExcludedFilesAndFolders Edit-HyperVClusterProtectionRules Edit-HyperVServerProtectionRules Edit-HyperVVirtualStandby Edit-OracleDBVerifyNightlyJob Edit-OracleLogTruncationNightlyJob Edit-Replication Edit-ScheduledArchive Edit-VBVirtualStandby Edit-VMVirtualStandby Enable-HyperVAutoProtection Enable-OracleArchiveLogMode Get-ActiveJobs Get-CloudAccounts Get-Clusters Get-CompletedJobs Get-CredentialsVaultAccounts Get-ExchangeMailStores Get-Failed Get-FailedJobs Get-HyperVClusterSharedVirtualDisks Get-ListAzureVMSizes Get-Mounts Get-OracleInstanceMetadata Get-OracleInstances Get-Passed Get-ProtectedServers Get-ProtectionGroups Get-ProtectionRules Get-QueuedJobs Get-RecoveryPoints Get-ReplicatedServers Get-Repositories Get-ScheduledArchives Get-SqlDatabases Get-TransferQueueEntries Get-UnprotectedVolumes Get-Version Get-VirtualizedServers Get-Volumes Join-CredentialsVaultAccount New-AzureVirtualStandby New-Base New-BootCD New-CloudAccount New-EncryptionKey New-EsxiVirtualStandby New-FileSearch New-HyperVVirtualStandby New-Mount New-Replication New-Repository New-ScheduledArchive New-Snapshot New-VBVirtualStandby New-VMVirtualStandby Open-DvmRepository Push-Replication Push-Rollup Remove-Agent Remove-CredentialsVaultAccount Remove-EncryptionKey Remove-EsxAutoProtectObjects Remove-EsxVirtualMachines Remove-HyperVClusterSharedVirtualDisks Remove-HyperVClusterVirtualMachines Remove-HyperVVirtualMachines Remove-Mount Remove-Mounts Remove-RecoveryPoints Remove-Replication Remove-Repository Remove-ScheduledArchive Remove-VirtualStandby Restart-CoreService Resume-Replication Resume-ScheduledArchive Resume-Scheduler Resume-Snapshot Resume-VirtualStandby Set-AgentMetadataCredentials Set-CredentialsVaultAccount Set-DedupCacheConfiguration Set-License Set-OracleMetadataCredentials Set-ReplicationResponse Start-Archive Start-AttachabilityCheck Start-AzureDeploy Start-AzureExport Start-BackupSettings Start-ChecksumCheck Start-ConfigureAgentMigration Start-ConsumeSeedDrive Start-CopySeedDrive Start-EsxiExport Start-HypervExport Start-LogTruncation Start-MountabilityCheck Start-OptimizationJob Start-OracleDBVerifyJob Start-OracleLogTruncationJob Start-Protect Start-ProtectCluster Start-ProtectEsxServer Start-ProtectHyperVCluster Start-ProtectHyperVServer Start-RepositoryCheck Start-RestoreAgent Start-RestoreArchive Start-RestoreSettings Start-RestoreUrc Start-ScheduledArchive Start-VBExport Start-VirtualStandby Start-VMExport Stop-ActiveJobs Stop-CoreService Suspend-Replication Suspend-ScheduledArchive Suspend-Scheduler Suspend-Snapshot Suspend-VirtualStandby Update-Repository
Localization Qualifiers
Scripting

Start-ConfigureAgentMigration

The Start-ConfigureAgentMigration cmdlet lets you migrate a protected machine from one DVM repository to another.

Usage

The usage for the command is as follows: 

Start-ConfigureAgentMigration [-AgentName <string>] [-TargetRepositoryName <string>] [-LastRecoveryPointDate <string>] [-AsNightlyJob] [-User <string>] [-Core <string>] [-Password <string>] [<CommonParameters>]
Command Options

The following table describes the options available for the Start-ConfigureAgentMigration command:

Table 184: Start-ConfigureAgentMigration command options
Option Description 
-?
 Display this help message. 
-core
 Optional. 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. 
-user
 Optional. 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 user's credentials will be used. 

-password
 Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.

If none are provided, then the logged-on user's credentials will be used. 

-agentname
 Required. The name of the protected machine that you want to migrate. 
-targetrepository
 Required. The name of the repository to which you want to migrate the protected machine.
-lastrecoverypointdate

The oldest recovery point in the range of recovery points that you want to migrate. 

-asanightlyjob
 Use this option if you want the migration to take place along with the nightly jobs.
Examples:

Migrate server 10.10.10.10 to a specified repository: 

>Start-ConfigureAgentMigration -agentname 10.10.10.10 -targetrepository repo2 -lastrecoverypointdate "2/24/2016"

Start-ConsumeSeedDrive

When setting up replication inRapid Recovery with a seed drive, after the seed drive is in place, use the Start-ConsumeSeedDrive cmdlet to consume a seed drive on a target Core.

Usage

The usage for the command is as follows: 

Start-ConsumeSeedDrive -path [local | network path] -seeddriveusername [user name] -seeddrivepassword [password] -remotecore [name] -protectedserver [name] | -all]
Command Options

The following table describes the options available for the Start-ConsumeSeedDrive command:

Table 185: Start-ConsumeSeedDrive command options
Option Description 
-?
 Display this help message. 
-core
 Optional. 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. 
-user
 Optional. The 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. 
-password
 Optional. The 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. 
-path
 The local or network path of the seed drive. 
-seeddriveusername
 Optional. The user name for the network location of the seed drive. 
-seeddrivepassword
 Optional. The password for the network location of the seed drive. 
-remotecore
 Use only with the -consume option. It is the name of the remote Core from which the seed drive recovery points are created or consumed. 
-protectedserver
 The name or IP address of the protected machine you are using to create or consume the seed drive of recovery points. For example: -protectedserver "10.10.60.48" "10.10.12.101." 
-all
 This option specifies whether to consume or copy all of the available protected machines.
Examples:

Starting consuming a seed drive located on a network share: 

>Start-ConsumeSeedDrive -path \\10.10.1.1\Share\Seed\ -seeddriveusername Adminsitrator -seeddrivepassword 12345 -remotecore RemoteCoreName -all

Start consuming the data from two protected machines from a seed drive located on the local system: 

>Start-ConsumeSeedDrive -path C:\Seed\ -remotecore TargetCoreHostName -protectedserver "10.10.1.1","10.10.1.2"

Start-CopySeedDrive

To set up replication in Rapid Recovery, backup data is copied from the source Core to the target Core. To save time and network bandwidth, you can create a seed drive from the source Core, and consume the seed drive on the target Core. Use the Start-CopySeedDrive cmdlet to create a seed drive from the source Core.

Usage

The usage for the command is as follows: 

Start-CopySeedDrive -path [local | network path] -seeddriveusername [user name] -seeddrivepassword [password] [-targetcore [name or IP] | -protectedserver [name] | -all] -usecompatibleformat
Command Options

The following table describes the options available for the Start-CopySeedDrive command:

Table 186: Start-CopySeedDrive command options
Option Description 
-?
 Display this help message. 
-core
 Optional. 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. 
-user
 Optional. The 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. 
-password
 Optional. The 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. 
-path
 The local or network path of the seed drive. 
-seeddriveusername
 Optional. The user name for the network location of the seed drive. 
-seeddrivepassword
 Optional. The password for the network location of the seed drive. 
-targetcore
 Optional. Use only with the -copy option. It is the name or IP address of the remote Core. All protected machines replicating to this Core receive seed drive recovery points. 
-protectedserver
 The name or IP address of the protected machine you are using to create or consume the seed drive of recovery points. For example: -protectedserver "10.10.60.48" "10.10.12.101." 
-all
 This option specifies whether to consume or copy all of the available protected machines. 
-usecompatibleformat
 The new archiving format offers improved performance, however it is not compatible with older Cores. Use this option when working with a legacy AppAssure Core.
Confirm with dev.
Examples:

Start copying data from protected machines to a seed drive located on the local system: 

>Start-CopySeedDrive -path C:\Seed\ -usecompatibleformat -targetcore TargetCoreHostName

Start copying two protected machines to the seed drive on the network share: 

>Start-CopySeedDrive -path \\10.10.1.1\Share\Seed\ -seeddriveusername Administrator -seeddrivepassword 12345 -usecompatibleformat -protectedserver "10.10.60.48","10.10.12.101"

Start-EsxiExport

The Start-EsxiExport PowerShell cmdlet initiates the launch of a virtual export from the selected Rapid Recovery recovery point to an ESXi 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-EsxiExport -core [host name] -user [user name] -password [password] -protectedserver [machine name | IP address] -volumes [volume names] -rpn [number | numbers] | -time [time string] -vmname [virtual machine name] -hostname [virtual host name] -hostport [virtual host port number] -hostusername [virtual host user name] hostpassword [virtual host password] [-ram [total megabytes] | -usesourceram] -diskprovisioning [thin | thick] -diskmapping [automatic | manual | withvm]
Command Options

The following table describes the options available for the Start-EsxiExport command:

Table 187: Start-EsxiExport command options
Option Description 
-core
 Optional. 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. 
-user
 Optional. 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 user's credentials will be used. 
-password
 Optional. 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 user's credentials will be used. 
-protectedserver
 Protected machine with recovery points to be exported. 
-volumes

Optional. List the volume names you want to export. If you use the value all or use no value, then all volumes in the recovery points are exported. Values must be enclosed in double quotes and separated by a space.

NOTE: Do not use trailing slashes in volume names. For example, specify “c:” not “c:/”.

-rpn
 Optional. 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. 

-time
 Optional. 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/2019 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. 

-vmname
 Windows name of the virtual machine. 
-hostname
 The virtual server host name. 
-hostport
 The virtual server port number. 
-hostusername
 The user name to the virtual server host. 
-hostpassword
 The password to the virtual server host. 
-ram
 Allocate specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server as the source protected machine. 
-diskprovisioning
 Optional. The amount of disk space that will be allocated on the virtual machine. Specify ‘thick’ to make the virtual disk as large as the original drive on the protected server, or ‘thin’ to allocate the amount of actual disk space occupied on the original drive, plus some extra space in megabytes.

By default, ‘thin’ provisioning is selected. 

-diskmapping
 Optional. Select either ‘auto,’ ‘manual,’ or ‘withvm’. By default, auto-mapping is enabled. 
-resetup
 Optional. Recreates virtual machine if it is already presented at the specified location. 
-datacenter
 Optional. Specifies which datacenter to use. 
-resourcepool
 Optional. Specifies which resource pool to use. 
-datastore
 Optional. Specifies which datastore to use. 
-computeresource
 Optional. Specifies which compute resource to use. 
-version
 Optional. Specifies which version of ESXi to use.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating