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

Set-OracleMetadataCredentials

The Set-OracleMetadataCredentials command lets you set the metadata credentials for a specified Oracle instance.

Usage

The usage for the command is as follows:

Set-OracleMetadataCredentials -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 Set-OracleMetadataCredentials command:

Table 176: Set-OracleMetadataCredentialscommand 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:

>Set-OracleMetadataCredentials -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:

>Set-OracleMetadataCredentials -core 10.10.127.42 -user admin -password -676df#df -protectedserver 10.10.34.88 -instancename ORCL -connectiontype TNS -tnsnetworkalias ORCL_ALIAS -usewindowsauthentication

Set-ReplicationResponse

Use the Set-ReplicationResponse command to manage pending replication requests.

Usage

The usage for the command is as follows:

Set-ReplicationResponse -core [host name] -user [user name] -password [password] -id [replication ID] -accept | -deny | -ignore -protectedserver [name | IP address]
Command Options

The following table describes the options available for the Set-ReplicationResponse command:

Table 177: Set-ReplicationResponse 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
-id
The identifier for the replication job or pending replication request. It can be a remote Core ID, host name, customer ID, email address, or pending replication request ID.
-accept
Accepts the replication request.
-deny
Denies the replication request.
-ignore
Ignores the replication request.
-protectedserver
When responding to a replication request, use this option to apply your response to list of protected servers with a repository name or ID. Use the parameter "all" to apply response to all requested machines.
Examples:

Accept a pending replication request for one protected machines:

>Set-ReplicationResponse -id customer@email.address -accepted -protectedserver 10.10.1.1 Repository1 10.10.1.2 Repository2 -responsecomment A response comment

Deny a pending replication request:

>Set-ReplicationResponse -id customer@email.address -deny

Start-Archive

Businesses often use long-term storage to archive both compliant and non-compliant data.

The archive feature in Rapid Recovery supports the ability for an organization to extend retention of data for compliance or other reasons. You can save an archive to a local storage or network location using the Start-Archive cmdlet, which requires you to specify the archive storage location path and connection credentials.

 

oranizations the extended retention for compliant and non-compliant data. The administrator can save an archive on the local storage or network location by specifying the /Path command and credentials.

Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature in Rapid Recovery is used to support the extended retention for compliant and non-compliant data. The administrator can save an archive on the local storage or network location by specifying the /Path command and credentials.

Usage

The usage for the command is as follows:

Start-Archive -path -startdate -enddate [-all] | -protectedserver [machine name] or [IP]] -core [host name] -user [user name] -password [password]
Command Options

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

Table 178: Start-Archive command options
Option Description
-?
Display this help message.
-path
Location path. Example path: ‘D:\work\archive’ or network path: ‘\\servername\sharename’.
-all
Archive recovery points for all machines on the Core.
-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.
-startdate
Start date of the date range for the created recovery points. Should be in the format specified by the OS on the current PC.
-enddate
End date of the date range. Defaults to the current time.
-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
Archive recovery points for the specified 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.
-archiveusername
Optional. Required for network path only.
-archivepassword
Optional. Required for network path only.
-comment
Optional. Example: -comment 'Before install new application'.
Examples:

Archive all recovery points for all machines on the Core:

>Start-Archive -path D:\work\archive -startdate 'Example 04/30/2012' –all

Start-AttachabilityCheck

The Start-AttachabilityCheck cmdlet forces an attachability check for all SQL Server databases protected by the Core.

Usage

The usage for the command is as follows:

Start-AttachabilityCheck -core [host name] -user [username] - password [password] 
- protectedserver [machine name | IP address] -rpn [number | numbers] | -time [time string]
Command Options

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

Table 179: Start-AttachabilityCheck 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
The protected machine on which to perform the SQL attachability check.
-rpn
Optional. The sequential number of a recovery point on which to perform the SQL attachability check.

You can use the -GetRecoveryPoints command to obtain recovery point numbers. You can specify several space-separated numbers to perform the checks against multiple recovery points with a single command.

Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point is used for the attachability check.
-time
Optional. Determines recovery point to be selected for SQL attachability check. 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.
Examples:

Perform a SQL attachability check on the most recent recovery point for the specified protected SQL server:

>Start-AttachabilityCheck - protectedserver 10.10.9.120
Related Documents