Deploy-VBRAzureLinuxRestoreAppliance

In this article

    Short Description

    Deploys or removes helper appliances for restoring Linux VMs to Microsoft Azure.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides 2 parameter sets.

    • For removing Linux VM restore helper appliances:

    Deploy-VBRAzureLinuxRestoreAppliance -Account <VBRAzureAccount> -RemoveAll [-Wait]  [<CommonParameters>]

    • For deploying Linux VM restore helper appliances:

    Deploy-VBRAzureLinuxRestoreAppliance -Account <VBRAzureAccount> -Appliance <VBRAzureLinuxRestoreAppliance[]> [-Wait]  [<CommonParameters>]

    Detailed Description

    This cmdlet deploys or removes helper appliances for restoring Linux VMs to Microsoft Azure. The cmdlet offers the following possibilities:

    • To remove all helper appliances associated with an account, run the 1st parameter set.
    • To remove selected helper appliances, run the 2nd parameter set and enumerate only those helper appliances that must remain.
    • To deploy a new helper appliance or a number of new helper appliances, run the 2nd parameter set and pass an array of helper appliances you want to deploy. Note that if there are any existing helper appliances already deployed for this account that you want to keep, you must include them in the array.
    • To modify settings of an existing helper appliance or helper appliances, run the 2nd parameter set and pass an array of existing helper appliances with different settings.

    Run Get-VBRAzureApplicanceSession to get the status of sessions initiated by this cmdlet.

    Important

    Mind the following:

    • This cmdlet does not support Microsoft Azure accounts with the Azure Service Manager type of a subscription (ASM, also known as a "classic" type subscription).
    • This cmdlet always deploys the helper appliances anew. The array of helper appliances that you pass to this cmdlet must contain all helper appliances that you want to be associated with the account.
    • If there are existing helper appliances associated with this account, but which you do not include in the array you pass, the cmdlet will remove them.
    • If there are existing helper appliances associated with this account, and you pass them with different settings, the cmdlet will re-deploy them with the new settings.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Account

    Specifies the account.

    For removing helper appliances: the cmdlet will remove all helper appliances connected to this account.

    For deploying helper appliances: the cmdlet will deploy helper appliances for this account.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    RemoveAll

    Indicates that the cmdlet removes all helper appliances associated with the account.

    True

    Named

    False

    False

    Appliance

    Specifies the array of helper appliances you want to deploy.

    True

    Names

    True (ByProperty
    Name)

    False

    Wait

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

    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

    VBRAzureApplianceSession

    Example 1

    This example shows how to remove all Linux VM restore helper appliances associated with a Microsoft Azure account:

    1. Get the Microsoft Azure account: run Get-VBRAzureAccount and save the result to the $account variable.
    2. Run Deploy-VBRAzureLinuxRestoreAppliance with the $account variable. Use the RemoveAll switch parameter. Save the deployment session to the $appliancesession variable to check its status.

    $account = Get-VBRAzureAccount -Type ResourceManager -Name "RestoreToAzureRM@Veeam.com"

    $appliancesession = Deploy-VBRAzureLinuxRestoreAppliance -Account $account -RemoveAll:$true

    Example 2

    This example shows how to deploy an additional Linux VM restore helper appliance for a Microsoft Azure account:

    1. Get the Microsoft Azure account: run Get-VBRAzureAccount and save the result to the $account variable.
    2. Get the array of all Linux helper appliances. Run Get-VBRAzureLinuxRestoreAppliance and save the array to the $appliances variable.
    3. From the $appliances array, get the Linux helper appliance that is currently used. Save it to the $currentappliance variable.
    4. From the $appliances array, get the new Linux helper appliance. Save it to the $newappliance variable.
    5. Run Deploy-VBRAzureLinuxRestoreAppliance with the saved variables. Be careful to use both helper appliances variables. Save the deployment session to the $appliancesession variable to check its status.

    $account = Get-VBRAzureAccount -Type ResourceManager -Name "RestoreToAzureRM@Veeam.com"

    $appliances = Get-VBRAzureLinuxRestoreAppliance

    $currentappliance = $appliances[0]

    $newappliance = $appliances[1]

    $appliancesession = Deploy-VBRAzureLinuxRestoreAppliance -Account $account -Appliance $currentappliance, $newappliance

    Related Commands

    Get-VBRAzureAccount

    Get-VBRAzureLinuxRestoreAppliance

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.