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-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 96: 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 97: 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 98: 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"

Edit-ScheduledArchive

The Edit-ScheduledArchive cmdlet lets you use PowerShell to make changes to an existing scheduled archive.

Usage

The usage for the command is as follows: 

Edit-ScheduledArchive -core [host name] -user [login] -password [password] -all | -protectedserver [name | IP address | "[name1 | IP address1]" "[name2 | IP address2]"] -path [location] -cloudaccountname [name] -cloudcontainer [name] -recycleaction [type] -scheduletype [type] -dayofweek [name] -dayofmonth [number] -time [time] -initialpause -id [id]
Command Options

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

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

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

-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, where 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 four 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. 
-id
 The identifier of the scheduled archive that you want to edit.
Examples:

Edit a scheduled archive on the local Core: 

>Edit-ScheduledArchive -protectedserver protectedserver1 -path d:\work\archive -cloudaccountname cloud1 -cloudcontainer cloudarchives -recycleaction incremental -scheduletype daily -time 12:00 AM -initialpause -i
    d archiveid
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating