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

New-ScheduledArchive

The New-ScheduledArchive cmdlet lets you create a new scheduled archive for your Rapid Recovery Core.

Usage

The usage for the command is as follows: 

New-ScheduledArchive -core [host name] -user [login] -password [password] -all | -protectedserver [name | IP address] -path [location] -archiveusername [name] -archivepassword [password] -cloudaccountname [name] -cloudcontainer [name] -recycleaction [type] -schdeuletype [type] -dayofweek [name] -dayofmonth [number] -time [time]
Command Options

The following table describes the options available for the New-ScheduledArchive command:

Table 144: New-ScheduledArchive 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 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 must also provide a user name.

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

-protectedserver
 The protected machine with recovery points that you want to archive. You can specify multiple machine names enclosed in double quotes and separated by commas. 
-all
 Archive recovery points for all protected machines. 
-path
 The path to where to save the archived data. For example:
  • Local machine: "d:\work\archive"
  • Network path: "\\servername\sharename"
  • Folder in a cloud account: "Folder Name"

NOTE: The number of symbols should not be greater than 100 for local and network locations, and should not be greater than 150 for a cloud location. 

-archiveusername
 Optional. The user name for logging in to the remote machine. It is required for a network path only. 
-archivepassword
 Optional. The password for logging in to the remote machine. It is required for a network path only. 
-cloudaccountname
 Optional. Use only for cloud archiving. The name of the cloud account where you want to save the archive.
-cloudcontainer
 Optional. Use only for cloud archiving. The name of the cloud container in the chosen cloud account in which the archive will be saved. When you use this option, you should also specify the "-cloudaccountname" parameter.
-recycleaction
 The type of recycle action. Specified by using one of the following values:
  • "replacethiscore" - Overwrites any pre-existing archived data pertaining to this Core, but leaves the data for other Cores intact.
  • "erasecompletely" - Clears all archived data from the directory before writing the new archive.
  • "incremental" - Lets you add recovery points to an existing archive. It compares recovery points to avoid duplicating data that already exists in the archive. 
-scheduletype
 Type of schedule interval. Specified the option with one of the following four values:
  • "daily" - For a daily automatically created archive.
  • "weekly" - For a weekly automatically created archive. You must specify the "-dayofweek" parameter.
  • "monthly" - For a monthly automatically created archive. You must specify the "-dayofmonth" parameter. If a month does not have the day specified—for example, "31"—then the archive will not occur for that month.
  • "lastdayofmonth" - For automatically creating an archive on the last day of each month. 
-dayofweek
 Use only for the "weekly" option of the "-scheduletype" parameter. The day of the week on which to automatically create the archive (for example, "Monday").
-dayofmonth
 Use only for the "month" option of the "-scheduletype" parameter. The day (number) of the month on which to automatically create the archive (for example, "15").
-time
 The hour of the day when you want to create an archive. 
-initialpause
 Optional. Specify this option if you want to initially pause archiving after you configure the archiving schedule. 
-useglacierfordatafilea
 Optional. Specify this option only when archiving to Amazon S3 Glacier.
Examples:

Archive all recovery points with creation dates starting from 04/30/2019 02:55 PM for all machines on the Core, and replace pre-existing archived data pertaining to this Core: 

>New-ScheduledArchive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.20.30.40 -path "d:\work\archive" -startdate "04/30/2019 02:55 PM" -all -recycleaction replacethiscore

Archive recovery points that fall within a date range for two protected machines, and clear all archived data from the directory before writing the new archive: 

>New-ScheduledArchive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver "10.20.30.40" "20.20.10.1" -path "d:\work\archive" -startdate "04/30/2019 02:55 PM" -enddate "05/31/2019 11:00 AM" -recycleaction erasecompletely

Create an incremental archive for all recovery points with creation dates starting from 04/30/2019 02:55 PM for all machines on the Core to the cloud account with the name "Amazon S3" and a container named "Container": 

>New-ScheduledArchive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path "ArchiveOnCloud" -cloudaccountname "Amazon S3" -cloudcontainer "Container" -startdate "04/30/2019 02:55 PM" -all -recycleaction incremental

New-Snapshot

The New-Snapshot cmdlet forces a snapshot resulting in a data transfer for the current protected machine. When you force a snapshot, the transfer starts immediately or is added to the queue. Only the data that has changed from a previous recovery point is transferred. If there is no previous recovery point, all data on the protected volumes is transferred.

Usage

The usage for the command is as follows: 

New-Snapshot [-all] | -protectedserver [machine name]] -core [host name] -user [user name] -password [password]
Command Options

The following table describes the options available for the New-Snapshot command:

Table 145: New-Snapshot 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. 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.
Examples:

Force a snapshot for all protected machines: 

>New-Snapshot -all

New-VBVirtualStandby

The New-VBVirtualStandby cmdlet lets you use PowerShell to create a new virtual export to an Oracle VM VirtualBox virtual machine.

Usage

The usage for the command is as follows: 

New-VBVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address] -volumes [volumes names] -vmname [virtual machine name] [-ram [total megabytes] | -usesourceram]  -linuxhostname [linux hostname] -hostport [linux port] -targetpath [location] -pathusername [login] -pathpassword [password] -initialexport
Command Options

The following table describes the options available for the New-VBVirtualStandby command:

Table 146: New-VBVirtualStandby 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
 Show jobs for a specific protected machine, indicated by IP address. 
-volumes
 Optional. List the volume names you want to export. If not specified, all volumes in the recovery point(s) are exported. Values must be enclosed in double quotes and separated by space; for example, "c:", "d:".

NOTE: Do not use trailing slashes in volume names

-vmname
 The Microsoft Windows name of the Oracle VM VirtualBox virtual machine. 
-ram
 Allocate a specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server that the source protected machine has. 
-linuxhostname
 The Linux Oracle VM VirtualBox server host name. 
-hostport
 The Linux Oracle VM VirtualBox server port. 
-targetpath
 The local, network, or Linux path to the folder where you want to store the virtual machine files. 
-pathusername
 The user name for logging in to the network machine. It is only required when you specify a network location for the target path. 
-pathpassword
 The password for logging in to the network machine. It is only required when you specify a network location for the target path. 
-accountusername
 Optional. You can specify a user account with which to register the exported virtual machine. It is the user name for logging in to the user account. Use this option for a local or network machine only. 
-accountpassword
 Optional. You can specify a user account with which to register the exported virtual machine. It is the password for logging in to the user account. Use this option for a local or network machine only. 
-initialexport
 Optional. Specify this option if you need to start an initial on-demand virtual machine export after configuring the virtual standby.
Examples:

Create a VirtualBox virtual standby machine named ExportedMachine1 in a specified location:

Pending example from QA. 

>New-VBVirtualStandby -protectedserver 10.10.10.4 -volumes c:\ -vmname ExportedMachine1 -usesourceram -targetpath I:\VMExport

New-VMVirtualStandby

The New-VMVirtualStandby PowerShell command lets you create a new VMware Workstation virtual standby machine using Rapid Recovery.

Usage

The usage for the command is as follows: 

New-VMVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address] -volumes [volumes names] -vmname [virtual machine name] [-ram [total megabytes] | -usesourceram] -targetpath [location] -pathusername [login] -pathpassword [password] -initialexport
Command Options

The following table describes the options available for the New-VMVirtualStandby command:

Table 147: New-VMVirtualStandby 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
 Show jobs for a specific protected machine, indicated by IP address. 
-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:/”.

-vmname
 The Microsoft Windows name of the virtual machine. 
-ram
 Allocate a specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server that the source protected machine has. 
-pathusername
 The user name for logging in to the network machine. It is only required when you specify a network location for the target path. 
-pathpassword
 The password for logging in to the network machine. It is only required when you specify a network location for the target path. 
-initialexport
 Optional. Specify this option if you need to start an initial on-demand virtual machine export after configuring the virtual standby.
Examples:

Create a new VMware Workstation virtual standby: 

>New-VMVirtualStandby -protectedserver 10.10.10.4 -volumes C:\ -vmname ExportedMachine1 -usesourceram -targetpath I:\VMExport

Script pauses, requiring user to specify an index number for the appropriate workstation. Enter the index number for the script to complete (in this case, 2). Example continues: 

2
Verify location ...
Virtual Standby successfully configured
PS C:\Users\Administrator>
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating