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

Set-AgentMetadataCredentials

The Set-AgentMetadataCredentials command sets the metadata credentials for a specified protected machine.

Usage

The usage for the command is as follows:

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

Table 155: Set-AgentMetadataCredentials 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:

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

Set-DedupCacheConfiguration

This command lets you used the Command Line Utility to set the location, size, and metadata location for the primary and secondary cache of a DVM repository.

Usage

The usage for the command when creating a DVM repository is as follows:

Set-DedupCacheConfiguration -core [host name] -user [user name] -password [password] -primary [cache location] -secondary [cache location] -metadata [metadata location] -size [cache size] -restoredefault

Command Options

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

Table 156: Set-DedupCacheConfiguration command options
Option Description
-?
Display help on the command.
-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.
-primary
Optional. Primary cache location.
-secondary
Optional. Secondary cache location.
-metadata
Optional. Metadata cache location.
-size
Optional. Deduplication cache size in GB.
-restoredefault
Optional. Restore to default deduplication cache configuration. If this parameter is specified, all other parameters are ignored.

Examples:

Set primary deduplication cache location and deduplication cache size:

>Set-DedupCacheConfiguration -primary D:\primary -size 6

Set secondary and metadata deduplication location:

>Set-DedupCacheConfiguration -secondary D:\secondary -metadata D:\metadata

Restore default deduplication configuration:

>Set-DedupCacheConfiguration -restoredefault

Set-License

There may be times when you need to change the Rapid Recovery license applied to a machine, such as when moving from a trial license to a subscription or perpetual license. In such instances, you can change the license in the Command Prompt by using the Set-License command.

Usage

The usage for the command is as follows:

Set-License -core [host name] -user [user name] -password [password] -licensekey [license key] -licensepath [license file path] -licensenumber [license number] -email [email address]

Command Options

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

Table 157: Set-License 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.
-licensekey
Optional. A 30-character key comprising six groups of five alphanumeric characters, each separate by a hyphen. Use this key when a license file is not available.
-licensepath
Optional. The path to the file that ends with the .lic extension. If a license file is available, you can use this option instead of the -licensekey.
-licensenumber
Optional. You may have received this nine-digit license number in an order confirmation email. If you provide this number, use the email address that received it for verification.
-email
Optional. If you use the -licensenumber, you must include the email address that received it for verification.

Examples:

Change the license key associated with this Core to JL09F-89FSD-6THFS-DSE34-KS3D5-65DF2:

>Set-License -core 10.10.10.10 -user admin -password 676df#df -licensekey JL09F-89FSD-6THFS-DSE34-KS3D5-65DF2

Change the license key associated with this Core to the key contained in the license file:

>Set-License -core 10.10.10.10 -user admin -password 676df#df -licensepath C:\MyLicenseFile.lic

Change the license number associated with this Core to 111-111-111 using john.doe@example.com to verify the license:

>Set-License -core 10.10.10.10 -user admin -password 676df#df -licensenumber 111-111-111 -email john.doe@example.com

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 158: 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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating