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

EditHyperVCluster

You can use the edithypervcluster command whenever you want to add or remove a Hyper-V cluster or virtual machine using agentless protection.

Usage

The usage for the command is as follows: 

/edithypervcluster -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -add | -remove -virtualMachines [virtual machines collection | all] -shareddisks [name/path collection | all]
Command Options

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

Table 22: EditHyperVCluster 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. 
-repository
 Required. The name of the repository that is associated with the Core that you want to use to protect the virtual machine.

NOTE: You must enclose the name in double quotes.

-protectedserver
 The name of the protected cluster from which you want to add or remove virtual machines or shared virtual disks. 
-add
 Use this option to add virtual machines or shared virtual disks under protection. 
-remove
 Use this option to remove a virtual machine or shared virtual disks from protection. 
-virtualmachines
 Optional. This option lets you list the clusters or virtual machines that you want to protect. Separate the names by spaces and enclose the names of virtual machines in double quotes. 
-deleterecoverypoints
 Optional. This option can only be used with the "-remove" parameter. Use it to delete all recovery points for specified virtual machines. 
-shareddisks
 Optional. List the shared virtual disks that you want to protect or remove, separated by spaces. The name of the shared virtual disk must be enclosed double quotes.
Example:

Protect a specific Hyper-V cluster with the Core: 

>cmdutil /edithypervcluster -protectedserver 10.10.8.150 -add -shareddisks C:\SharedDisks\Folder1

EditHyperVServer

You can use the edithypervserver command whenever you want to add or remove a Hyper-V server using agentless protection.

Usage

The usage for the command is as follows: 

/edithypervserver -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -add | -remove -virtualmachines [virtual machines collection | all]
Command Options

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

Table 23: EditHyperVServer 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. 
-repository
 Required. The name of the repository that is associated with the Core that you want to use to protect the virtual machine.
Note: You must enclose the name in double quotes. 
-protectedserver
 Use this option to specify Hyper-V objects for a specific protected machine. 
-add
 Use this option to add specific Hyper-V objects under protection. 
-remove
 Use this option to remove specific Hyper-V objects from protection. 
-virtualmachines
 Optional. This option lets you list the virtual machines that you want to protect. Separate the names by spaces and enclose the names of virtual machines in double quotes.
Example:

Protect all of the virtual machines for a specific Hyper-V server: 

>cmdutil /edithypervserver -protectedserver 10.10.8.150 -add -virtualmachines all

EditOracleDBVerifyNightlyJob

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

Usage

The usage for the command is as follows: 

/editoracledbverifynightlyjob -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 editoracledbverifynightlyjob command:

Table 24: EditOracleDBVerifyNightlyJob 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. 
-repository
 Required. The name of the repository that is associated with the Core that you want to use to protect the virtual machine.
Note: You must enclose the name in double quotes. 
-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. 
-all
 This option applies the specified changes for every protected machine that has at least one Oracle instance installed.
Example:

Enable the Oracle DBVerify nightly job for a protected server: 

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

EditOracleLogTruncationNightlyJob

Use the command editoraclelogtruncationnightlyjob 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: 

/editoraclelogtruncationnightlyjob -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 editoraclelogtruncationnightlyjob command:

Table 25: EditOracleLogTruncationNightlyJob 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:

Enable the Oracle log truncation nightly job for a protected server: 

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

Enable the Oracle log truncation nightly job (when -enable is the default option) for a protected server and configure the deletion policy as "keepnewest" with the logs kept for 10 days: 

>cmdutil /editoraclelogtruncationnightlyjob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -deletionpolicy keepnewest -retentionduration 10 -retentionunit day
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating