Chat now with support
Chat mit 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

DismountArchiveRepository

After retrieving the information you want from a mounted archive, you should dismount the archive to avoid potential issues.

Usage

The usage for the command is as follows: 

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

Command Options

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

Table 18: DismountArchiveRepository 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:

Dismount the repository named "NewArchive:" 

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

DismountRemote

Use the dismountremote command to dismount a mounted recovery point mounted from a remote location.

Usage

The usage for the command is as follows: 

/dismountremote -core [host name] -user [user name] -password [password] [-all | -protectedserver [name | IP address] | -protectedserver [name | IP address] -path [location]

Command Options

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

Table 19: DismountRemote 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. 
-all
 Dismount all mounted recovery points. 
-protectedserver
 Dismount all mounted recovery points for current agent. 
-path
 Dismount selected mount point.

Example:

Dismount a remotely mounted recovery point by a specific path: 

>cmdutil /dismountremote -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver "11.11.11.11" -path "C:\ProgramData\AppRecovery\MountPoints\LMU_DESKTOP-IA8FI3J-2022-03-21T142354\F__\"

Dismount all remotely mounted recovery points for specified protected server:

>cmdutil /dismountremote -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver "11.11.11.11"

Dismount all remotely mounted recovery points for all protected servers:

>cmdutil /dismountremote -core 10.10.10.10 -user administrator -password 23WE@#$sdd -all

EditEsxServer

You can use the editesxserver command whenever you want to make changes to the number of VMware ESX(i) virtual machines that you want to protect agentlessly.

Usage

The usage for the command is as follows: 

/editEsxServer -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -add | -remove -virtualMachines [virtual machines collection | all] -autoprotect [object ID or name collection]

Command Options

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

Table 20: EditEsxServer 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. 
-protectedserver
 Use this option to edit vCenter and ESX(i) objects for a specific protected machine. 
-add
 Use this option to add a specified vCenter or ESXi object. 
-remove
 Use this option to remove a specified vCenter or ESXi object. 
-virtualmachines
 Optional. This option lets you list the virtual machines that you want to protect. 
-autoprotect
 Optional. This option lets you list the new virtual machines that you want to automatically protect.

Examples:

Automatically protect specific vCenter or ESXi objects of a vCenter or ESXi server with the Core: 

>cmdutil /editEsxServer -protectedserver 10.10.8.150 -add -autoprotect "Folder1" "Folder2"

EditHyperVCluster

You can use the edithypervcluster command whenever you want to add or remove a Hyper-V cluster or virtual machine using agentless protection.

Usage

The usage for the command is as follows: 

/edithypervcluster -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -add | -remove -virtualMachines [virtual machines collection | all] -shareddisks [name/path collection | all]

Command Options

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

Table 21: EditHyperVCluster 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.

-protectedserver
 The name of the protected cluster from which you want to add or remove virtual machines or shared virtual disks. 
-add
 Use this option to add virtual machines or shared virtual disks under protection. 
-remove
 Use this option to remove a virtual machine or shared virtual disks from protection. 
-virtualmachines
 Optional. This option lets you list the clusters or virtual machines that you want to protect. Separate the names by spaces and enclose the names of virtual machines in double quotes. 
-deleterecoverypoints
 Optional. This option can only be used with the "-remove" parameter. Use it to delete all recovery points for specified virtual machines. 
-shareddisks
 Optional. List the shared virtual disks that you want to protect or remove, separated by spaces. The name of the shared virtual disk must be enclosed double quotes.

Example:

Protect a specific Hyper-V cluster with the Core: 

>cmdutil /edithypervcluster -protectedserver 10.10.8.150 -add -shareddisks C:\SharedDisks\Folder1
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen