Start-VBRVMRestoreToAmazon

In this article

    Short Description

    Starts a restore session to Amazon EC2 service.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Start-VBRVMRestoreToAmazon -RestorePoint <COib> -Region <VBRAmazonEC2Region> -LicenseType <VBRAmazonEC2LicenseType> {BYOL | ProvidedByAWS} -InstanceType <VBRAmazonEC2InstanceType> -VMName <string> -DiskConfiguration <VBRAmazonEC2DiskConfiguration[]> -VPC <VBRAmazonEC2VPC> -Subnet <VBRAmazonEC2Subnet>
    -SecurityGroup <VBRAmazonEC2SecurityGroup> [-Reason <string>] [-EnableAntivirusScan][-EnableEntireVolumeScan][-VirusDetectionAction <VBRAmazonEC2VirusDetectionAction> {ConnectToIsolatedSecurityGroup | AbortRecovery}][-VirusIsolatedSecurityGroup <VBRAmazonEC2SecurityGroup>] ProxyAppliance [VBRAmazonEC2ProxyAppliance][-RestorePointShareCreds <CCredentials>] [-Credentials <CCredentials>] [-Wait] [-AmazonEC2Tag <VBRAmazonEC2Tag[]>] [-AllocatePublicIP] [-ShutdownVM] Wait[<CommonParameters>]

    Detailed Description

    This cmdlet starts a restore session to Amazon EC2 service.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    RestorePoint

    Specifies the restore point of machines that you want to restore to Amazon EC2

    True

    Named

    False

    False

    Region

    Specifies the Amazon EC2 region. The cmdlet will restore the VM to this Amazon EC2 region.

    Accepts the VBRAmazonEC2Region type.

    True

    Named

    False

    False

    LicenseType

    Specifies the OS license. You can select the following types of licenses:

    • BYOL - set this option if you want to use your existing licenses for Microsoft software.
    • ProvidedByAWS - set this option if you want Amazon EC2 to update the license on the restored VM.

    True

    Named

    False

    False

    InstanceType

    Specifies the Amazon EC2 instance type. The cmdlet will restore the VM with the CPU and memory settings of the selected instance.

    Accepts the VBRAmazonEC2InstanceType type.

    True

    Named

    False

    False

    VMName

    Specifies the name for the target EC2 instance. Veeam Backup & Replication will restore the instance with this name.

    True

    Named

    False

    False

    DiskConfiguration

    Specifies storage volume settings for Amazon EC2 instances.

    Accepts the VBRAmazonEC2DiskConfiguration type.

    True

    Named

    False

    False

    VPC

    Specifies the Amazon VPC.

    Accepts the VBRAmazonEC2VPC type.

    True

    Named

    False

    False

    Subnet

    Specifies the Amazon VPC subnet.

    Accepts the VBRAmazonEC2Subnet type.

    True

    Named

    False

    False

    SecurityGroup

    Specifies the Amazon VPC security group.

    Accepts the VBRAmazonEC2SecurityGroup type.

    True

    Named

    False

    False

    Reason

    Specifies the restore reason.

    True

    Named

    False

    False

    EnableAntivirusScan

    Indicates that the cmdlet will perform secure restore. Veeam Backup & Replication will trigger the antivirus software to scan selected machines before the restore.

    False

    Named

    False

    False

    EnableEntireVolumeScan

    For secure restore.

    Indicates that the antivirus will continue VMs scan after the first virus threat is found. Use this option if you want to get the report on all virus threats.

    False

    Named

    False

    False

    VirusDetectionAction

    For secure restore.

    Specifies secure restore action when the virus threat is detected.

    • ConnectToIsolatedSecurityGroup - Select this action if you want to restore the machine to a different AWS security group. Use the VirusIsolatedSecurityGroup parameter to specify the security group.
    • AbortRecovery - use this option if you want to cancel the restore session.

    False

    Named

    False

    False

    VirusIsolatedSecurityGroup

    For secure restore.

    Specifies the AmazonEC2 security group. Veeam Backup & Replication will restore the infected the machine to the selected security group.

    Accepts the VBRAmazonEC2SecurityGroup type.

    False

    Named

    False

    False

    ProxyAppliance

    Specifies the AmazonEC2 proxy appliance.

    Accepts the VBRAmazonEC2ProxyAppliance type.

    False

    Named

    False

    False

    Credentials

    For restoring backups located on a network shared folder.

    Specifies the credentials to authenticate with the network shared folder.

    False

    Named

    False

    False

    Wait

    Indicates that the command waits for the process to complete before accepting more input.

    False

    Named

    False

    False

    AmazonEC2Tag

    Specifies AmazonEC2 tags. The cmdlet will restore VMs with the specified tags.

    Accepts the VBRAmazonEC2Tag[] type.

    Accepts the VBRAmazonEC2Tag[] object. To get this object, run the New-VBRAmazonEC2Tag cmdlet.

    False

    Named

    False

    False

    AllocatePublicIP

    Defines that the cmdlet will assign a public IP to the restored VM.

    If you do not provide this parameter, the restored VM will remain without the public IP.

    False

    Named

    False

    False

    ShutdownVM

    Defines that the cmdlet will power on the restored VM after the restore is complete.

    If you do not provide this parameter, the restored VM will remain powered off.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    Example

    This example shows how to restore machines to Amazon EC2.

    1. Run Get-VBRRestorePoint to get the restore point of the machine that you want to restore. Save the result to the $restorepoint variable.
    2. Run Get-VBRAmazonAccount to get Amazon EC2 credentials records. Save the result to the $account variable.
    3. Run Get-VBRAmazonEC2Region with the $account variable. Use the RegionType parameter to specify the region type. Save the result to the $region variable.
    4. Run Get-VBRAmazonEC2InstanceType with the $region variable. Save the result to the $instance variable.
    5. Run New-VBRAmazonEC2DiskConfiguration to create the storage volume for Amazon EC2 instance. Save the result to the $config variable.
    6. Run Get-VBRAmazonEC2VPC with the $region variable. Save the result to the $vpc variable.
    7. Run Get-VBRAmazonEC2SecurityGroup with the $vcp variable. Save the result to the $sgroup variable.
    8. Run Get-VBRAmazonEC2Subnet with the $vpc variable. Use the AvailabilityZone parameter to specify the Amazon VPC subnet. Save the result to the $subnet variable.
    9. Run Start-VBRVMRestoreToAmazon with the variables obtained in the previous steps.

    $account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4dbd-9895-c7485ef4bb2c"

    $region = Get-VBRAmazonEC2Region -Account $account -RegionType Global -Name "ap-northeast-1"

    $config = New-VBRAmazonEC2DiskConfiguration -DiskName "Virtual Disk" -Include -DiskType GeneralPurposeSSD

    $instance = Get-VBRAmazonEC2InstanceType -Region $region

    $vpc = Get-VBRAmazonEC2VPC -Region $region

    $sgroup = Get-VBRAmazonEC2SecurityGroup -VPC $vpc

    $subnet = Get-VBRAmazonEC2Subnet -VPC $vpc -AvailabilityZone  eu-west-1a

    Start-VBRVMRestoreToAmazon -RestorePoint $restorepoint -Region $region -LicenseType  ProvidedByAWS -InstanceType $instance -VMName "Restored VM" -DiskConfiguration $config -VPC $vpc -SecurityGroup $sgroup -Subnet $subnet -Reason "Data recovery"

    Related Commands

    Get-VBRAmazonAccount

    Get-VBRAmazonEC2Region

    New-VBRAmazonEC2DiskConfiguration

    Get-VBRAmazonEC2InstanceType

    Get-VBRAmazonEC2VPC

    Get-VBRAmazonEC2SecurityGroup

    Get-VBRAmazonEC2Subnet