Get-VBRCloudServer

In this article

    Short Description

    Returns cloud hosts available by your cloud resources.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides three parameter sets.

    • For looking for hosts by host name:

    Get-VBRCloudServer [-Name <string[]>]  [<CommonParameters>]

    • For looking for hosts of a selected cloud service provider:

    Get-VBRCloudServer [-CloudProvider <VBRCloudProvider[]>] [-Name <string[]>]  [<CommonParameters>]

    • For looking for hosts by host ID:

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

    Detailed Description

    This cmdlet returns cloud hosts that are allocated to you by your cloud resources.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the array of the host names you want to get.

    False

    Named

    False

    False

    CloudProvider

    Specifies the array of the  cloud providers. The cmdlet will return the hosts that are provided to you by these providers.

    Accepts VBRCloudProvider type.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Id

    Specifies the array of the IDs of the host you want to get. The cmdlet will return the hosts with these IDs.

    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

    VBRCloudServer

    Example 1

    This command returns cloud server named "Hyper-V Silver".

    Get-VBRCloudServer -Name "Hyper-V Silver"

    Example 2

    This example shows how to return cloud servers of the server provider with the 104.45.95.227 IP address.

    1. Run Get-VBRCloudProvider to get the cloud provider and save the result to the $cloudProvider variable.
    2. Run Get-VBRCloudServer using the saves variable.

    $cloudProvider = Get-VBRCloudProvider -Name "104.45.95.227"

    Get-VBRCloudServer -CloudProvider $cloudProvider

    Related Commands

    Get-VBRCloudProvider