Get-VBRServer

In this article

    Short Description

    Returns hosts connected to the backup infrastructure.

    Applies to

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

    Syntax

    Get-VBRServer [-Type <CDBHost+EType>] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns hosts connected to the backup infrastructure. You can get the following servers:

    • BackupServer
    • VC
    • ESXi
    • VcdSystem
    • Scvmm
    • HvServer
    • HvCluster
    • SmbCluster
    • SmbServer
    • Windows
    • Linux
    • Cloud
    • Local
    • SanHost

    You can get the list of all hosts or narrow down the output to servers of specific type, or search for instances directly by name.

    To get VMware objects run the Find-VBRViEntity cmdlet.

    To get Hyper-V objects run the Find-VBRHvEntity cmdlet.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Type

    Specifies the host type. The cmdlet will return hosts of this type.

    String

    False

    Named

    False

    Name

    Specifies the array of host names. The cmdlet will return hosts with these names.

    String

    False

    Named

    False

    <CommonParameters>

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

    Output Object

    The cmdlet returns the CHost object that contains settings of hosts connected to Veeam Backup & Replication.

    Examples

    Get-VBRServerExample 1. Looking for Server by Name

    This command looks for the server named Active_Directory.

    Get-VBRServer -Name "Active_Directory"

    Get-VBRServerExample 2. Looking for VM Registered on Hyper-V Server

    This command looks for the VM named Hv_DNS registered on a Hyper-V server.

    Get-VBRServer -Type "HvServer" -Name "Hv_DNS"