Add-VBRHvHost

In this article

    Short Description

    Adds Hyper-V hosts to Veeam Backup & Replication.

    Applies to

    Platform: Hyper-V

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

    Syntax

    Add-VBRHvHost -Name <String> -User <String> -Password <String> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    -OR-

    Add-VBRHvHost -Name <String> [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet adds Hyper-V host to Veeam Backup & Repliation.

    If a Hyper-V host is part of a cluster, add the Hyper-V cluster instead of standalone Hyper-V host.

    Run Add-VBRHvCluster to add a Hyper-V cluster.

    When adding a new Hyper-V host, you will need to provide either user name and password or credentials. Use an appropriate parameter set for each case.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the DNS name of the Hyper-V host.

    True

    Named

    False

    False

    User

    Specifies the user name you want to use for authenticating with the Hyper-V host.

    True

    Named

    False

    False

    Password

    Specifies the password you want to use for authenticating with the Hyper-V host.

    True

    Named

    False

    False

    Description

    Specifies the description of the Hyper-V host.

    False

    Named

    False

    False

    Credentials

    Specifies the credentials you want to use for authenticating with the Hyper-V host.

    True

    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.

    Example 1

    This command adds a new Hyper-V host named "HyperVExchange" using user name and password. The user name is "Administrator", and the password is "Password". The description is "Hyper-V Exchange host".

    Add-VBRHvHost -Name "HyperVExchange" -User Administrator -Password Password -Description "Hyper-V Exchange host"

    Example 2

    This command adds a new Hyper-V host named "HyperVExchange" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Hyper-V Exchange host".

    Add-VBRHvHost -Name "HyperVExchange" -Credentials $Administrator -Description "Hyper-V Exchange host"

    Related Commands

    Get-VBRCredentials

    Get-VBRServer

    Remove-VBRServer

    I want to report a typo

    There is a misspelling right here:

     

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