Get-VBRCloudHardwarePlan

In this article

    Short Description

    Returns existing hardware plans.

    Applies to

    Platform: VMware, Hyper-V

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

    Requires a VCP license.

    Syntax

    This cmdlet provides three parameter sets.

    • For looking for all existing hardware plans:

    Get-VBRCloudHardwarePlan  [<CommonParameters>]

    • For looking for hardware plans by name or by platform:

    Get-VBRCloudHardwarePlan [-Name <string[]>] [-Platform <VBRPlatform> {VMWare | HyperV}]  [<CommonParameters>]

    • For looking for hardware plans by ID:

    Get-VBRCloudHardwarePlan -Id <guid[]>  [<CommonParameters>]

    Detailed Description

    This cmdlet returns existing hardware plans.

    You can get the list of all hardware plans or search for instances directly by name, virtuallization platform or ID.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the array of the hardware plan names you want to get.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    True

    Platform

    Specifies the platform of the hardware plan: VMware/Hyper-V.

    False

    Named

    True (ByProperty
    Name)

    False

    ID

    Specifies the array of the  IDs of the VBRViCloudHardwarePlan or VBRHvCloudHardwarePlan object you want to get.

    Accepts GUID or string type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    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

    VBRHvCloudHardwarePlan

    VBRViCloudHardwarePlan

    Example 1

    This command returns all existing hardware plans.

    Get-VBRCloudHardwarePlan

    Example 2

    This command returns all VMware hardware plans.

    Get-VBRCloudHardwarePlan -Platform VMWare

    Example 3

    This command returns all Hyper-V hardware plans.

    Get-VBRCloudHardwarePlan -Platform HyperV

    Example 4

    This command returns a hardware plan named "VMware Silver".

    Get-VBRCloudHardwarePlan -Name "VMware Silver"

    Example 5

    This command returns a Hyper-V hardware plan named "Hyper-V Silver".

    Get-VBRCloudHardwarePlan -Name "Hyper-V Silver" -Platform HyperV