Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

AddEncryptionKeytoProtectedMachine ApplyLicense Archive BackupSettings CancelActiveJobs CheckRepository ConfigureAgentMigration CreateArchiveRepository CreateBootCD CreateEncryptionKey CreateRepository CredentialsVaultAccount DedupCacheConfig DeleteReplication DeleteRepository DeployToAzure Dismount DismountArchiveRepository EditActiveBlockMapping EditEsxServer EditExcludedFilesandFolders EditHyperVCluster EditHyperVServer EditOracleDBVerifyNightlyJob EditOracleLogTruncationNightlyJob EnableOracleArchiveLogMode ExportRMANBackup FileSearch Force ForceAttach ForceChecksum ForceLogTruncation ForceMount ForceOptimizationJob ForceReplication ForceRollup ForceScheduledArchive ForceVirtualStandby GetOracleInstanceMetadata Help List ListAzureVMSizes ListOracleInstances Mount MountArchiveRepository NewCloudAccount OpenDvmRepository Pause Protect ProtectCluster ProtectEsxServer ProtectHyperVCluster ProtectHyperVServer RemoveAgent RemoveArchiveRepository RemoveEncryptionKey RemovePoints RemoveScheduledArchive RemoveVirtualStandby Replicate Replication RestartCoreService RestoreAgent RestoreArchive RestoreSettings RestoreUrc Resume ResumeScheduler SeedDrive SetAgentMetadataCredentials SetOracleMetadataCredentials StartExport StartExportAzure StartOracleDBVerifyJob StartOracleLogTruncationJob StopCoreService SuspendScheduler UpdateRepository Version VirtualStandby

Localization

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

Using PowerShell scripting with Rapid Recovery

Qualifiers Input Parameters for PowerShell Scripting Sample PowerShell scripts

PreTransferScript.ps1 PostTransferScript.ps1 PreExportScript.ps1 PostExportScript.ps1 PreNightlyJobScript.ps1 PostNightlyJobScript.ps1

Using Bourne shell and Bash scripting with Rapid Recovery

Input parameters for shell scripting Sample shell scripts

PreTransferScript.sh PostTransferScript.sh PreSnapshotScript.sh PostSnapshotScript.sh PostExportScript.sh

Get-Repositories

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-Repositories

The Get-Repositories command returns information about repositories on the Core.

Usage

The usage for the command is as follows:

Get-Repositories -core [host name] -user [user name] -password [password]

Command Options

The following table describes the options available for the Get-Repositories command:

Table 124: Get-Repositories 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.

Examples:

Lists repositories on the local Core:

>Get-Repositories

Get-ScheduledArchives

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-ScheduledArchives

The Get-ScheduledArchives command lets you use PowerShell to view information about the existing Rapid Recovery scheduled archives associated with this Core.

Usage

The usage for the command is as follows:

Get-ScheduledArchives -core [host name] -user [login] -password [password]

Command Options

The following table describes the options available for the Get-ScheduledArchives command:

Table 125: Get-ScheduledArchives 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.

Examples:

Get information about the scheduled archives on this Core:

>Get-ScheduledArchives -core 10.10.10.10 -user administrator -password password

Get-SqlDatabases

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-SqlDatabases

The Get-SqlDatabases command returns a list of SQL databases from the specified protected machine.

Usage

The usage for the command is as follows:

Get-SqlDatabases -core [host name] -user [user name] -password [password]  -protectedserver [server name or IP address]

Command Options

The following table describes the options available for the Get-SqlDatabases command:

Table 126: Get-SqlDatabases 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.
-protectedserver	Show jobs for a specific protected machine, indicated by IP address.

Examples:

Lists all SQL databases jobs on the local Core:

>Get-SqlDatabases -protectedserver 10.10.10.10

Get-TransferQueueEntries

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-TransferQueueEntries

The Get-TransferQueueEntries command shows a list of the transfer jobs that are still in the queue and have yet to occur.

Usage

The usage for the command is as follows:

Get-TransferQueueEntries -core [host name] -user [user name] -password [password] -protectedserver [name | IP address]

Command Options

The following table describes the options available for the Get-TransferQueueEntries command:

Table 127: Get-TransferQueueEntries 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.

Examples:

View the transfer queue entries on Core "10.10.10.10" for Agent "10.10.5.22:"

Get-TransferQueueEntries -core 10.10.10.10 -user administrator -password -23WE@#$sdd -protectedserver 10.10.5.22

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

Get-Repositories

Usage

Command Options

Examples:

Get-ScheduledArchives

Usage

Command Options

Examples:

Get-SqlDatabases

Usage

Command Options

Examples:

Get-TransferQueueEntries

Usage

Command Options

Examples: