立即与支持人员聊天
与支持团队交流

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

SeedDrive

You can use a seed drive for the initial data transfer when you establish Rapid Recovery replication.

Usage

The usage for the command is as follows:

/seeddrive [-list | -startcopy | -startconsume | -abandon] -path [local | network path] -seeddriveusername [user name] -seeddrivepassword [password] -remotecore [name] [-targetcore [name or IP] | -protectedserver [name] | -all] -usecompatibleformat

Command Options

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

Table 65: SeedDrive 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.
-list
The list of outstanding seed drives with extended information.
-startcopy
Start copying data to the seed drive.
-startconsume
Start consuming the seed drive.
-abandon
Abandon the outstanding seed drive request.
-path
The local or network path of the seed drive.
-seeddriveusername
Optional. The user name for the network location of the seed drive.
-seeddrivepassword
Optional. The password for the network location of the seed drive.
-targetcore
Optional. Use only with the -copy option. It is the name or IP address of the remote Core. All protected machines replicating to this Core receive seed drive recovery points.
-remotecore
Use only with the -consume option. It is the name of the remote Core from which the seed drive recovery points are created or consumed.
-protectedserver
The name or IP address of the protected machine you are using to create or consume the seed drive of recovery points. For example: -protectedserver "10.10.60.48" "10.10.12.101."
-all
This option specifies whether to consume or copy all of the available protected machines.
-usecompatibleformat
The new archiving format offers improved performance, however it is not compatible with older Cores. Use this option when working with a legacy AppAssure Core.
Confirm with dev.

Examples:

List outstanding seed drives:

>cmdutil /seeddrive -list

Copy two protected machines to the seed drive on the network share:

>cmdutil /seeddrive -startcopy -remotecore TargetCoreName -path \\10.10.1.1\Share\Seed\ -seeddriveusername Administrator -seeddrivepassword 12345 -usecompatibleformat

Starting consuming the seed drive:

>cmdutil /seeddrive -startconsume -path \\10.10.1.1\Share\Seed\ -seeddriveusername Adminsitrator -seeddrivepassword 12345 -remotecore RemoteCoreName

Abandon an outstanding seed drive request:

>cmdutil /seeddrive -abandon RemoteCoreHostName

SetAgentMetadataCredentials

The setagentmetadatacredentials command sets the metadata credentials for a specified protected machine.

Usage

The usage for the command is as follows:

/setagentmetadatacredentials -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -target [default | SQL | Exchange] -metadatausername [user name] -metadatapassword [password] -sqlinstancename [SQL instance name] -usewindowsauthentication

Command Options

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

Table 66: SetAgentMetadataCredentials 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.
-protectedserver
The name or IP address of the protected machine.
-target
Optional. The type of metadata, such as SQL, Exchange, or default.
-metadatausername
Optional. The metadata-related login.
-metadatapassword
Optional. The metadata-related password.
-sqlinstancename
Optional. The specific SQL instance name. Use this option in conjunction with the -target "sql."
-usewindowsauthentication
Optional. Use this option if your SQL credentials are also used for Windows authentication.

Example:

Set credentials for Exchange metadata:

>cmdutil /setagentmetadatacredentials -core 10.10.10.10 -user administrator -password -23WE@#$sdd -protectedserver 10.10.20.20 -target exchange -metadatausername administrator -metadatapassword 123#

SetOracleMetadataCredentials

The setoraclemetadatacredentials command lets you set the metadata credentials for a specified Oracle instance.

Usage

The usage for the command is as follows:

/setoraclemetadatacredentials -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -instancename [Oracle instance SID] -connectiontype [-basic | TNS] -hostname [host name | IP address] -port [port number] [-usesid] -instanceservicename [service name] -tnsnetworkalias [TNS alias] [-usewindowsauthentication] -oracleusername [user name] -oraclepassword [password] [-edit]

Command Options

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

Table 67: SetOracleMetadataCredentials 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.
-protectedserver
The name or IP address of the protected machine.
-instancename
The Oracle SID from which you want to fetch metadata.
-connectiontype
Use this option to identify the connection type. It must be represented by either basic or TNS.
-hostname
Optional. The name of the Oracle host. Use it for the basic connection type.
-port
Optional. A port number. Use it for the basic connection type.
-usesid
Optional. This option uses the -instancename to identify the Oracle instance. Use it for the basic connection type.
-instanceservicename
Optional. The Oracle instance service name. Use it when the -usesid is not specified and for the basic connection type.
-tnsnetworkalias
Optional. Use this option to identify the TNS network alias when using the TNS connection type.
-usewindowsauthentication
Optional. This option lets you authenticate with your Windows credentials.
-oracleusername
Optional. The user name for the Oracle instance.
-oraclepassword
Optional. The password for the Oracle instance.
-edit
Optional. This option lets you omit any number of options.

Examples:

Set the metadata credentials for the ORCL instance on a protected server using the basic connection type:

>cmdutil /setoraclemetadatacredentials -core 10.10.127.42 -user admin -password -676df#df -protectedserver 10.10.34.88 -instancename ORCL -connectiontype basic -hostname localhost -port 1521 -usesid -oracleusername User-ORA -oraclepassword 676df#df

Set the metadata credentials for the ORCL instance on a protected server using the TNS connection type and Windows authentication:

>cmdutil /setoraclemetadatacredentials -core 10.10.127.42 -user admin -password -676df#df -protectedserver 10.10.34.88 -instancename ORCL -connectiontype TNS -tnsnetworkalias ORCL_ALIAS -usewindowsauthentication

StartExport

The startexport command forces a one-time export of data from a protected machine to a virtual server. You can export to an ESXi, VMware Workstation, Hyper-V, or VirtualBox virtual machine. If exporting to ESXi, you must specify thick or thin disk provisioning.

Usage

The usage for the command is as follows:

/startexport -exporttype [esxi | vm | hyperv | vb] -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -volumes [volume names] -rpn [recovery point number | numbers] | -time [time string] -vmname [virtual machine name] -hostname [virtual host name] -hostport [virtual hostport number] -hostusername [virtual host user name] -hostpassword [virtual host password] [-ram [total megabytes] | -usesourceram] -diskprovisioning [thin | thick] -diskmapping [automatic | manual | withvm] -targetpath [location] -pathusername [user name] -pathpassword [password] [-uselocalmachine]

Command Options

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

Table 68: StartExport command options
Option Description
-?
Display this help message.
-exporttype
Perform export of data from protected server to an ESXi server ('esxi'), VMware Workstation server ('vm'), Hyper-V server ('hyperv'), or VirtualBox server ('vb').
-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.
-protectedserver
Protected machine with recovery points to be exported.
-volumes	
Optional. List of volume names to be exported. If not specified, all volumes will be exported. Values must be enclosed in double quotes and separated with spaces; for example: “c:” “d:”. Do not use trailing slashes in volume names.
-rpn
Optional. The sequential number of a recovery point to be exported (use Get-RecoveryPoints command to get the numbers). If neither the ‘time’ nor the ‘rpn’ option is specified, then the most recent recovery point is exported.
-time
Optional. Determines the recovery point or points to be selected for export. You need to specify the exact time in the format "mm/dd/yyyy hh:mm tt" (for example, "2/24/2012 09:00 AM"). Be sure to specify the date time values of the time zone set on your PC. Note: if neither the 'time' nor the 'rpn' option is specified, then the most recent recovery point is exported.
-vmname
The Windows name of the virtual machine.
-hostname
For ESXi and Hyper-V virtual exports only. The virtual server host name.
-linuxhostname
For VirtualBox exports only. The virtual server host name.
-hostport
For ESXi and Hyper-V virtual exports only. The virtual server port number.
-hostusername
For ESXi and Hyper-V virtual exports only. The user name for the virtual server host.
-hostpassword
For ESXi and Hyper-V virtual exports only. The password for the virtual server host.
-ram
Use this option to allocate a specific amount of RAM on the virtual server.
-usesourceram
Optional. Use this option to allocate the same amount of RAM on the virtual server that the source machine contains.
-diskprovisioning
Use this option for ESXi exports only. Optional. The amount of disk space that you want to allocate on the virtual machine. Use one of the two following specifications:
  • Thick - This specification makes the virtual disk as large as the original drive on the protected machine.
  • Thin - This specification allocates the amount of actual disk space occupied on the original drive with a few additional megabytes.
The default specification is "thin."
-diskmapping
Use this option for ESXi exports only. Optional. This option determines how to map the disks from the protected machine to the virtual machine. Use one of the following values:
  • auto - This value automatically maps the disks.
  • manual - This value lets you map the disks manually.
  • withvm - This value stores the virtual disks in a datastore that you select.

The default value is "auto."

-targetpath
For VMware Workstation and VirtualBox exports only. This option specifies the local or network path—or Linux path, for VirtualBox only—to the folder where you want to store the virtual machine files
-pathusername
For VMware Workstation exports only. It is the user name for the network machine. It is only required when you specify a network path in the -targetpath option.
-pathpassword
For VMware Workstation exports only. It is the password for the network machine. It is only required when you specify a network path in the -targetpath option.
-uselocalmachine
For Hyper-V exports only. Optional. Use this command to connect to the local Hyper-V server. This option ignores the -hostname, -hostport, -hostusername, and -hostpassword options.

Examples:

Export data to an ESXi virtual machine with a specific name and the same amount of RAM and disk size as the source protected server:

>cmdutil	 /startexport -exporttype esxi -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -vmname Win2008-Smith -hostname 10.10.10.23 -hostport 443 -hostusername root -hostpassword 12QWsdxc@# -usesourceram -diskprovisioning thick

Create a VMware Workstation machine file on the local drive with protected data from recovery point #4:

>cmdutil /startexport -exporttype vmstation -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -rpn 4 -vmname Win2008-Smith -targetpath c:\virtualmachines -ram 4096

Create a Hyper-V machine files to be stored on a remote machine:

>cmdutil /startexport -exporttype hyperv -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -vmlocation \\WIN7-Bobby\virtualmachines -hostname 10.10.10.23 -hostport 443 -hostusername root -hostpassword 12QWsdxc@# -ram 4096
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级