Chat now with support
Chat with Support

Rapid Recovery 6.9 - Commands and Scripting Reference Guide

Introduction to Rapid Recovery Command Line Management utility PowerShell module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets
Add-EsxAutoProtectObjects Add-EsxVirtualMachines Add-HyperVClusterSharedVirtualDisks Add-HyperVClusterVirtualMachines Add-HyperVVirtualMachines Disable-HyperVAutoProtection Edit-AzureVirtualStandby Edit-EsxiVirtualStandby 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-ExchangeMailStores Get-Failed Get-FailedJobs Get-HyperVClusterSharedVirtualDisks Get-ListAzureVMSizes Get-Mounts Get-OracleInstances Get-Passed Get-ProtectedServers Get-ProtectionGroups Get-QueuedJobs Get-RecoveryPoints Get-ReplicatedServers Get-Repositories Get-ScheduledArchives Get-SqlDatabases Get-TransferQueueEntries Get-UnprotectedVolumes Get-Version Get-VirtualizedServers Get-Volumes 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 Push-Replication Push-Rollup Remove-Agent Remove-EsxAutoProtectObjects Remove-HyperVClusterSharedVirtualDisks Remove-HyperVClusterVirtualMachines Remove-HyperVVirtualMachines Remove-Mount Remove-Mounts Remove-RecoveryPoints Remove-RemoteMount Remove-RemoteMounts Remove-Replication Remove-Repository Remove-ScheduledArchive Remove-VirtualStandby Restart-CoreService Resume-Replication Resume-ScheduledArchive Resume-Snapshot Resume-VirtualStandby Set-AgentMetadataCredentials Set-DedupCacheConfiguration Set-License Set-OracleMetadataCredentials Set-ReplicationResponse Start-Archive Start-AttachabilityCheck Start-AzureDeploy Start-AzureExport Start-ChecksumCheck 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-ScheduledArchive Start-VBExport Start-VirtualStandby Start-VMExport Stop-ActiveJobs Stop-CoreService Suspend-Replication Suspend-ScheduledArchive Suspend-Scheduler Suspend-Snapshot Suspend-VirtualStandby Suspend-VMExport Update-Repository
Localization Qualifiers
Scripting

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:

Table 195: Suspend-VMExport 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 user name. If none are provided, then the logged-on user's credentials will be used. 
-all
 Pauses all protected machines on the selected Core. 
-protectedserver
 Pause the current protected server.

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 DVM repository. The size specified must be between 250MB and 16TB.

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]

Command Options

The following table describes the options available for the Update-Repository command:

Table 196: Update-Repository 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 user name. If none are provided, then the logged-on user's credentials will be used. 
-name
 DVM repository name. 
-size
 Size of DVM repository extent. Available units are: b, Kb, MB, GB, TB, PB. 
-datapath
 For local location only. Determines data path of DVM repository extent. 
-metadatapath
 For local location only. Determines metadata path of DVM repository extent. 
-uncpath
 For share location only. Determines data and metadata paths of DVM repository extent. 
-shareusername
 For share location only. Determines login to share location. 
-sharepassword
 For share location only. Determines password to share location.

Example:

Add an extent to the DVM repository of the minimum size: 

>Update-Repository -name Repository1 -size 250Mb -datapath C:\Repository\Data -metadatapath C:\repository\Metadata

Localization

When running on the same machine on which Rapid Recovery Core is installed, the Rapid Recovery PowerShell module bases its display language on the language set for the Core. Localized Rapid Recovery versions such as this one support English, Chinese (Simplified), French, Korean, German, Japanese, Portuguese (Brazil), and Spanish.

For Non-English releases, use: Rapid Recovery Core release 6.1.1 is an English-only release. As a result, English is the only language supported for the PowerShell Module. AppAssure release 6.0.2 is the most recent localized version of the Core software. In that release, supported languages include English, Chinese (Simplified), French, Korean, German, Japanese, Portuguese (Brazil), and Spanish.
If the Rapid Recovery PowerShell module is installed on a separate machine, English is the only language supported.

Qualifiers

The following table describes the qualifiers available for Rapid Recovery PowerShell Module.

Table 197: Rapid Recovery PowerShell module qualifiers
Qualifier Usage 
-core <Rapid Recovery Core Name>
 Host name of the Core.

Default: Localhost

-ProtectedServer <Protected Server Name>
 Host name/IP address of the Rapid Recovery Agent.

Default: Localhost if multiple servers protected, otherwise the single server protected. 

-Mode <READ, READWRITE, WRITE>
 Recovery Point Mount mode.

Default: Read. 

-Volumes <Snapshot Volume Letter>
 Snapshot volume letter from Rapid Recovery Agent.

Default: All. 

-User <User Name>
 User name used to connect to the Rapid Recovery Core.

This is typically the service user. 

-Domain <Domain Name>
 Domain to which the user defined in /User belongs. 
-Password <Password>
 Password of the user defined in /User. 
-Path <Target path to mount, dismount recovery points or archive location>
 For example: C:\RapidRecoveryMount.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating