Chat now with support
Chat with Support

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

Edit-HyperVVirtualStandby

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

Usage

The usage for the command is as follows: 

Edit-HyperVVirtualStandby [-HostName <String>] [-HostPort <String>] [-HostUserName <String>] [-HostPassword <String>] [-VMLocation <String>] [-UseLocalMachine] [-gen2] [-UseVhdx] [-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>] -exportvmconfigfiles

Command Options

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

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

-hostname
 Virtual server host name.
-hostport
 Virtual server port number.
-hostusername
 Login to the virtual server host.
-hostpassword
 Password to the virtual server host.
-vmlocation
 Location of the virtual machine.
-uselocalmachine
 Optional. Connect to the local Hyper-V server. In this case, the command ignores the following options: 'hostname', 'hostport', 'hostusername', and 'hostpassword'.
-gen2
 Optional. The virtual machine generation. If not specified, the command uses generation 1. Windows Server 2012 R2 and 
-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). 

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

Lists all active jobs on the local Core: 

>Get-activejobs –all

Edit-OracleDBVerifyNightlyJob

Use the command Edit-OracleDBVerifyNightlyJob to enable or disable this nightly job for specific Oracle machines that are under protection.

Usage

The usage for the command is as follows: 

Edit-OracleDBVerifyNightlyJob -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] [-enable | -disable] [-global]

Command Options

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

Table 88: Edit-OracleDBVerifyNightlyJob 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 DBVerify nightly job. 
-enable
 Use this option to enable the DBVerify nightly job for the specified protected machine. 
-disable
 Use this option to disable the DBVerify nightly job for the specified protected machine. 
-global
 Use this option to apply the specified setting as the default for this Core.

Examples:

Enable the Oracle DBVerify nightly job for a protected server: 

Edit-OracleDBVerifyNightlyJob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -enable

Disable the Oracle DBVerify nightly job for a protected server: 

Edit-OracleDBVerifyNightlyJob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -disable

Edit-OracleLogTruncationNightlyJob

Use the command Edit-OracleLogTruncationNightlyJob to enable or disable this nightly job for specific Oracle machines that are under protection and to set the deletion policy and retention duration for the logs.

Usage

The usage for the command is as follows: 

Edit-OracleLogTruncationNightlyJob -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] [-enable | -disable] [-global] [-usedefault] -deletionpolicy [automatic | keepnewest | keepspecificnumber] -retentionduration [duration value] -retentionunit [day | week | month | year] -numberoffiles [number of archive files to create]

Command Options

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

Table 89: Edit-OracleLogTruncationNightlyJob 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 Oracle log truncation as a nightly job. 
-enable
 Use this option to enable log truncation for the specified protected machine. This is the default option and can be omitted. 
-disable
 Use this option to disable log truncation for the specified protected machine. 
-global
 Use this option to apply the specified setting as the default for this Core. 
-all
 This option applies the specified changes for every protected machine that has at least one Oracle instance installed. 
-usedefault
 Optional. Use this option to apply the default Core settings to the specified machine, which may also be set by using the -global option. 
-deletionpolicy
 Optional. This option must be represented by one of the following values:
  • "automatic"
  • "keepnewest"
  • "keepspecificnumber"
-retentionduration
 Optional. This value determines the length of time to keep a log before truncating and is constrained to positive integer values. If using the "keepnewest" value of the -deletionpolicy option, a retention duration value is required. 
-retentionunit
 Optional. This option identifies the time unit for the -retentionduration option. It must be represented by one of the following values:
  • "day"
  • "week"
  • "month"
  • "year"
-numberoffiles
 Optional. This option sets the number of recent archive log files to keep. If using the "keepspecificnumber" value of the -deletionpolicy option, a number of files value is required.

Examples:

Edit the Oracle log truncation nightly job settings for the Core globally: 

Edit-OracleLogTruncationNightlyJob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -global -deletionpolicy keepspecificnumber -numberoffiles 15

Disable the Oracle log truncation nightly job for a specified protected server: 

Edit-OracleLogTruncationNightlyJob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -disable

Edit-Replication

Use the Edit-Replication to make changes to an existing replication relationship between two Cores.

Usage

The usage for the command is as follows: 

Edit-Replication -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -incoming [host name] -outgoing [host name] -add

Command Options

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

Table 90: Edit-Replication 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 is provided, then the credentials for the logged-on user are 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 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 Oracle log truncation as a nightly job. 
-add
 Add protected servers to an existing replication. 
-scheduletype
 The type of replication schedule. This option should be specified by one of the following values:
  • 1. "atalltimes" - to automatically replicate at all times.
  • 2. "daily" - to automatically replicate once each day, with specific "-dailystarttime" and "-dailyendtime" parameters.
  • 3. "custom" - to automatically replicate on specified weekdays or weekends designated by "-weekdaystarttime," "-weekdayendtime," "-weekendstarttime," and "-weekendendtime" parameters. 
-dailystarttime
 Use only for the daily value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the earliest time of day when you want replication to start. 
-dailyendtime
 Use only for the daily value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the latest time of day when you want replication to start. 
-weekdaystarttime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the earliest time of a weekday when you want replication to start. 
-weekdayendtime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the latest time of a weekday when you want replication to start. 
-weekendstarttime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the earliest time of the weekend when you want replication to start. 
-weekendendtime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the latest time of the weekend when you want replication to start.

Examples:

Edit the replication schedule by specifying weekdays and weekends: 

>Edit-Replication -id RemoteServerHostName -scheduletype custom -weekdaystarttime "9:00 AM" -weekdayendtime "6:00 PM" -weekendstarttime "9:00 AM" -weekendendtime "6:00 PM"

Add protected servers to existing replication: 

>Edit-Replication -id RemoteServerHostName -protectedserver "10.10.1.1","Repository1"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating