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

Open-DvmRepository

Use this command to open an existing DVM repository created in AppAssure Core or Rapid Recovery Core.

Usage

The usage for the command is as follows: 

Open-DvmRepository -localpath [local path] -sharepath [network share path] -shareusername [user name for network share] -sharepassword [network share password]
Command Options

The following table describes the options available for the Open-DvmRepository command:

Table 148: Open-DvmRepository command options
Option Description 
-?
 Display this help message. 
-localpath
 The path to the folder with a DVM repository on the local Core. 
-sharepath
 The path to the folder with the DVM repository on a CIFS share. 
-shareusername
 The user name you use to log in to the shared folder. 
-sharepassword
 The password you use to log in to the shared folder.
Examples:

Open an existing DVM repository on the local machine: 

Open-DvmRepository -localpath E:\Repository

Push-Replication

The Push-Replication command forces replication for one or more protected machines.

Usage

The usage for the command is as follows: 

Push-Replication -core [host name] -user [user name] -password [password] -targetcore [host name] -all | -protectedserver [machine name | IP address]
Command Options

The following table describes the options available for the Push-Replication command:

Table 149: Push-Replication command options
Option Description 
-?
 Display this help message. 
-all
 Force replication for all machines being replicated to the target Core. 
-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. 
-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 name on the target Core against which to force replication. 
-user
 Optional. Login for the remote Core host machine. If you specify a login, you also have to provide a password. If none are provided, then the logged-on user's credentials will be used.
Examples:

Push replication for a single protected machine: 

>Push-Replication -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd 
-targetcore 10.10.10.20:8006 –protectedserver 10.10.5.22

Push replication for all protected machines: 

>Push-Replication -all

Push-Rollup

The Push-Rollup command forces rollup for a protected machine.

Usage

The usage for the command is as follows: 

Push-Rollup -core [host name] -user [user name] -password [password] -protectedserver [machine name | IP address]
Command Options

The following table describes the options available for the Push-Rollup command:

Table 150: Push-Rollup command options
Option Description 
-?
 Display this help message. 
-all
 Force all protected machines. 
-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. 
-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
 Force for the current protected machine’s name. 
-user
 Optional. Login for the remote Core host machine. If you specify a login, you also have to provide a password. If none are provided, then the logged-on user's credentials will be used.
Examples:

Push rollup for a single protected machine: 

>Push-Rollup -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd –protectedserver 10.10.5.22

Push rollup for all protected machines: 

>Push-Rollup -all

Remove-Agent

The Remove-Agent PowerShell cmdlet lets you remove a machine from protection on a Rapid Recovery Core.

Usage

The usage for the command is as follows: 

Remove-Agent -core [host name] -user [login] -password [password] -protectedserver [name | IP address] -deleterecoverypoints -all
Command Options

The following table describes the options available for the Remove-MountAgent command:

Table 151: Remove-Agent 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. 

-protectedserver
 Dismount all mounted recovery points for the current protected machine. 
-deleterecoverypoints
 Optional. Delete all recovery points for this protected machine. 
-all
 Optional. Delete all protected machines from the Core.
Examples:

Dismount all protected machines and their recovery points: 

>Remove-Agent -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -deleterecoverypoints -all
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating