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

RestoreUrc

The restoreurc command lets you restore a protected machine or volume from a specific Rapid Recovery recovery point to a bare-metal machine using the Universal Recovery Console (URC).

Usage

The usage for the command is as follows:

/restoreurc -protectedserver [name | IP address] -rpn [recovery point number] -volumes [IDs | names | all] -targetmachine [IP address] -urcpassword [password from the URC] -targetdisk [disk number | all]
Command Options

The following table describes the options available for the restoreurc command:

Table 65: RestoreUrc 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 must also provide a password. If none is provided, then the credentials for the logged-on user are 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 is provided, then the credentials for the logged-on user are used.
-protectedserver
The name or IP address of the server you want to which you want to restore the URC.
-rpn
The identification number of the recovery point you want to use to restore the machine. To find the correct number, use the command /list rps.
-volumes
The IDs or names of the volumes you want to restore. To restore all protected volumes, use -volumes all.
-targetmacchine
The name of the machine to which you want to restore the protected machine.
-urcpassword
The authentication key from the URC.
-targetdisk
The numbers of the disks on which you want to restore the machine. To select all disks from the machine using the URC, use -targetdisk all.
Example:

Restore a machine to disks 0 and 1 of the machine using the URC, when the IP address for the URC machine is 192.168.20.175:

>cmdutil /restoreurc -protectedserver 192.168.20.130 -rpn 259 -volumes "C:" "E:" -targetmachine 192.168.20.175 -urcpassword ******** -targetdisk 0 1

Resume

The administrator can use this command to resume snapshots, export to a virtual machine, and replicate. You must specify your need to resume by a parameter. The following parameters are valid: snapshot, vmexport, and replication. See Pause for more details.

Usage

The usage for the command is as follows:

/resume [snapshot | vmexport | replication] -core [host name] -user [user name] -password [password] -all | -protectedserver [name | IP address] -incoming [host name] | outgoing [host name] -time [time string]
Command Options

The following table describes the options available for the resume command:

Table 66: Resume command options
Option Description
-?
Display this help message.
-restore
[snapshots], [replication] or [vmexport].
-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 must also provide a password. If none is provided, then the credentials for the logged-on user are 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 is provided, then the credentials for the logged-on user are used.
-all
Resume all agents on the selected Core.
-protectedserver
Resume current protected server.
-incoming
Host name of the remote core that replicates to the core machine.
-outgoing
Host name of the remote target core to which data is replicated.
Examples:

Resume snapshots for specific protected server:

>cmdutil /resume snapshot -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.4

Resume export to a virtual machine for all protected machines on the core:

>cmdutil /resume vmexport –core 10.10.10.10 -user administrator -password 23WE@#$sdd -all

Resume outgoing replication on the core for a specific protected machine:

>cmdutil /resume replication -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.1.76

Resume outgoing replication for all protected machines on the target core:

>cmdutil /resume replication -core 10.10.10.10 -user administrator -password 23WE@#$sdd -outgoing 10.10.1.63

Resume incoming replication for all machines on the target core:

>cmdutil /resume replication -core 10.10.10.10 -user administrator -password 23WE@#$sdd -incoming 10.10.1.82

ResumeScheduler

This command lets you resume the task scheduler it has been paused.

Usage

The usage for the command is as follows:

/resumescheduler -core [host name] -user [user name] -password [password]
Command Options

The following table describes the options available for the resumescheduler command:

Table 67: ResumeScheduler command options
Option Description
-?
Display this help message.
-restore
[snapshots], [replication] or [vmexport].
-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 must also provide a password. If none is provided, then the credentials for the logged-on user are 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 is provided, then the credentials for the logged-on user are used.
Example:

Resume snapshots for specific protected server:

>cmdutil /resumescheduler -core 10.10.127.42 -user admin -password 676df#df

SeedDrive

You can use a seed drive for the initial data transfer when you establish Rapid Recovery replication.

Usage

The usage for the command is as follows:

/seeddrive [-list | -startcopy | -startconsume | -abandon] -path [local | network path] -seeddriveusername [user name] -seeddrivepassword [password] -remotecore [name] [-targetcore [name or IP] | -protectedserver [name] | -all] -usecompatibleformat
Command Options

The following table describes the options available for the seeddrive command:

Table 68: SeedDrive 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.
-list
The list of outstanding seed drives with extended information.
-startcopy
Start copying data to the seed drive.
-startconsume
Start consuming the seed drive.
-abandon
Abandon the outstanding seed drive request.
-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.
-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.
-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:

List outstanding seed drives:

>cmdutil /seeddrive -list

Copy two protected machines to the seed drive on the network share:

>cmdutil /seeddrive -startcopy -remotecore TargetCoreName -path \\10.10.1.1\Share\Seed\ -seeddriveusername Administrator -seeddrivepassword 12345 -usecompatibleformat

Starting consuming the seed drive:

>cmdutil /seeddrive -startconsume -path \\10.10.1.1\Share\Seed\ -seeddriveusername Adminsitrator -seeddrivepassword 12345 -remotecore RemoteCoreName

Abandon an outstanding seed drive request:

>cmdutil /seeddrive -abandon RemoteCoreHostName

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating