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

New-Mount

The New-Mount command mounts a snapshot of one or more drives.

Usage

The usage for the command is as follows:

New-Mount -core [host name] -user [user name] -password [password] -protectedserver [machine name] -mounttype [read | write | readonlywithpreviouswrites] -drives [drive names] -path [location] –time [MM/DD/YYYY hh:mm:ss tt | passed | latest] –rpn [number]

Command Options

The following table describes the options available for the New-Mount command:

Table 127: New-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.
-protectedserver
The protected server IP address or machine name (depends on how the particular machine was protected.
-time
Optional. The timestamp of the Recovery Point to mount. This should be in the format that is specified by the OS on the current PC. The administrator is able to get the latest recovery point by specifying latest or last checked recovery point by passed parameter value. By default the latest time option is chosen.
-user
Optional. User name for the remote Core host machine. If you specify a user name, you also have to provide a password. If none are provided, then the logged-on user's credentials will be used.
-password
Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.

If none are provided, then the logged-on user's credentials will be used.

-path
Path on the Core machine to which recovery points will be mounted.
-mounttype
Optional. Specifies a mount mode. Available options are 'read', 'readOnlyWithPreviousWrites' (read-only with previous writes), 'write' (writable). Default mode is read-only.
-volumes
Optional. Space-separated list of volume names to mount. If the volume’s name contains spaces or special characters, it has to be specified using double quotes. If not specified, all volumes will be mounted.
-rpn
Optional. Recovery point number for the mount. You can obtain this using the get-mounts command. Specify several numbers for the rpn parameter to mount different points with a single command.
Note: If you set an array of points to mount, each point will be located in a separate child directory. The name describes the time when the recovery point was created. When you call dismount, all child directories will be removed. You should remove the parent directory manually.

Example:

>New-Mount -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -path C:\MountedRecoveryPoint -mounttype read -volumes c “d, ko”

Mount an array of recovery points:

>New-Mount –rpn 10 52 41 -protectedserver localhost –path “D:/Folder for mount”

Mount a recovery point with certain time created:

>New-Mount -protectedserver 10.10.5.56 –path “D:/Folder for mount” –time “8/24/2012 11:46 AM”

New-Replication

The New-Replication command lets you set up and force replication for a protected server or servers.

Usage

The usage for the command is as follows:

New-Replication -core [host name] -user [login] -password [password] -targetserver [host name] -protectedserver [name | IP address]

Command Options

The following table describes the options available for the New-Replication command:

Table 128: New-Replication 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 also have to provide a password. If none are provided, then the logged-on user's credentials will be 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 are provided, then the logged-on user's credentials will be used.
-replicationname
Name of the replication configuration on the target Core.
-targetserver
The host name, user name, and password for the target Core.
-protectedserver
The name of the protected machine and repository on the target Core for setting up replication.

Example:

Create new replication for the protected machine with IP 10.10.10.4:

Pending examples from QA.

>New-Replication -targetserver 10.10.10.128 -protectedserver 10.10.10.4

New-Repository

The New-Repository command creates a new DVM repository in the Rapid Recovery Core. The size specified must be between 250MB and 16TB.

Usage

The usage for the command is as follows:

New-Repository | –name [name] -size [size] -datapath [location] -metadatapath [location]

Command Options

The following table describes the options available for the New-Repository command:

Table 129: New-Repository 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.
-password
Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a user name. If none are provided, then the logged-on user's credentials will be used.
-name
Repository name.
-size
Size of repository extent. Available units are: b, Kb, MB, GB, TB, PB.
-datapath
For local location only. Determines data path of repository extent.
-metadatapath
For local location only. Determines metadata path of repository extent.
-uncpath
For share location only. Determines data and metadata paths of repository extent.
-shareusername
For share location only. Determines login to share location.
-sharepassword
For share location only. Determines password to share location.
-comment
Optional. Description of repository.
-concurrent
Operations
Optional. Maximum number of operations that can be pending at one time. Value by default: 64.

Example:

Create new DVM repository of minimum size in local drive E:

>New-Repository –name Repository2 -size 250Mb -datapath e:\Repository\Data -metadatapath e:\Repository\Metadata

New-ScheduledArchive

The New-ScheduledArchive command lets you use PowerShell to make changes to an existing scheduled archive.

Usage

The usage for the command is as follows:

New-ScheduledArchive -core [host name] -user [login] -password [password] -all | -protectedserver [name | IP address] -path [location] -archiveusername [name] -archivepassword [password] -cloudaccountname [name] -cloudcontainer [name] -recycleaction [type] -schdeuletype [type] -dayofweek [name] -dayofmonth [number] -time [time]

Command Options

The following table describes the options available for the New-ScheduledArchive command:

Table 130: New-ScheduledArchive 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 also have to provide a password.

If none are provided, then the logged-on user's credentials will be used.

-password
Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.

If none are provided, then the logged-on user's credentials will be used.

-protectedserver
The protected machine with recovery points that you want to archive. You can specify multiple machine names enclosed in double quotes and separated by commas.
-all
Archive recovery points for all protected machines.
-path
The path to where to save the archived data. For example:
  • Local machine: "d:\work\archive"
  • Network path: "\\servername\sharename"
  • Folder in a cloud account: "Folder Name"
Note: The number of symbols should not be greater than 100 for local and network locations, and should not be greater than 150 for a cloud location.
-archiveusername
Optional. The user name for logging in to the remote machine. It is required for a network path only.
-archivepassword
Optional. The password for logging in to the remote machine. It is required for a network path only.
-cloudaccountname

Optional. Use only for cloud archiving. The name of the cloud account where you want to save the archive.

-cloudcontainer

Optional. Use only for cloud archiving. The name of the cloud container in the chosen cloud account, where the archive will be saved. When you use this option, you should also specify the "-cloudaccountname" parameter.

-recycleaction

The type of recycle action. Specified by using one of the following four values:

  • "replacethiscore" - Overwrites any pre-existing archived data pertaining to this Core, but leaves the data for other Cores intact.
  • "erasecompletely" - Clears all archived data from the directory before writing the new archive.
  • "incremental" - Lets you add recovery points to an existing archive. It compares recovery points to avoid duplicating data that already exists in the archive.
-scheduletype

Type of schedule interval. Specified the option with one of the following four values:

  • "daily" - For a daily automatically created archive.
  • "weekly" - For a weekly automatically created archive. You must specify the "-dayofweek" parameter.
  • "monthly" - For a monthly automatically created archive. You must specify the "-dayofmonth" parameter. If a month does not have the day specified—for example, "31"—then the archive will not occur for that month.
  • "lastdayofmonth" - For automatically creating an archive on the last day of each month.
-dayofweek

Use only for the "weekly" option of the "-scheduletype" parameter. The day of the week on which to automatically create the archive (for example, "Monday").

-dayofmonth

Use only for the "month" option of the "-scheduletype" parameter. The day (number) of the month on which to automatically create the archive (for example, "15").

-time
The hour of the day when you want to create an archive.
-initialpause
Optional. Specify this option if you want to initially pause archiving after you configure the archiving schedule.

Examples:

Archive all recovery points with creation dates starting from 04/30/2012 02:55 PM for all machines on the Core, and replace pre-existing archived data pertaining to this Core:

>New-ScheduledArchive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path "d:\work\archive" -s
    tartdate "04/30/2012 02:55 PM" -all -recycleaction replacethiscore

Archive recovery points that fall within a date range for two protected machines, and clear all archived data from the directory before writing the new archive:

>New-ScheduledArchive -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" -recycleaction erasecompletely

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

>New-ScheduledArchive -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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating