New-VBRCloudTenantHwPlanOptions

In this article

    Short Description

    Creates VBRCloudTenantHwPlanOptions objects that contains hardware plan options.

    Applies to

    Platform: VMware, Hyper-V

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

    Requires a VCP license.

    Syntax

    New-VBRCloudTenantHwPlanOptions -HardwarePlan <VBRCloudHardwarePlan> [-EnableWanAcceleration] [-WanAccelerator <CWanAccelerator>]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates a VBRCloudTenantHwPlanOptions object that contains a hardware plan. This object is used in New-VBRCloudTenantReplicationResources to specify the hardware plan options.

    You can also enable WAN acceleration and set a target WAN accelerator. Note that the tenant who plan to use the WAN acceleration must configure a source WAN accelerator on their side.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    HardwarePlan

    Specifies the hardware plan from which you want to enable the WAN acceleration.

    Accepts VBRHvCloudHardwarePlan or VBRViCloudHardwarePlan type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    EnableWanAcceleration

    Indicates that the tenant hardware plan must use WAN acceleration.

    Use the WanAccelerator parameter to set the WAN accelerator.

    False

    Named

    False

    False

    WanAccelerator

    Specifies the WAN accelerator you want to assign to the tenant hardware plan.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRCloudTenantHwPlanOptions

    Example 1

    This example shows how to create a hardware plan options object without WAN acceleration.

    1. Run Get-VBRCloudHardwarePlan to get the hardware plan. Save it to the $HwPlan variable.
    2. Run New-VBRCloudTenantHwPlanOptions using the $HwPlan variable. Save the result to the $options variable for further use.

    $HwPlan = Get-VBRCloudHardwarePlan -Name "VMware Silver"

    $options = New-VBRCloudTenantHwPlanOptions -HardwarePlan $HwPlan

    Example 2

    This example shows how to enable WAN acceleration for a VMware hardware plan.

    1. Run Get-VBRCloudHardwarePlan to get the hardware plan. Save it to the $HwPlan variable.
    2. Run Get-VBRWANAccelerator to get the WAN accelerator. Save it to the $wan variable.
    3. Run New-VBRCloudTenantHwPlanOptions using the saved variables. Save the result to the $options variable for further use.

    $HwPlan = Get-VBRCloudHardwarePlan -Platform VMWare -Name "VMware Silver"

    $wan = Get-VBRWANAccelerator -Name "Columbus WAN"

    $options = New-VBRCloudTenantHwPlanOptions -HardwarePlan $HwPlan -EnableWanAcceleration -WanAccelerator $wan

    Example 3

    This example shows how to enable WAN acceleration for a Hyper-V hardware plan.

    1. Run Get-VBRCloudHardwarePlan to get the hardware plan. Save it to the $HwPlan variable.
    2. Run Get-VBRWANAccelerator to get the WAN accelerator. Save it to the $wan variable.
    3. Run New-VBRCloudTenantHwPlanOptions using the saved variables. Save the result to the $options variable for further use.

    $HwPlan = Get-VBRCloudHardwarePlan -Platform HyperV -Name "Hyper-V Silver"

    $wan = Get-VBRWANAccelerator -Name "Columbus WAN"

    $options = New-VBRCloudTenantHwPlanOptions -HardwarePlan $HwPlan -EnableWanAcceleration -WanAccelerator $wan

    Related Commands

    Get-VBRCloudHardwarePlan

    Get-VBRWANAccelerator

    I want to report a typo

    There is a misspelling right here:

     

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