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

Add-HyperVClusterSharedVirtualDisks

The Add-HyperVClusterSharedVirtualDisks cmdlet lets you add shared Hyper-V virtual disks under the protection of a Core.

Usage

The usage for the command is as follows: 

Add-HyperVClusterSharedVirtualDisks -core [host name] -user [user name] -password [password] -repository [name] -shareddisks [shared virtual disks name or path collection | all]

Command Options

The following table describes the options available for the Add-HyperVClusterSharedVirtualDisks command:

Table 79: Add-HyperVClusterSharedVirtualDisks 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. 

-repository
 Required. The name of the repository that is associated with the Core that you want to use to store the data of the virtual machine.
Note: You must enclose the name in double quotes. 
-protectedserver
 Use this option to edit the shared virtual disks for a specific protected machine. 
-shareddisks
 A list of shared disks each separate by a comma.

Example:

Protect all of the shared virtual disks on a cluster: 

>Add-HyperVClusterSharedVirtualDisks -protectedserver "HV-2012R2" -repository "Repository_10.10.55.133"  -shareddisks "all"

Add-HyperVClusterVirtualMachines

The Add-HyperVClusterVirtualMachines cmdlet lets you add specific virtual machines (VMs) from a Hyper-V cluster under the protection of a Core.

Usage

The usage for the command is as follows: 

Add-HyperVClusterVirtualMachines -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address] -virtualmachines [virtual machines collection | all]

Command Options

The following table describes the options available for the Add-HyperVClusterVirtualMachines command:

Table 80: Add-HyperVClusterVirtualMachines 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. 

-repository
 Required. The name of the repository that is associated with the Core that you want to use to store the data of the virtual machine.
Note: You must enclose the name in double quotes. 
-protectedserver
 Use this option to protect virtual machines. 
-virtualmachines
 A list of the virtual machines that you want to protect, each separated by a comma. The name of the VM must be enclosed in double quotes.

Example:

Add specific VMs of a Hyper-V cluster under protection by the Core: 

>Add-HyperVClusterVirtualMachines -repository "Repository 1" -protectedserver hvcluster -virtualmachines "Win8x64-gen1", "Win2012x64-gen2"

Add-HyperVVirtualMachines

The Add-HyperVVirtualMachines cmdlet lets you add specific virtual machines (VMs) from a Hyper-V cluster under the protection of a Core.

Usage

The usage for the command is as follows: 

Add-HyperVVirtualMachines -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address] -virtualmachines [virtual machines collection | all]

Command Options

The following table describes the options available for the Add-HyperVVirtualMachines command:

Table 81: Add-HyperVVirtualMachines 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. 

-repository
 Required. The name of the repository that is associated with the Core that you want to use to store the data of the virtual machine.
Note: You must enclose the name in double quotes. 
-protectedserver
 Use this option to edit Hyper-V objects for a specific virtual machine. 
-virtualmachines
 A list of the virtual machines that you want to protect, each separated by a comma. The name of the VM must be enclosed in double quotes.

Example:

Add specific VMs of a Hyper-V cluster under protection by the Core: 

>Add-HyperVVirtualMachines -repository "Repository 1" -protectedserver HVServer1 -virtualmachines "Win8x64-gen1", "Win2012x64-gen2"

Disable-HyperVAutoProtection

The Disable-HyperVAutoProtection cmdlet lets you disable the auto-protection feature, which automatically protects new virtual machines (VMs), on a Hyper-V host.

Usage

The usage for the command is as follows: 

Disable-HyperVAutoProtection -core [host name] -user [user name] -password [password] -protectedserver [name | IP address]

Command Options

The following table describes the options available for the Disable-HyperVAutoProtection command:

Table 82: Disable-HyperVAutoProtection 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 display name, host name, or IP address of the protected Hyper-V server.

Example:

Disable auto protection of new virtual machines on the specified Hyper-V host: 

>Disable-HyperVAutoProtection -protectedserver "10.10.1.1"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating