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

CreateEncryptionKey

The createencryptionkey command lets you create a phrase to use for securing the data associated with a specified Core.

Usage

The usage for the command is as follows: 

/createencryptionkey -core [host name] -user [user name] -password [password name] -name [encryption key name] -comment [comment or description of key]
Command Options

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

Table 10: CreateEncryptionKey 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. 
-name
 Required. The name of the repository. 
-passphrase
 The passphrase of the encryption key that you want to create. 
-comment
 Optional. A comment on or a description of the encryption key that you want to create.
Example:

Create an encryption key without a comment: 

>cmdutil /createencryptionkey -name EKname -passphrase password

Create an encryption key with a comment: 

>cmdutil /createencryptionkey -name EKname -passphrase password -comment "This is a comment."

CreateRepository

Use the createrepository command to create a new DVM repository on a local machine or on a shared location.

Usage

The usage for the command when creating a DVM repository is as follows: 

/createrepository -name [repository name] -size [size allocated for repository] [[-datapath [datapath] -metadatapath [metdatapath] -uncpath [path for data and metadata] -shareusername [user name for share location] -sharepassword [password for share user name] -concurrentoperations [number of operations to occur at one time] -core [host name] -user [user name] -password [password]
Command Options

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

Table 11: CreateRepository 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 also have to provide a user name. If none is provided, then the credentials for the logged-on user are used. 
-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 the user name to the share location. 
-sharepassword
 For share location only. Determines password to share location. 
-comment
 Optional. Description of repository. 
-concurrentoperations
 Optional. Maximum number of operations that can be pending at one time. Value by default: 64.
Examples:

Create a DVM repository at a local location: 

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

Create a DVM repository at a share location: 

>cmdutil /createrepository -name “Repository 1” -size 200 Gb -uncpath \\share\repository -shareusername login -sharepassword pass123 -comment “First repository.” -concurrentoperations 8 -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd

CredentialsVaultAccount

The credentialsvaultaccount command lets you manage and create accounts in the credentials vault.

Usage

The usage for the command is as follows: 

/credentialsvaultaccount -add | -remove | -update | -merge -accountID [identifying number] -target accountID [identifying number of the target account] -accountusername [user name for the account] -accountpassword [password for the account] -description [description of the account]
Command Options

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

Table 12: CredentialsVaultAccount command options
Option Description 
-?
 Display this help message. 
-add
 Creates a new account in the credentials vault. 
-remove
 Removes an account from the credentials vault. 
-update
Updates the account in the credentials vault. 
-merge
 Merges a specified account with a target account.
-accountID
 The ID of the credentials account stored in the credentials vault. 
-targetaccountID
 When merging accounts, the ID of the credentials account stored in the credentials vault with which you want to merge another specified account.
-accountusername
 User name for logging in to the account. 
-accountpassword
 User password for logging in to the account. 
-description
 Optional. Description for the provided credentials.
Example:

Create new credentials account in the credentials vault: 

>cmdutil /credentialsvaultaccount -add -accountusername admin -accountpassword password -description "Admin credentials"

Remove a credentials account stored in the credentials vault: 

>cmdutil /credentialsvaultaccount -remove -accountID "00000000-0000-0000-0000-000000000000" -accountusername admin -accountpassword password -description "Admin credentials"

Merge credentials accounts stored in the credentials vault: 

>cmdutil /credentialsvaultaccount -merge -accountID "00000000-0000-0000-0000-000000000001" -targetaccountID "00000000-0000-0000-0000-000000000002"

DedupCacheConfig

This command lets you used the Command Line Utility to set the location, size, and metadata location for the primary and secondary cache of a DVM repository.

Usage

The usage for the command when creating a DVM repository is as follows: 

/dedupcacheconfig -core [host name] -user [user name] -password [password] -primary [cache location] -secondary [cache location] -metadata [metadata location] -size [cache size] -restoredefault
Command Options

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

Table 13: DedupCacheConfig 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 also have to provide a user name. If none is provided, then the credentials for the logged-on user are used. 
-primary
 Optional. Primary cache location. 
-secondary
 Optional. Secondary cache location. 
-metadata
 Optional. Metadata cache location. 
-size
 Optional. Deduplication cache size in GB. 
-restoredefault
 Optional. Restore to default deduplication cache configuration. If this parameter is specified, all other parameters are ignored.
Examples:

Set primary deduplication cache location and deduplication cache size: 

>cmdutil /dedupcacheconfig -primary D:\primary -size 6

Set secondary and metadata deduplication location: 

>cmdutil /dedupcacheconfig -secondary D:\secondary -metadata D:\metadata

Restore default deduplication configuration: 

>cmdutil /dedupcacheconfig -restoredefault
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating