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

ApplyLicense

There may be times when you need to change the Rapid Recovery license applied to a machine, such as when moving from a trial license to a subscription or perpetual license. In such instances, you can change the license in the Command Prompt by using the applylicense command.

Usage

The usage for the command is as follows: 

/applylicense -core [host name] -user [user name] -password [password] -licensekey [license key] -licensepath [license file path] -licensenumber [license number] -email [email address]
Command Options

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

Table 2: ApplyLicense 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. 
-licensekey
 Optional. A 30-character key comprising six groups of five alphanumeric characters, each separate by a hyphen. Use this key when a license file is not available. 
-licensepath
 Optional. The path to the file that ends with the .lic extension. If a license file is available, you can use this option instead of the -licensekey. 
-licensenumber
 Optional. You may have received this nine-digit license number in an order confirmation email. If you provide this number, use the email address that received it for verification. 
-email
 Optional. If you use the -licensenumber, you must include the email address that received it for verification.
Examples:

Change the license key associated with this Core to JL09F-89FSD-6THFS-DSE34-KS3D5-65DF2: 

>cmdutil /applylicense -core 10.10.10.10 -user admin -password 676df#df -licensekey JL09F-89FSD-6THFS-DSE34-KS3D5-65DF2

Change the license key associated with this Core to the key contained in the license file: 

>cmdutil /applylicense -core 10.10.10.10 -user admin -password 676df#df -licensepath C:\MyLicenseFile.lic

Change the license number associated with this Core to 111-111-111 using john.doe@example.com to verify the license: 

>cmdutil /applylicense -core 10.10.10.10 -user admin -password 676df#df -licensenumber 111-111-111 -email john.doe@example.com

Archive

Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature in Rapid Recovery supports extended retention for compliant and non-compliant data. The administrator can save an archive on the local storage or network location by specifying the -path parameter and credentials.

Usage

The usage for the command is as follows: 

/archive -core [host name] -user [user name] -password [password] -all | -protectedserver [name | IP address | "[name1 | IP address1]" "[name2 | IP address2]"] -path [location] -startdate [time string] -enddate [time string] -archiveusername [name] -archivepassword [password] -comment [text] -cloudaccountname [name] -cloudcontainer [name] -recycleaction [type] -scheduletype [type] -dayofweek [name] -dayofmonth [number] -time [time] -usecompatibleformat -scheduled -edit -id [id] -initialpause -useglacierfordatfiles
Command Options

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

Table 3: Archive 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. 
-all
 Archive all recovery points for all protected machines on the Core. 
-protectedserver
 Protected machine with recovery points to be archived. You can specify several machine names enclosed in double quotes and separated by spaces. 
-path
 Path where archived data should be placed; for example: d:\work\archive or network path \\servername\sharename. 
-startdate
 Start date for selecting recovery points by creation date. The value must be enclosed in double quotes; for example, "04/30/2012 02:55 PM". 
-enddate
 Optional. End date for selecting recovery points by creation date. Value must be enclosed in double quotes; for example, "05/31/2012 11:00 AM". The current time system is used by default. 
-archiveusername
 Optional. User name for the remote machine. Required for network path only. 
-archivepassword
 Optional. Password to the remote machine. Required for network path only. 
-comment
 Optional. Comment text must be enclosed in double quotes; for example: -comment “comment goes here...”. 
-usecompatibleformat
 Not supported for scheduled archives. The new format has improved performance, but it is not compatible with Cores older than release 6.2. Use this flag to create an archive that can be used with the old format. 
-cloudaccountname
 Optional. The name of the cloud account to which you want to save the archive. 
-cloudcontainer
 Optional. The name of the cloud container in the specified cloud account to which you want to save the archive. 
-recycleaction
 Specifies one of the following recycle action types:
  • "donotreuse" - This type is not supported for scheduled archive. It does not overwrite or clear any existing archived data from the location. If the location is not empty, the archive write fails.
  • "replacethiscore" - This type overwrites any pre-existing archived data that pertains to this Core, but leaves the data for other Cores intact.
  • "erasecompletely" - This type clears all archived data from the directory before writing the new archive.
  • "incremental" - This type lets you add recovery points to an existing archive. It compares recovery points to avoid duplicating data that already exists in the archive. 
-scheduled
 Optional. Specify this option to configure a scheduled archive job. 
-edit
 Optional. Use only for scheduled archives. Specify this option to edit an existing scheduled archive configuration. 
-id
 The identifier (ID) of the scheduled archive that you want to edit. 
-scheduletype
 The type of interval that you want to use for the scheduled archive. It should specify according to one of the following four values:
  • "daily" - To automatically create an archive every day.
  • "weekly" - To automatically create an archive once each week.
  • "monthly" - To automatically create an archive once each month.
  • "lastdayofmonth" - To automatically create an archive on the last day of each month. 
-dayofweek
 Only applies to the "weekly" option of the -scheduletype parameter. Specify the day on which you want to automatically create an archive (for example, "Monday"). 
-dayofmonth
 Only applies to the "monthly" option of the -scheduletype parameter. Specify the date of the month on which you want to automatically create an archive using a number (for example "1" for the first day of the month). 
-time
 The hour of the day at which you want to automatically create an archive. 
-initialpause
 Optional. Specify whether you want to initially pause the archive job when you create it. 
-useglacierfordatafiles
 Optional. Only when archiving to an Amazon cloud. Specify this option if you want to use Amazon Glacier for archiving data files.
Examples:

Archive all recovery points with creation dates starting from 04/30/2012 02:55 PM for all machines on the Core: 

>cmdutil /archive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path d:\work\archive -startdate “04/30/2012 02:55 PM” -all

Archive recovery points that fall within a date range for two protected machines: 

>cmdutil /archive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver "10.20.30.40" "20.20.10.1" -path d:\work\archive -startdate "04/30/2012 02:55 PM" -enddate "05/31/2012 11:00 AM"

Archive all recovery points with creation dates starting from 04/30/2012 02:55 PM for all machines on the Core to a cloud storage account with the name "Amazon S3" and container named "Container": 

>cmdutil /archive -scheduled -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path "ArchiveOnCloud" -cloudaccountname "Amazon S3" -cloudcontainer "Container" -startdate “04/30/2012 02:55 PM” -all -recycleaction incremental

Create a scheduled archive fo the last day of every month for machine 10.20.30.40 and replace pre-existing archived data pertaining to this Core: 

>cmdutil /archive -scheduled -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path "d:\work\archive" -recycleaction replacethiscore -scheduletype lastdayofmonth -time "10:00 PM"

Edit the path of an existing scheduled archive configuration: 

>cmdutil /archive -scheduled -edit -id F595F697-2126-4F77-AE93-27AE2A022AF1 -protectedserver 10.20.30.40 -path "d:\work\Newarchive"

Edit the path and schedule type of an existing scheduled archive configuration: 

>cmdutil /archive -scheduled -edit -id F595F697-2126-4F77-AE93-27AE2A022AF1 -protectedserver 10.20.30.40 -path "d:\work\Newarchive" -scheduletype daily -time "10:00 PM"

BackupSettings

The backupsettings command lets you back up the settings of the local Core to a specified location.

NOTE: After the Core settings have been backed up using this command or from the Core Console, you can restore them. For example, you can run the RestoreSettings command.

Usage

The usage for the command is as follows: 

/backupsettings -localpath
Command Options

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

Table 4: BackupSettings command options
Option Description 
-?
 Display this help message. 
-localpath
 The path for the configuration backup.
Example:

Back up your settings of the Core: 

>cmdutil /backupsettings -localpath D:\work\archive

CancelActiveJobs

Use the cancelactivejobs command to cancel the execution of all in-progress jobs of a specific type, such as transfer or replication.

Usage

The usage for the command is as follows: 

/cancelactivejobs [-protectedserver [name : IP address] : -a[ll]] -core [host name] -user [user name] -password [password] -jobtype [job type filter]
Command Options

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

Table 5: CancelActiveJobs command options
Option Description 
-?
 Display help on the command. 
-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 must also provide a user name. If none is provided, the logged-in user’s credentials are used. 
-protectedserver
 Determines the protected machine on which the jobs should be canceled. 
-all
 Select and cancel events of specified type for all protected servers. 
-jobtype
 Optional. Specifies job type filter. Available values are:
  • ‘transfer’ (data transfer)
  • ‘repository’ (repository maintenance)
  • ‘replication’ (local and remote replications)
  • ‘backup’ (backup and restore)
  • ‘bootcdbuilder’ (create boot CDs)
  • ‘diagnostics’ (upload logs)
  • ‘exchange’ (Exchange Server files check)
  • ‘export’ (recovery point export)
  • ‘pushinstall’ (deploy agents)
  • ‘restore’ (recovery point restore)
  • ‘rollup’ (recovery point rollups)
  • ‘sqlattach’ (agent attachability checks)
  • ‘mount’ (mount repository)

By default, all jobs of the specified type are canceled.

Example:

Cancel all transfer jobs on Core 10.10.10.10: 

>cmdutil /cancelactivejobs -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -jobtype transfer
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating