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

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 73: 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 74: 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 75: 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

UpdateRepository

The updaterepository command adds a new storage location to an existing DVM repository.

NOTE: This command is deprecated.

Usage

The usage for the command is as follows:

/updaterepository -name [repository name] -size [size of the repository] [-datapath [data path] -metadatapath [metadata path] | [-uncpath [UNC path] -shareusername [share user name] -sharepassword [share password] -core [host name] -user [user name] -password [password]

Command Options

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

Table 76: UpdateRepository command options
Option Description
-?
Display this help message.
-name
Repository name.
-size
Size of repository storage location. Available units are b, Kb, Mb, Gb, Tb, and Pb.
-datapath
For local location only. Determines data path of repository storage location.
-metadatapath
For local location only. Determines metadata path of repository storage location.
-uncpath
For share location only. Determines data and metadata paths of repository storage location.
-shareusername
For share location only. Determines user name to share location.
-sharepassword
For share location only. Determines password to share location.
-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.

Examples:

Create a new storage location in a local DVM repository:

>cmdutil /updaterepository -name “Repository 1” -size 200Gb -datapath d:\repository -metadatapath d:\repository -core 10.10.10.10:8006 -username administrator -password 23WE@#$sdd

Create a storage location for a DVM repository at a shared location:

>cmdutil /updaterepository -name “Repository 1” -size 200Gb -uncpath \\share\repository -shareusername login -sharepassword 23WE@#$sdd -core 10.10.10.10:8006 -username administrator -password 23WE@#$sdd
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating