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

EnableOracleArchiveLogMode

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

Usage

The usage for the command is as follows:

/enableoraclearchivelogmode -core [host name] -user [user name] -password [password] -protectedserver [name | IP address]
Command Options

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

Table 26: EnableOracleArchiveLogMode 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.
Example:

Enable the Oracle archive log mode for a protected server:

>cmdutil /enableoraclearchivelogmode -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88

ExportRMANBackup

The exportrmanbackup command lets you start an Oracle RMAN backup export job for the specified recovery point of the specified Oracle database..

Usage

The usage for the command is as follows:

/exportrmanbackup -core [host name] -user [user name] -password [password name] -protectedserver [name | IP address] -instancename [Oracle database name] -path [path] -rpn [recovery point number]]
Command Options

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

Table 27: ExportRMANBackup 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
Protected machine for which you want to edit excluded paths.
-instancename
The name of the Oracle database for which you want to start the job.
-path
The path to the destination folder to which you want to export RMAN backups.
-rpn
The sequential number of a recovery point to mount (use /list rps command to see the numbers).
Example:

Start an Oracle RMAN backup export job for the specified recovery point of the specified Oracle database:

>cmdutil /exportrmanbackup -core 10.10.127.42 -use admin -password 676df#df -protectedserver 10.10.45.12 -instancename DB1 -path "D:\RmanBackups\Exported\" -rpn 4

FileSearch

The filesearch command lets you search for a specific file among the recovery points in a repository, which helps you determine which recovery point you need to mount for a restore.

Usage

The usage for the command is as follows:

/filesearch -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -startdate [start date] -enddate [end date] -filemasks [file masks] -paths [paths] -subdiroff -ntfsfastoff -limitsearch [limit search]
Command Options

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

Table 28: FileSearch 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.
-startdate
The earliest date of a period within you want to conduct your search. Use the date pattern "MM/DD/YYYY HH:mm:ss AM."
-enddate
The latest date of a period within you want to conduct your search. Use the date pattern "MM/DD/YYYY HH:mm:ss AM."
-filemasks
A combination of fixed and wildcard characters to search for the file. It can be one string or an array of strings. All masks should be separated by a space; for example: -filemasks "first" "second."
-paths
Optional. If there are specific directories in which you want to search, use this option to list the paths. It can be one string or an array of strings. All directories should be separated by a space; for example: -paths "E:\" "C:\Program Files."
-subdiroff
Optional. By default, the file search is performed in subdirectories. Use this option if you want to turn this feature off and not search in subdirectories.
-ntfsfastoff
Optional. By default, the file search is performed using the NTFS fast algorithm. If you want to perform the search without this feature, specify this option.
-limitsearch
Optional. Use this option to limit the number of search results. The default value is 1000.
Examples:

Perform a file search with one file mask:

>cmdutil /filesearch -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.10 -filemasks "sample"

Perform a file search with multiple file masks in specified directories and without the NTFS fast algorithm:

>cmdutil /filesearch -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.10 -filemasks "sample" "second" -paths "C:\dir" -ntfsfastoff

Force

The force command forces a snapshot of a specified protected server. Forcing a snapshot lets you force a data transfer for the current protected machine. When you force a snapshot, the transfer will start immediately or will be added to the queue. Only the data that has changed from a previous recovery point will be transferred. If there is no previous recovery point, all data on the protected volumes will be transferred.

Usage

The usage for the command is as follows:

/force [snapshot] default | [base] [-all | -protectedserver [name | IP address]] -core [host name] -user [user name] -password [password]
Command Options

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

Table 29: Force command options
Option Description
-?
Display this help message.
-force
Optional. Type of snapshot to create. Available values: 'snapshot' (incremental snapshot) and 'base' (base image snapshot). By default, an incremental snapshot is performed.
-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.
-all
Force snapshots for all machines on the core.
-protectedserver
Force a snapshot for a specific protected machine.
Example:

Force a snapshot for all machines on the Core:

>cmdutil /force snapshot -core 10.10.10.10 -user administrator -password 23WE@#$sdd -all
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating