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-ScheduledArchive

The Start-ScheduledArchive PowerShell cmdlet lets you force a scheduled archive to begin on demand, regardless of the pre-established schedule.

Usage

The usage for the command is as follows:

Start-ScheduledArchive -core [host name] -user [login] -password [password] -all -ids [id | id1 id2]
Command Options

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

Table 204: Start-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 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.

-all
Force all scheduled archives.
-id or ids
The identification number or comma-separated identifiers of the scheduled archives that you want to force. Obtain IDs using command Get-ScheduledArchives.
Examples:

Start multiple scheduled archive jobs:

>Start-ScheduledArchive -ids 799138c8-3dfc-4398-9711-1823733c2a31, 26c29bb7-b320-47f5-b5a8-dffc49f50e25

Start-VBExport

The start-VBExport cmdlet initiates the launch of a virtual export from the selected recovery point to an Oracle VM VirtualBox 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-VBExport -core -user [user name] -password [password] -protectedserver [machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | 
-time [time string] -vmname [virtual machine name] [-ram [total megabytes] | 
-usesourceram] -linuxhostname [linux hostname] -hostport [linux port] -targetpath [location] pathusername [user name] - pathpassword [password]
Command Options

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

Table 205: Start-VBExport 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.
-protectedserver
Protected machine with recovery points to be exported.
-volumes
Optional. List of volume names to be exported. If not specified, all volumes in the specified recovery points will be exported. Values must be enclosed in double quotes, each 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/2015 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.
-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.
-linuxhostname
Linux VirtualBox server hostname.
-hostport
Linux VirtualBox server port.
-targetpath
Local or network or Linux path to the folder where the virtual machine files are to be stored.
-pathusername
User name for network machine. Only required when you specify network path in parameter -targetpath.
-pathpassword
Password for network machine. Only required when you specify network path in parameter -targetpath.
-accountusername
Optional. Use if you can specify a user account to register the exported virtual machine. For local or network machine only.
-accountpassword
Optional. Use only when you specify a user account to register the exported virtual machine using parameter -accountusername. For local or network machine only.
Examples:

Export all volumes from the latest recovery point on machine 10.10.12.97 to a VM called NewVirtualBoxVM:

>Start-VBExport -protectedserver 10.10.12.97 -vmname NewVirtualBoxVM -ram usesourceram -targetpath D:/exports

Start-VirtualStandby

The Start-VirtualStandby PowerShell cmdlet lets you force virtual export from a specified protected machine or machines. This on-demand export can occur outside of the regularly schedule defined for virtual standby continual exports.

Usage

The usage for the command is as follows:

Start-VirtualStandby -core [host name] -user [login] -password [password] -all | -protectedserver [name(s) | IP address]
Command Options

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

Table 206: Start-VirtualStandby 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.

-all
Force an export for all virtual standby machines.
-protectedserver
The name or names—separated by a comma and space—of the protected machines that you want to force to export.
Examples:

Force virtual export on demand for a protected machine to a virtual standby VM:

>Start-VirtualStandby -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22

Start-VMExport

The Start-VMExport cmdlet initiates the launch of a virtual export on demand from the selected recovery point to a VMware Workstation server virtual machine.

Required parameters include the name of the protected machine containing recovery points to export; the name of the VM you are exporting to; the amount of RAM to be allocated on the VM; and the path to the local or network folder where the resulting VM files are stored.

Usage

The usage for the command is as follows:

Start-VMExport -core -user [user name] -password [password] -protectedserver [machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | 
-time [time string] -vmname [virtual machine name] [-ram [total megabytes] | 
-usesourceram] -linuxhostnme [linux hostname] -hostport [linux port] -targetpath [location] pathusername [user name] - pathpassword [password]
Command Options

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

Table 207: Start-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.
-protectedserver
Protected machine with recovery points to be exported.
-volumes
Optional. List of volume names to be exported. If not specified, all volumes in the specified recovery points will be exported. Values must be enclosed in double quotes, each 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/2015 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.
-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.
-targetpath
Local or network or Linux path to the folder where the virtual machine files are to be stored.
-pathusername
User name for network machine. Only required when you specify network path in parameter -targetpath.
-pathpassword
Password for network machine. Only required when you specify network path in parameter -targetpath.
-version
Version of VMware Tools to use. Valid versions are: 7, 8, 9, and 10.
-cpus
Optional. Number of processors which should be set for exported VM. By default, the value from the original machine will be used.
-corespercpu
Optional. Number of cores per processor which should be set for exported VM. By default, the value from the original machine will be used.
Examples:

Export all volumes from the latest recovery point on machine 10.10.12.97 to a VM called NewVMwareVM:

>Start-VBExport -protectedserver 10.10.12.97 -vmname NewVMWareVM -ram usesourceram -targetpath D:/exports
Related Documents