Chat now with support
Chat with Support

Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

Rapid Recovery overview and system requirements Command Line Management Utility PowerShell Module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets
Add-CredentialsVaultAccount AddEncryptionKeytoProtectedMachine Add-EsxAutoProtectObjects Add-EsxVirtualMachines Add-HyperVClusterSharedVirtualDisks Add-HyperVClusterVirtualMachines Add-HyperVVirtualMachines Disable-HyperVAutoProtection Edit-ActiveBlockMapping Edit-AzureVirtualStandby Edit-EsxiVirtualStandby Edit-EsxServerProtectionRules Edit-ExcludedFilesAndFolders Edit-HyperVClusterProtectionRules Edit-HyperVServerProtectionRules 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-CredentialsVaultAccounts Get-ExchangeMailStores Get-Failed Get-FailedJobs Get-HyperVClusterSharedVirtualDisks Get-ListAzureVMSizes Get-Mounts Get-OracleInstanceMetadata Get-OracleInstances Get-Passed Get-ProtectedServers Get-ProtectionGroups Get-ProtectionRules Get-QueuedJobs Get-RecoveryPoints Get-ReplicatedServers Get-Repositories Get-ScheduledArchives Get-SqlDatabases Get-TransferQueueEntries Get-UnprotectedVolumes Get-Version Get-VirtualizedServers Get-Volumes Join-CredentialsVaultAccount 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 Open-DvmRepository Push-Replication Push-Rollup Remove-Agent Remove-CredentialsVaultAccount Remove-EncryptionKey Remove-EsxAutoProtectObjects Remove-EsxVirtualMachines Remove-HyperVClusterSharedVirtualDisks Remove-HyperVClusterVirtualMachines Remove-HyperVVirtualMachines Remove-Mount Remove-Mounts Remove-RecoveryPoints Remove-Replication Remove-Repository Remove-ScheduledArchive Remove-VirtualStandby Restart-CoreService Resume-Replication Resume-ScheduledArchive Resume-Scheduler Resume-Snapshot Resume-VirtualStandby Set-AgentMetadataCredentials Set-CredentialsVaultAccount Set-DedupCacheConfiguration Set-License Set-OracleMetadataCredentials Set-ReplicationResponse Start-Archive Start-AttachabilityCheck Start-AzureDeploy Start-AzureExport Start-BackupSettings Start-ChecksumCheck Start-ConfigureAgentMigration 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-RestoreSettings Start-RestoreUrc Start-ScheduledArchive Start-VBExport Start-VirtualStandby Start-VMExport Stop-ActiveJobs Stop-CoreService Suspend-Replication Suspend-ScheduledArchive Suspend-Scheduler Suspend-Snapshot Suspend-VirtualStandby Update-Repository
Localization Qualifiers
Scripting

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 69: 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 70: 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 71: 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, use “c:” “d:”.

NOTE: 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

StartExportAzure

You can use the startexportazure command to force the export of data from a protected machine to a Microsoft Azure virtual server.

Usage

The usage for the command is as follows:

/startexportazure -core [host name] -user [user name for Core] -password [password for Core] -protectedserver [name | IP address] -volumes [volume names | all] -rpn [number | numbers] -time [time string] -cloudaccountname [Azure account name] -storageaccountname[ storage account name] -containername [container name] -foldername [folder name] -deploymentname [deployment name] -destinationcontainer [Azure destination container] -subscriptionid [Azure subscription ID] -cloudservicename [cloud service name] -vmname [virtual machine name] -vmsize [virtual machine size] -endpointname [rdp | ssh] -protocol [tcp | udp] -publicremoteaccessport [public remote access port number] -privateremoteaccessport [private port number] 
	 
Command Options

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

Table 72: StartExportAzure 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
Protected machine with recovery points that you want to export.
-volumes
Optional. List of additional volume names for the deploy. If you use the value all or use no value, the all volumes deploy.
-rpn
Optional. The sequential number of a recovery point that you want to export (use the /list rps command to get the numbers). If neither -time nor -rpn is specified, then the most recent recovery point is exported.
-time
Optional. This option determines the recovery points to select for export. Specify the exact time in the format mm/dd/yyyy hh:mm tt; for example, 2/24/2012 09:00 AM. Keep in mind to specify the date time value of the time zone set on your PC. If neither -time nor -rpn is specified, then the most recent recovery point is exported.
-cloudaccountname
Optional, if the -storageaccountname is specified. Specify the Azure cloud account name.
-storageaccountname
Optional, if the -cloudaccountname is specified. Specify the Azure storage account name.
-containername
The name of the Azure container.
-foldername
Optional. The name of the Azure folder.
-deploymentname
Use this option to specify the name of the deployment. It is required for a deploy after export only.
-destinationcontainer
The name of the Azure destination container you want to use for the deploy.
-subscriptionid
The Azure subscription ID. It is required for a deploy after export only.
-cloudservicename
The name of the Azure cloud service. It is required for a deploy after export only.
-vmname
The name of the virtual machine. It is required for a deploy after export only.
-vmsize
The size of the virtual machine; for example, A0, Basic_A4, or Standard_G1.
-endpointname
The Azure endpoint protocol used only for remote access rdp or ssh. The default value is rdp. It is required for a deploy after export only.
-protocol
The protocol used only for remote access tcp or udp. It is required for a deploy after export only. The default value is tcp.
-publicremoteaccessport
The public port for using remote access. The default value is 3389.
-privateremoteaccessport
The private port for using remote access. The default value is 3389.
-privateagentport
Optional. The Agent port. If the port value is 0, then the value is determined by the Agent configuration.
Note: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added.
-publicagentport
Optional. The external Agent port. If the port value is 0, then the value is determined by the Agent configuration.
Note: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added.
-privatetransferport
Optional. The TCP port upon which to accept connections from the Core for the transfer of data from the Agent. If the port value is 0, then the value is determined by the Agent configuration.
Note: If neither the parameter -publictransferport nor -privatetransferport is specified, then no endpoint is added.
-publictransferport
Optional. The external TCP port upon which to accept connections from the Core for the transfer of data from the Agent. If the port value is 0, then the value is determined by the Agent configuration.
Note: If neither the parameter -publictransferport nor -privatetransferport is specified, then no endpoint is added.
Examples:

Export data to Azure:

>cmdutil /startexportazure -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -foldername "folder" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0

Export data to Azure using a specified endpoint:

>cmdutil /startexportazure -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -foldername "folder" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -endpointname ssh -protocol udp -publicremoteaccessport 1555 -privateremoteaccessport 22

Export data to Azure with a specified Agent endpoint when the -privateagentport option uses the special value 0, which is taken from the Agent configuration. The -publicagentport option has the user-defined value of 1888:

>cmdutil /startexportazure -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -privateagentport 0 -publicagentport 1888

Export data to Azure with specified Agent and transfer endpoints. The -privateagentport option has the user-defined value of 8006. The parameter for -publicagentport uses the special value of 0, which is copied from the -privateagentport option. The parameter for -privatetransferport uses the special value of 0, which is taken from the Agent configuration. The parameter for -publictransferport uses the special value 0, which is copied from the -privatetransferport option.:

>cmdutil /startexportazure -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -foldername "folder" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -privateagentport 8006 -publicagentport 0 -privatetransferport 0 -publictransferport 0
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating