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

CreateArchiveRepository

When you create an archive repository, you create a destination for the contents of a scheduled archive. This feature lets you mount an archived recovery point and restore a machine without importing the archive.

Usage

The usage for the command is as follows: 

/createarchiverepository -core [host name] -user [user name] -password [password] name] -name [archive repository name] -path [path to the archive] -archiveusernamme [network user name] -archivepassword [network password] -cloudaccountname [name of the cloud account] -cloudcontainer [name of the cloud container]

Command Options

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

Table 6: CreateArchiveRepository 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 archive repository. 
-path
 The path to the existing archive. It can be a local, network, or cloud location. For example: d:\work\archive or \\servername\sharename. 
-archiveusername
 Optional. This option is the login to the remote machine. It is required for a network path only. 
-archivepassword
 Optional. This option is the password for the remote machine. It is only required for a network path only. 
-cloudaccountname
 Optional. This option is the display name for an existing cloud account. It is required for a cloud path only. 
-cloudcontainer
 Optional. The cloud container is where the archive is located. It is required for a cloud path only.

Examples:

Create an archive repository with the name "NewArchive:" 

>cmdutil /createarchiverepository -name NewArchive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path d:\work\archive

Additionally, if an archive contains more than one location, then the command should include paths for all of the segments ordered from 1 to N, where N equals the number of segments.

Create an archive repository with the name "NewSegmentArchive:" 

>cmdutil /createarchiverepository -name NewSegmentArchive -path1 \\RemmoteServer1\Share\Archive\Segment1 - archiveusername1 Administrator -archivepassword1 23WE@#$sdd -path2 Archives\NewSegment -cloudcontainer2 ArchiveContainer -cloudaccountname AmazonS3Local - path3 d:\work\archive\Third

CreateBootCD

This command lets you create a bare metal restore (BMR) boot CD without using the Rapid Recovery Core Console.

Usage

The usage for the command is as follows: 

/createbootcd -ip [IP address] -mask [mask] -defaultgateway [defaultgateway] -dnsserver [dnsserver] -vncpassword [vncpassword] -vncport [vncport] -isofilepath [destination for the boot image]

Command Options

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

Table 7: CreateBootCD command options
Option Description 
-?
 Display this help message. 
-ip
 Optional. This option specifies the IP address of the target BMR machine. By default, it generates automatically. 
-mask
 Optional. This option specifies the subnet mask of the target BMR machine. By default, it generates automatically. 
-defaultgateway
 Optional. This option specifies the default gateway of the target BMR machine. By default, it generates automatically. 
-dnsserver
 Optional. This option specifies the DNS server for the target BMR machine. By default, it generates automatically. 
-vncpassword
 Optional. This option specifies the user password for an existing UltraVNC account. By default, this option is empty. 
-vncport
 Optional. This option specifies the port to use for UltraVNC. You can change it only if you used the -vncpassword option. By default, the port is 5900. 
-isofilepath
 Optional. This option specifies the patch to the boot CD file. The default path is C:\ProgramData\AppRecovery\Boot CDs.

Example:

Create a boot CD: 

>cmdutil /createbootcd -ip 192.168.20.188 -mask 255.255.255.0 -defaultgateway 192.168.20.2 -dnsserver 192.168.20.2 -isofilepath D:\bcd\newbcd3.iso

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 8: 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."

CreateNASRepository

Use the createnasrepository command to create a new NAS repository in Azure.

Usage

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

/createnasrepository -name [repository name] -storageaccountid [storageaccountid] -datadirectory [datadirectory] -maxsize [maxsize] -dedupecachesize [dedupecachesize] -concurrentOperations [concurrentOperations] -comment [comment] -core [host name] -user [login] -password [password]

Command Options

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

Table 9: CreateNASRepository 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.
-storageccountid ID of the Azure storage account that will serve as the container for repository data.
-datadirectory Path to a directory on the local file system for storing deduplication and metadata caches, index files, logs, and other information.
-maxsize
 Maximum size of repository. Available units are GB and TB. 
-dedupecachesize
 Optional. Amount of memory to be allocated for deduplication cache. Available units are B, KB, MB, and GB. The default value is 1.5 GB. 
-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 NAS repository: 

>cmdutil /createnasrepository -name “Repository 1” -storageaccountid AzureStorageID -maxsize 200 Gb -datadirectory d:\repository\data -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating