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

Start-VBExport

The start-VBExport command initiates the launch of a virtual export from the selected recovery point to an Oracle VirtualBox server virtual machine.

Required parameters include the name of the protected machine containing recovery points to export; the name of the virtual machine you are exporting to; the amount of RAM to be allocated on the virtual machine; the host name and port of the Linux server host, and the path to the local, network, or Linux folder where the resulting virtual machine files will be stored.

Usage

The usage for the command is as follows: 

Start-VBExport -core -user [user name] -password [password] -protectedserver [machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | 
-time [time string] -vmname [virtual machine name] [-ram [total megabytes] | 
-usesourceram] -linuxhostname [linux hostname] -hostport [linux port] -targetpath [location] pathusername [user name] - pathpassword [password]

Command Options

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

Table 183: Start-VBExport 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. 
-protectedserver
 Protected machine with recovery points to be exported. 
-volumes
 Optional. List of volume names to be exported. If not specified, all volumes in the specified recovery points will be exported. Values must be enclosed in double quotes, each separated by a space. do not use trailing slashes in volume names. For example, specify “C:” not “C:/” 
-rpn
 Optional. The sequential number of a recovery point to be exported. (You can use the Get-RecoveryPoints command to obtain recovery point numbers.)
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported. 
-time
 Optional. Determines recovery point to be selected for export. You need to specify exact time in the format “MM/DD/YYYY hh:mm tt” (for example: “04/24/2015 09:00 AM”).” Specify date time values of the time zone set on your local machine.
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported. 
-vmname
 Windows name of the virtual machine. 
-ram
 Allocate specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server as the source protected machine. 
-linuxhostname
 Linux VirtualBox server hostname. 
-hostport
 Linux VirtualBox server port. 
-targetpath
 Local or network or Linux path to the folder where the virtual machine files are to be stored. 
-pathusername
 User name for network machine. Only required when you specify network path in parameter -targetpath. 
-pathpassword
 Password for network machine. Only required when you specify network path in parameter -targetpath. 
-accountusername
 Optional. Use if you can specify a user account to register the exported virtual machine. For local or network machine only. 
-accountpassword
 Optional. Use only when you specify a user account to register the exported virtual machine using parameter -accountusername. For local or network machine only.

Example:

Export all volumes from the latest recovery point on machine 10.10.12.97 to a VM called NewVirtualBoxVM: 

>Start-VBExport -protectedserver 10.10.12.97 -vmname NewVirtualBoxVM -ram usesourceram -targetpath D:/exports

Start-VirtualStandby

The Start-VirtualStandby PowerShell command lets you force a Rapid Recovery a data export to a virtual standby machine. This on-demand export can occur outside of the regularly scheduled virtual standby exports.

Usage

The usage for the command is as follows: 

Start-VirtualStandby -core [host name] -user [login] -password [password] -all | -protectedserver [name(s) | IP address]

Command Options

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

Table 184: Start-VirtualStandby 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. 

-all
 Force an export for all virtual standby machines. 
-protectedserver
 The name or names—separated by a comma and space—of the protected machines that you want to force to export.

Example:

Force a virtual standby export for a protected machine: 

>Start-VirtualStandby -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22

Start-VMExport

The Start-VMExport command initiates the launch of a virtual export from the selected recovery point to a VMware Workstaation server virtual machine.

Required parameters include the name of the protected machine containing recovery points to export; the name of the virtual machine you are exporting to; the amount of RAM to be allocated on the virtual machine; and the path to the local or network, folder where the resulting virtual machine files will be stored.

Usage

The usage for the command is as follows: 

Start-VMExport -core -user [user name] -password [password] -protectedserver [machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | 
-time [time string] -vmname [virtual machine name] [-ram [total megabytes] | 
-usesourceram] -linuxhostnme [linux hostname] -hostport [linux port] -targetpath [location] pathusername [user name] - pathpassword [password]

Command Options

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

Table 185: Start-VMExport 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. 
-protectedserver
 Protected machine with recovery points to be exported. 
-volumes
 Optional. List of volume names to be exported. If not specified, all volumes in the specified recovery points will be exported. Values must be enclosed in double quotes, each separated by a space. do not use trailing slashes in volume names. For example, specify “C:” not “C:/” 
-rpn
 Optional. The sequential number of a recovery point to be exported. (You can use the Get-RecoveryPoints command to obtain recovery point numbers.
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported. 
-time
 Optional. Determines recovery point to be selected for export. You need to specify exact time in the format “MM/DD/YYYY hh:mm tt” (for example: “04/24/2015 09:00 AM”).” Specify date time values of the time zone set on your local machine.
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported. 
-vmname
 Windows name of the virtual machine. 
-ram
 Allocate specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server as the source protected machine. 
-targetpath
 Local or network or Linux path to the folder where the virtual machine files are to be stored. 
-pathusername
 User name for network machine. Only required when you specify network path in parameter -targetpath. 
-pathpassword
 Password for network machine. Only required when you specify network path in parameter -targetpath. 
-version
 Version of VMware Tools to use. Valid versions are: 7, 8, 9, and 10.

Example:

Export all volumes from the latest recovery point on machine 10.10.12.97 to a VM called NewVMwareVM: 

>Start-VBExport -protectedserver 10.10.12.97 -vmname NewVMWareVM -ram usesourceram -targetpath D:/exports

Stop-ActiveJobs

The Stop-ActiveJobs cancels active jobs for a specified protected machine.

Usage

The usage for the command is as follows: 

Stop-ActiveJobs [-protectedserver [machine name | IP address] | -core [host name]] -user [user name] -password [password] -jobtype [jobtype]

Command Options

The following table describes the options available for the Stop-ActiveJobs command:

Table 186: Stop-ActiveJobs command options
Option Description 
-?
 Display this help message. 
-all
 Select and cancel events of the specified type for all protected machines. 
-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. 
-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. 
-protectedserver
 Determines protected machine on which jobs should be canceled. 
-jobtype
 Optional. Specifies job type filter. Available values are: ‘transfer’ (data transfer), ‘repository’ (repository maintenance), ‘replication’ (local and remote replications), ‘backup’ 9backup and restore), ‘bootcdbuilder’ (create boot CDs), ‘diagnostics’(upload logs), ‘exchange’ (Exchange Server files check), ‘export (recovery point export), ‘pushinstall’ (deploy Agent software to protected machines), ‘rollback’ (restore data from recovery point), ‘rollup’ (recovery point rollup’s), ‘sqlattach’ (agent attachability checks), ‘mount’ (not repository). By default, all jobs of the specified type are canceled.

Example:

Stop transfer job in protected machine: 

>Stop-ActiveJobs –protectedserver 10.10.1.76 -jobtype transfer

Stop all jobs for a specific protected machine: 

>Stop-ActiveJobs –protectedserver 10.10.1.76 -all
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen