Chatta subito con l'assistenza
Chat con il supporto

Rapid Recovery 6.9 - 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

New-BootCD

This command lets you create a bare metal restore (BMR) boot CD without using the Rapid Recovery Core Console.

Usage

The usage for the command is as follows: 

New-BootCD -core [host name] -user [user name] -password [password] -ip [IP address] -mask [mask] -defaultgateway [defaultgateway] -dnsserver [dnsserver] -vncpassword [vncpassword] -vncport [vncport] -isofilepath [destination for the boot image] -driverspath [drivers path]

Command Options

The following table describes the options available for the New-BootCD command:

Table 123: New-BootCD 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. 
-ip
 Optional. This option specifies the IP address of the target BMR machine. By default, it generates automatically. 
-mask
 Optional. This option specifies the subnet mask of the target BMR machine. By default, it generates automatically. 
-defaultgateway
 Optional. This option specifies the default gateway of the target BMR machine. By default, it generates automatically. 
-dnsserver
 Optional. This option specifies the DNS server for the target BMR machine. By default, it generates automatically. 
-vncpassword
 Optional. This option specifies the user password for an existing UltraVNC account. By default, this option is empty. 
-vncport
 Optional. This option specifies the port to use for UltraVNC. You can change it only if you used the -vncpassword option. By default, the port is 5900. 
-isofilepath
 Optional. This option specifies the patch to the boot CD file. The default path is C:\ProgramData\AppRecovery\Boot CDs. 
-driverspath
 Optional. This option specifies the path to the archive of drivers.

Example:

Create a boot CD: 

>New-BootCD -ip 192.168.20.188 -mask 255.255.255.0 -defaultgateway 192.168.20.2 -dnsserver 192.168.20.2 -isofilepath D:\bcd\newbcd3.iso

New-CloudAccount

The New-CloudAccount command lets you add a new cloud account to the Rapid Recovery Core.

Usage

The usage for the command is as follows: 

New-CloudAccount -core [host name] -user [login] -password [password] -displayname [display name] -type [cloud acco
    unt type] -username [user name] - key [secret key] -region [region] - tenantid [tenant Id] -authurl [authorization
    url]

Command Options

The following table describes the options available for the New-CloudAccount command:

Table 124: New-CloudAccount 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. 

-displayname
 The name of the cloud account to display. 
-type

The type of cloud account you want to add. Supported values include:

  • amazon
  • openstack
  • rackspace
  • windowsazure
  • "windows azure"
  • azure 

-username

The user name for the cloud account that you want to add. It is used in the authentication process. This property resolves as "Access Key" for Amazon™ cloud, "User Name" for Rackspace and OpenStack, and "Storage Account Name" for Windows Azure cloud accounts. 

-key

The key for the cloud account you want to add. It is used in the authentication process. This property resolves as "Secret Key" for Amazon™ cloud, "Api Key" for Rackspace and OpenStack, and "Access Key" for a Windows Azure cloud accounts. 

-region

The region of the cloud account that you want to add. This property is required only for RackSpace and OpenStack cloud accounts. 

-tenantid

The identifier that is used in the authentication process of an OpenStack cloud account. This option is required only for OpenStack cloud accounts. 

-authurl

The URL that is used in the authentication process of an OpenStack cloud account. This option is required only for OpenStack cloud accounts.

Example:

Create a new Amazon™ S3 cloud account named "Amazon S3 Account" with the access key "akey" and the secret key "skey." 

>New-CloudAccount -displayname "Amazon S3 Account" -type Amazon -username akey -key skey

New-EncryptionKey

The New-EncryptionKey command lets you create a new encryption key for securing your Rapid Recovery backed up data.

Usage

The usage for the command is as follows: 

New-EncryptionKey -core [host name] -user [login] -password [password] -name [encryption key name] -passphrase [pas
    sphrase] -comment [comment]

Command Options

The following table describes the options available for the New-EncryptionKey command:

Table 125: New-EncryptionKey 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. 

-name
 The name of the encryption key that you want to create. 
-passphrase
 The passphrase to the encryption key that you want to create. 
-comment
 Optional. The description of the encryption key.

Example:

Create an encryption key on the local Core: 

>New-EncryptionKey –name EncryptionKey1 -passphrase 123456

New-EsxiVirtualStandby

The New-EsxiVirtualStandby PowerShell command lets you create a new ESXi virtual standby machine using Rapid Recovery.

Usage

The usage for the command is as follows: 

New-EsxiVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address] -volumes [volumes names] -vmname [virtual machine name] -hostname [virtual host name] -hostport [virtual host port number] -hostusername [virtual host login] -hostpassword [virtual host password] [-ram [total megabytes] | -usesourceram] -diskprovisioning [thin | thick] -diskmapping [automatic | manual | withvm] -initialexport

Command Options

The following table describes the options available for the New-EsxiVirtualStandby command:

Table 126: New-EsxiVirtualStandby 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. 
-volumes
 Optional. List the volume names you want to export. If not specified, all volumes in the recovery point(s) are exported. Values must be enclosed in double quotes and separated by space; for example, "c:", "d:".
Note: Do not use trailing slashes in volume names. 
-vmname
 The Microsoft Windows name of the virtual machine. 
-hostname
 The name of the virtual server host. 
-hostport
 The port number to use for communicating with the virtual server. 
-hostusername
 The user name for logging in to the virtual server host. 
-hostpassword
 The password for logging in to the virtual server host. 
-ram
 Allocate a specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server that the source protected machine has. 
-diskprovisioning
 Optional. The amount of disk space to allocate on the virtual machine. Available values include:
  • Thick - Specify 'thick' to make the virtual disk as large as the original drive on the protected server.
  • Thin - Specify 'thin' to allocate the amount of actual disk space occupied on the original drive plus some additional megabytes.
The default disk provisioning is 'thin'. 
-diskmappinjg
 Optional. It determines how to map the disks from the recovery point to the virtual machine. Available values include:
  • 'auto'
  • 'manual'
  • 'withvm'
The default setting is 'auto'. 
-initialexport
 Optional. Specify this option if you need to start an initial on-demand virtual machine export after configuring the virtual standby.

Example:

Create a new ESXi virtual standby: 

>New-EsxiVirtualStandby -protectedserver 10.10.10.4 -vmname ExportedMachine -hostname 10.10.10.127 -hostport 443 -hostusername root -hostpassword pass123 -usesourceram -diskprovisioning thin -diskmapping auto
Related Documents

The document was helpful.

Seleziona valutazione

I easily found the information I needed.

Seleziona valutazione