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

StartOracleDBVerifyJob

Use the command startoracledbverifyjob to start the DBVerify job for one or more specified recovery points on a protected server.

Usage

The usage for the command is as follows:

/startoracledbverifyjob -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -recoverypointnumber [number | numbers]
Command Options

The following table describes the options available for the startoracledbverifyjob command:

Table 73: StartOracleDBVerifyJob 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.
-recoverypointnumber
The sequential number of a recovery point that you want to export (use the /list rps command to get the numbers). To start the job on multiple recovery points with one command, separate each recovery point number with a space.
Example:

Start the Oracle DBVerify job for the recovery points on the specified protected server:

>cmdutil /startoracledbverifyjob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -recoverypointnumber 1 2

StartOracleLogTruncationJob

The command startoraclelogtruncationjob lets you start a log truncation job for a specified Oracle instance on a protected server.

Usage

The usage for the command is as follows:

/startaclelogtruncationjob -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -instancename [instance SID] -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 startoraclelogtruncationjob command:

Table 74: StartOracleLogTruncationJob 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.
-instancename
The name of the Oracle instance for which you want to start log truncation.
-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:

Start the Oracle log truncation job for the ORCL instance on a specified protected server:

>cmdutil /startoraclelogtruncationjob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -instancename ORCL

Start the Oracle log truncation job for the ORCL instance on a specified protected server and configure the deletion policy as "keepnewest" with the logs kept for 10 days:

>cmdutil /startoraclelogtruncationjob -protectedserver 10.10.34.88 -instancename ORCL -deletionpolicy keepnewest -retentionduration 10 -retentionunit day

StopCoreService

Use this command to stop the Core service on a Core machine.

Usage

The usage for the command is as follows:

/stopcoreservice -core [host name] -user [user name] -password [password] -cancelactivejobs [true | false] -wait [time in seconds]
Command Options

The following table describes the options available for the stopcoreservice command:

Table 75: StopCoreService 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.
-cancelactivejobs
Optional. Use this option to cancel all active jobs on the Core. The default setting is "false."
-wait
Optional. This option indicates that the command should wait until the Core service is fully stopped for the specified period of time in seconds before canceling active jobs.
Example:

Stop the Core service:

>cmdutil /stopcoreservice -core 10.10.127.42 -user admin -password 676df#df -cancelactivejobs true -wait 600

SuspendScheduler

This command lets you suspend or pause the task scheduler it has been paused.

Usage

The usage for the command is as follows:

/suspendscheduler -core [host name] -user [user name] -password [password] -cancelactivejobs [true | false]
Command Options

The following table describes the options available for the suspendscheduler command:

Table 76: SuspendScheduler command options
Option Description
-?
Display this help message.
-restore
[snapshots], [replication] or [vmexport].
-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.
-cancelactivejobs
Optional. Use this option to cancel all active jobs on the Core. The default setting is "false."
Example:

Pause the task scheduler:

>cmdutil /suspendscheduler -core 10.10.127.42 -user admin -password 676df#df -cancelactivejobs true
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating