Chat now with support
Chat with Support

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

Mount

The mount command mounts a snapshot of one or more drives. You can specify whether the mount should be read, write, or read-only with previous writes. The default selection is read-only.

Usage

The usage for the command is as follows:

/mount -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -mounttype [read | write | readOnlyWithPreviousWrites] -drives [drive names] -volumes [volume names] -path [location] -rpn [number | numbers] | -time [time string]

Command Options

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

Table 41: Mount 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.
-protectedserver
Protected machine with a recovery point or points to be mounted.
-mounttype
Optional. Specifies a mount mode. Available values are 'read' (read-only), 'readOnlyWithPreviousWrites' (read-only with previous writes), 'write' (writable). The default mode is read-only.
-volumes	
Optional. List of volume names to mount. If not specified, all volumes are mounted. Values must be enclosed in double quotes and separated by spaces; for example: "c:" "d:". Do not use trailing slashes in volume names.
-path
Path to a folder on the core server to which the recovery point should be mounted. If one does not exist, a folder is automatically created.
-rpn
Optional. The sequential number of a recovery point to mount (use /list rps command to get the numbers). Specify several space-separated numbers to mount multiple recovery points with a single command. In this case data from each recovery point will be stored in a separate child folder. Note: if neither option -time nor -rpn is specified then the most recent recovery point that successfully passed integrity check will be mounted.
-time
Optional. Determines recovery point or points to be selected for mount. Available values include: 'latest', 'passed', exact time in the format "mm/dd/yyyy hh:mm tt" (for instance, "2/24/2012 09:00 AM"). Keep in mind to specify date time values of the time zone set on your PC. If neither the -time option nor the -rpn option is specified, then the most recent recovery point that successfully passed an integrity check is mounted.
-localdrive
Optional. Perform mount to user disk on local PC.

Examples:

Mount the most recent recovery points containing volumes “c:\” and “d:\” in the read-only mode:

>cmdutil /mount -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -path c:\mountedrecoverypoint -mounttype read -volumes "c:" "d:"

Mount recovery points with numbers 2 and 7:

>cmdutil /mount -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -path c:\mountedrecoverypoint -rpn 2 7

MountArchiveRepository

To restore data from an archive in Rapid Recovery, you must first mount it.

Usage

The usage for the command is as follows:

/mountarchiverepository -core [host name] -user [user name] -password [password] -name [archive repository name]

Command Options

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

Table 42: MountArchiveRepository 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.

Examples:

Mount the repository named "NewArchive:"

>cmdutil /mountarchiverepository -name NewArchive

NewCloudAccount

Use the NewCloudAccount command to add an account for a cloud provider to the Rapid Recovery Core. You can then use the account to store archives for retention or replication.

Usage

The usage for the command is as follows:

/newcloudaccount -core [host name] -user [user name] -password [password] -displayname [name for the account] -type [cloud account provider] -useername [user name for the account] -key [secret key] -region [region for account] tenanatid [tenant ID] -authurl [authorization URL]

Command Options

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

Table 43: NewCloudAccount 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.
-displayname
The name you want to use for the cloud account.
-type
The type of cloud account. Supported values include:
  • amazon
  • openstack
  • rackspace
  • windowsazure
  • "windows azure"
  • azure
-username
The user name for the cloud account you want to add. This is the credential you use in the authentication process. The property has the following variations based on the cloud type:
  • Amazon - Access Key
  • OpenStack - User Name
  • Rackspace - User Name
  • Windows Azure - Storage Account Name
-key
The authentication key for the cloud account you want to add. This is the credential you use in the authentication process. The property has the following variations based on the cloud type:
  • Amazon - Secret Key
  • OpenStack - API Key
  • Rackspace - API Key
  • Windows Azure - Access Key
-region
The region of the cloud account you want to add. This option is required only for OpenStack and Rackspace acocunts.
-tenantid
The ID you use to authenticate an OpenStack cloud account. This option is required only for OpenStack accounts.
-authurl
The URL you use to authenticate an OpenStack cloud account. This option is required only for OpenStack accounts.

Examples:

Add a new cloud account with the name "Amazon S3 Account" with the access key "akey" and the secret key "skey:"

>cmdutil /newcloudaccount -displayname "Amazon S3 Account" -type amazon -useername akey -key skey 

OpenDvmRepository

Use this command to open an existing DVM repository created in AppAssure Core or Rapid Recovery Core.

Usage

The usage for the command is as follows:

/opendvmrepository -localpath [local path] -sharepath [network share path] -shareusername [user name for network share] -sharepassword [network share password]

Command Options

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

Table 44: OpenDvmRepository command options
Option Description
-?
Display this help message.
-localpath
The path to the folder with a DVM repository on the local Core.
-sharepath
The path to the folder with the DVM repository on a CIFS share.
-shareusername
The user name you use to log in to the shared folder.
-sharepassword
The password you use to log in to the shared folder.

Example:

Open an existing DVM repository on the local machine:

>cmdutil /opendvmrepository -localpath E:\Repository
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating