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

Edit-VBVirtualStandby

The Edit-VBVirtualStandby command lets you use PowerShell to make changes to an existing virtual export to a VirtualBox virtual machine (VM).

Usage

The usage for the command is as follows:

Edit-VBVirtualStandby [-TargetPath <String>] [-PathUserName <String>] [-PathPassword <String>] [-LinuxHostName <String>] [-HostPort <UInt32>] [-AccountUserName <String>] [-AccountPassword <String>] [-ProtectedServer <String>] [-Volumes <String[]>] [-VMName <String>] [-UseSourceRam] [-Ram <String>] [-User <String>] [-Core <String>] [-Password <String>] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>]
Command Options

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

Updated option descriptions TK.

Table 100: Edit-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.
-all
Show all jobs, including those performed by the Core and all protected servers.
-number
Optional. Determine how many records to display. available values are:

all (display all jobs); l[number] or [number] (fetches ## most recent jobs sorted by execution and time); f[number] (displays first ## recovery jobs sorted by execution and time). By default, the 20 most recent jobs are shown.

-jobtype
Optional. Specifies the job type filter. Available values are: 'transfer' (data transfer), 'repository' (repository maintenance), 'replication' (local and remote replications), 'backup' (backup and restore), 'bootcdbuilder' (create boot CDs), 'diagnostics' (upload logs), 'exchange' (Exchange Server files check), 'export' (recovery point export), 'pushinstall' (deploy agents), 'rollback' (restoring from a recovery point), 'rollup' (recovery point rollups), 'sqlattach' (agent attachability checks), and 'mount' (mount repository). By default, all jobs of the specified type are returned.
-time
Optional. Filter output by date and time for the job started. Available types of input include:

#d or DD (where # is a number for the period of time of days before now until now)

#h or #H (where # is number for the period of hours before now until now)

“time date 1”, “time date 2” (to show a custom range of time from a specific date appearing before the comma to a specific date following the comma).

Examples:

Lists all active jobs on the local Core:

>Get-activejobs –all

Edit-VMVirtualStandby

The Edit-VMVirtualStandby command lets you use PowerShell to make changes to an existing virtual export to a VMware Workstation virtual machine (VM).

Usage

The usage for the command is as follows:

 Edit-VMVirtualStandby [-TargetPath <String>] [-PathUserName <String>] [-PathPassword <String>] [-ProtectedServer <S
    tring>] [-Volumes <String[]>] [-VMName <String>] [-UseSourceRam] [-Ram <String>] [-User <String>] [-Core <String>]
    [-Password <String>] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-Er
    rorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>]
Command Options

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

Table 101: Edit-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.

-targetpath
The local or network path (or Linux path, only for VirtualBox export) to the folder for storing the virtual machine files.
-pathusername
The credentials for the target path when it is located on a network share and you specified it with the -targetpath option.
-pathpassword
The password for the target path when it is located on a network share and you specified it with the -targetpath option.
-protectedserver
The protected machine with recovery points that you want to export, indicated by IP address.
-volumes
Optional. A list of volume names that you want to export. When not specified, all volumes export. Values must be separated by a comma.

NOTE: Do not use trailing slashes in volume names; for example, use c,d.

-vmname
The Windows name of the virtual machine.
-ram
Use this option to allocate a specific amount of RAM on the virtual server.
-usesourceram
Optional. Allocate all of the amount of RAM on the target virtual server that is used on the source virtual server.
Examples:

Edit a specific amount of RAM on the existing Virtual Standby:

>Edit-VMVirtualStandby -targetpath "\\servername\sharename" -pathusername "login" -pathpassword "password" -protectedserver 10.10.11.245 -vmname "name" -ram 2048

Edit the list of volume names to be exported to the existing Virtual Standby:

>Edit-VMVirtualStandby -targetpath "\\servername\sharename" -pathusername "login" -pathpassword "password" -protectedserver 10.10.11.245 -vmname "name" -volumes c,d

Enable-HyperVAutoProtection

The Enable-HyperVAutoProtection cmdlet lets you enable the auto-protection of new virtual machines (VMs) on a Hyper-V host.

Usage

The usage for the command is as follows:

Enable-HyperVAutoProtection -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address]
Command Options

The following table describes the options available for the Enable-HyperVAutoProtection command:

Table 102: Enable-HyperVAutoProtection 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.

-repository
Required. The name of the repository that is associated with the Core that you want to use to store the data of the virtual machine.
Note: You must enclose the name in double quotes.
-protectedserver
Use this option to protect virtual machines.
Examples:

Enable auto-protection of new VMs on a Hyper-V host:

>Enable-HyperVAutoProtection -protectedserver 10.10.1.1 -repository "Repository 1"

Enable-OracleArchiveLogMode

Use the command Enable-OracleArchiveLogMode to enable or disable this mode for specific Oracle machines that are under protection.

Usage

The usage for the command is as follows:

Enable-OracleArchiveLogMode -core [host name] -user [user name] -password [password] -protectedserver [name | IP address]
Command Options

The following table describes the options available for the Enable-OracleArchiveLogMode command:

Table 103: Enable-OracleArchiveLogMode 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. The user name for the remote Core host machine. If you specify a user name, you must also provide a password. If none is provided, then the credentials for the logged-on user are used.
-password
Optional. The password to the remote Core host machine. If you specify a password, you also have to provide a user name. If none is provided, then the credentials for the logged-on user are used.
-protectedserver
Use this option to specify the protected machine for which you want to enable the Oracle archive log mode.
Examples:

Enable the Oracle archive log mode for a protected server:

>Enable-OracleArchiveLogMode -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating