Chat now with support
Chat with Support

Rapid Recovery 6.8 - 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

Start-EsxiExport

The Start-EsxiExport PowerShell command initiates the launch of a virtual export from the selected Rapid Recovery recovery point to an ESX(i) 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-EsxiExport -core [host name] -user [user name] -password [password] -protectedserver [machine name | IP address] -volumes [volume names] -rpn [number | numbers] | -time [time string] -vmname [virtual machine name] -hostname [virtual host name] -hostport [virtual host port number] -hostusername [virtual host user name] hostpassword [virtual host password] [-ram [total megabytes] | -usesourceram] -diskprovisioning [thin | thick] -diskmapping [automatic | manual | withvm]

Command Options

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

Table 167: Start-EsxiExport command options
Option Description
-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. 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.
-hostname
The virtual server host name.
-hostport
The virtual server port number.
-hostusername
The user name to the virtual server host.
-hostpassword
The password to the virtual server host.
-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.
-diskprovisioning
Optional. The amount of disk space that will be allocated on the virtual machine. Specify ‘thick’ to make the virtual disk as large as the original drive on the protected server, or ‘thin’ to allocate the amount of actual disk space occupied on the original drive, plus some extra space in megabytes.

By default, ‘thin’ provisioning is selected.

-diskmapping
Optional. Select either ‘auto,’ ‘manual,’ or ‘withvm’. By default, auto-mapping is enabled.
-resetup
Optional. Recreates virtual machine if it is already presented at the specified location.
-datacenter
Optional. Specifies which datacenter to use.
-resourcepool
Optional. Specifies which resource pool to use.
-datastore
Optional. Specifies which datastore to use.
-computeresource
Optional. Specifies which compute resource to use.
-version
Optional. Specifies which version of ESXi to use.

Start-HypervExport

The Start-HypervExport PowerShell command initiates the launch of a virtual export from the selected Rapid Recovery recovery point to a Hyper-V server virtual machine.

Usage

The usage for the command is as follows:

Start-HypervExport -core [host name] -user [user name] -password [password] -protectedserver [[machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | -time [time string] [-vmname [uselocalmachine] | -hostname [virtual host name] -hostport [virtual host port number] -hostusername [virtual host user name] -hostpassword [virtual host password] -vmlocation [location]] [-ram [total megabytes] | -usesourceram] -diskformat [VHD | VHDX] -exportvmconfigfiles

Command Options

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

Table 168: Start-HypervExport 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. 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.
-gen2
Optional. Specify to use the second VM generation. If not specified, generation 1 is used. Rapid Recovery supports generation 2 from Windows Server 2012 R2 through Windows 8.1.
-usevhdx
Optional. If you specify this option, Rapid Recovery uses the VHDX disk format to create the VM. If you do not, it uses the VHD disk format. Generation 2 uses only the VHDX format.
-uselocalmachine
Optional. Connect the local Hyper-V server. If this parameter is used, the following options are ignored: hostname, host port, host username, host password.
-hostname
The virtual server host name.
-hostport
The virtual server port number.
-hostusername
The user name to the virtual server host.
-hostpassword
The password to the virtual server host.
-vmlocation
Local or network path to the folder where you want to store the virtual machine files.
-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.
-exportvmconfigfiles
Optional. Specify whether to export virtual machine configuration files. This option is available only both when the source is a virtual protected agentlessly and when the target hpyervisor is the same as the source hypervisor.

Example:

Create a Hyper-V machine file to be stored on a remote machine:

>Start-HypervExport -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -vmlocation \\WIN7-Bobby\virtualmachines -hostname 10.10.10.23 -hostport 443 –hostusername root –hostpassword 12QWsdxc@# -ram 4096

Start-LogTruncation

The Start-LogTruncation command forces log truncation for the specified protected SQL Server or Microsoft Exchange server.

Usage

The usage for the command is as follows:

Start-LogTruncation -core [host name] -user [user name] -password [password] -protectedserver [[machine name] or [IP address]] -target [sql | exchange]

Command Options

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

Table 169: Start-LogTruncation 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
Archive of recovery points for the specified machine.
-target
Specify the type of log truncation (either ‘sql’ or ‘exchange’). If not specified, logs are truncated on all databases.

Example:

Truncate SQL logs:

>Start-LogTruncation -protectedserver SQL1 -target sql

Truncate Exchange server logs: all recovery points for all machines on the Core:

> start-LogTruncation -protectedserver ExServer2 -target exchange

Start-MountabilityCheck

The Start-MountabilityCheck command forces a mountability check for protected Microsoft Exchange mail stores.

Usage

The usage for the command is as follows:

Start-MountabilityCheck -core [host name] -user [user name] -password [password] -protectedserver [[machine name] or [IP address]] -rpn [number | numbers] | 
-time [time string]

Command Options

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

Table 170: Start-MountabilityCheck 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
Archive of recovery points for the specified machine.
-rpn
Optional. The sequential number of a recovery point to be exported. (You can use the -GetRecoveryPoints 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.

Example:

Start a mountability check for oall recovery points for all machines on the Core:

> Start-MountabilityCheck -protected EX01
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating