Chat now with support
Chat with Support

Rapid Recovery 6.8 - 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

CreateRepository

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

Note: This command is deprecated.

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 10: 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

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 11: 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

DeleteReplication

This command lets you remove a replication configuration from a source Core or target Core, as well as remove replicated recovery points.

Usage

The usage for the command is as follows: 

/deletereplication -incoming [replication IDs] -outgoing [replication IDs] -deleterecoverypoints

Command Options

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

Table 12: DeleteReplication 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. 
-incoming
 The identifier (ID) of the incoming replication that should be deleted. It could be a remote Core ID or a host name. Use the word "all" to delete all replications.

Note: You can specify different protected machines for different replications by using the following pattern: Replication1:Agent1,Agent2;Replication2:Agent2,Agent3. If you do not specify a machine after the colon (:), the replication is deleted for all replicated machines. 

-outgoing
 The identifier (ID) of the outgoing replication that should be deleted. It could be a remote Core ID or a host name. Use the word "all" to delete all replications.

Note: You can specify different protected machines for different replications by using the following pattern: Replication1:Agent1,Agent2;Replication2:Agent2,Agent3. If you do not specify a machine after the colon (:), the replication is deleted for all replicated machines. 

-deletepoints
 Specify which recovery points, if any, of the replicated machine that you want to remove.

Example:

Delete all incoming and all outgoing replications: 

>cmdutil /deletereplication -incoming all -outgoing all

Delete two outgoing replications with all machines: 

>cmdutil /deletereplication -outgoing TargetCore1;TargetCore2

Delete one protected machine from incoming replication and delete recovery points: 

>cmdutil /deletereplication -incoming TargetCore1:10.10.10.10 -deletepoints

DeleteRepository

You can use the DeleteRepository command to remove an entire DVM repository created in AppAssure Core or Rapid Recovery Core.

NOTE: This command is deprecated.

Usage

The usage for the command is as follows: 

/deleterepository -core [host name] -user [user name] -password [password] name] -name [repository name] | -a [all repositories]

Command Options

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

Table 13: DeleteRepository 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. 
-a
 Optional. This option deletes all DVM repositories associated with the Core. 
-name
 The name of the DVM repository you want to delete.

Example:

Delete all DVM repositories: 

>cmdutil /deleterepository -a

Delete the repository with the name "RepositoryName:" 

>cmdutil /deleterepository -name RepositoryName
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating