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

Start-ProtectCluster

The Start-ProtectCluster command lets an administrator add a server cluster under protection by a Core.

Usage

Usage for the command is as follows: 

Start-ProtectCluster -core [host name] -user [user name] -password [password] -repository [repository name] -clustername [name | IP address] -clusterusername [user name for cluster] -clusterpassword [password for cluster] -clusterport [port] -clustervolumes [volume names] -clusternodes [cluster nodes names and volumes]

Command Options

The following table describes the options available for the Start-ProtectCluster command:

Table 175: Start-ProtectCluster 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. 
-repository
 Name of a repository on the Core where the protected machine's data is stored. The name must be enclosed in double quotes. 
-clustername
 The name of the cluster to protect. 
-clusterusername
 User name for the cluster to be protected. 
-clusterpassword
 Password to the cluster to be protected. 
-clusterport
 Port number for the cluster to be protected. 
-clustervolumes
 List of volumes to protect. Values must be in double quotes and separated by a space. Do not use trailing slashes in volume names. For example, “c:”, “d”. 
-clusternodes
 List of cluster nodes with volumes to protect. First specify label “nodename” and then type the name of the node. Then, specify label “volumes” and then type a list of volumes for the node.

For example: “nodename”, “10.10.10.10”, “volumes”, “c:”, “e:”, “nodename”, “10.10.10.11,” “volumes”, “c:”

Example:

Put volumes of a server under protection: 

>Start-ProtectCluster -repository "Repository 1" -clustername 10.10.9.120 -clusterusername administrator -clusterpassword 12345 -clusterport 5002 -clustervolumes "c:" "d:" -clusternodes nodename 10.10.10.10 volumes “c:” “e:”

Start-ProtectEsxServer

You can use the Start-ProtectEsxServer command whenever you want to add a VMware ESX(i) virtual machine to protection.

Usage

The usage for the command is as follows: 

Start-ProtectEsxServer -core [host name] -user [user name] -password [password] -repository [repository name] -server [name | IP address] -serverusername [user name] -serverpassword [password for server login] -serverport [port] -virtualMachines [virtual machines collection | all] -autoProtect [object ID or name collection]

Command Options

The following table describes the options available for the Start-ProtectEsxServer command:

Table 176: Start-ProtectEsxServer 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. 
-repository
 Required. The name of the repository that is associated with the Core that you want to use to protect the virtual machine.
Note: You must enclose the name in double quotes. 
-server
 The name or IP address for the vCenter or ESXi server you want to protect. 
-serverusername
 The user name for logging in to the vCenter or ESXi server that you want to protect. 
-serverpassword
 The password for logging in to the vCenter or ESXi server that you want to protect. 
-serverport
 Optional. The port number for the vCenter or ESXi server that you want to protect. 
-virtualmachines
 Optional. This option lets you list the virtual machines that you want to protect. 
-autoprotect
 Optional. This option lets you list new virtual machines that you want to automatically protect.

Example:

Protect specific virtual machines from a vCenter or ESXi server with the Core: 

>Start-ProtectEsxServer -core 10.10.10.10 -user admin -password password -repository "Repository 1" -server 10.10.8.150 -serverport 443 -serverusername root -serverpassword password -virtualmachines "VM1" "VM2" -autoprotect "Folder1"

Start-ProtectHyperVCluster

The Start-ProtectHyperVCluster command adds a Hyper-V cluster under protection by a Core using agentless protection.

Usage

The usage for the command is as follows: 

Start-ProtectHyperVCluster -core [host name] -user [user name] -password [password] -repository [name] -server [name | IP address] -serverusername [user name] -serverpassword [password] -serverport [port] -virtualmachines [virtual machines collection | all] -isagentprotection

Command Options

The following table describes the options available for the Start-ProtectHyperVCluster command:

Table 177: Start-ProtectHyperVCluster 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. 
-repository
 Name of a repository on the Core to which the protected machine data should be stored. The name must be enclosed in double quotes. 
-server
 Name or IP address of the Hyper-V server that you want to protect. 
-serverusername
 User name for the Hyper-V server to be protected. 
-serverpassword
 Password for the Hyper-V server to be protected. 
-serverport
 Optional. Protected Hyper-V server port number. 
-virtualmachines
 Optional. List of virtual machines to protect. Values must be enclosed in double quotes and separated by a space. If you exclude this parameter, only the Hyper-V cluster container is protected. 
-isagentprotection
 Optional. Use this option to protect a cluster with an Agent in each guest virtual machine, which is false by default. 
-autoprotect
 Optional. This option enables the autoprotect feature for the Hyper-V server. It is not compatible with the -isagentprotection option.

Example:

Protect specific virtual machines of a Hyper-V cluster: 

>Start-ProtectHyperVCluster -core 10.10.10.10 -username admin -password password -repository “Repository 1” -server 10.10.8.150 -serverport 443 -serverusername root clusterpassword password -virtualmachines “VM1” "VM2" -autoprotect

Start-ProtectHyperVServer

The Start-ProtectHyperVServer command adds a Hyper-V server under protection by a Core using agentless protection.

Usage

The usage for the command is as follows: 

Start-ProtectHyperVServer -core [host name] -user [user name] -password [password] -repository [name] -server [name | IP address] -serverusername [user name] -serverpassword [password] -serverport [port] -virtualmachines [virtual machines collection | all] -isagentprotection

Command Options

The following table describes the options available for the Start-ProtectHyperVServer command:

Table 178: Start-ProtectHyperVServer 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. 
-repository
 Name of a repository on the Core to which the protected machine data should be stored. The name must be enclosed in double quotes. 
-server
 Name or IP address of the Hyper-V server that you want to protect. 
-serverusername
 User name for the Hyper-V server to be protected. 
-serverpassword
 Password for the Hyper-V server to be protected. 
-serverport
 Optional. Protected Hyper-V server port number. 
-virtualmachines
 Optional. List of virtual machines to protect. Values must be enclosed in double quotes and separated by a space. If you exclude this parameter, only the Hyper-V cluster container is protected.

Example:

Protect specific virtual machines of a Hyper-V server: 

>Start-ProtectHyperVServer -core 10.10.10.10 -username admin -password password -repository “Repository 1” -server 10.10.8.150 -serverport 443 -serverusername root clusterpassword password -virtualmachines “VM1” "VM2"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating