This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBRHvHost

In this article

Short Description

Adds a Hyper-V host to Veeam Backup & Replication.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

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>]

Related Commands

Get-VBRCredentials

Detailed Description

This cmdlet adds Hyper-V host to the Veeam Backup & Replication managing console.

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 username and password or credentials. This cmdlet provides parameter sets for both scenarios accordingly.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Name	Specifies the string with the DNS name of the added Hyper-V host.	True	Named	False	False
User	Specifies the user name you want to use for authenticating with the Hyper-V host. If you use the Username/Password scenario, the Credentials parameter must be omitted.	True	Named	False	False
Password	Specifies the password you want to use for authenticating with the Hyper-V host. If you use the Username/Password scenario, the Credentials parameter must be omitted.	True	Named	False	False
Description	Specifies the description of the Hyper-V host. If not set, Veeam Backup & Replication will enter date and time of creation by default.	False	Named	False	False
Credentials	Specifies the credentials you want to use for authenticating with the Hyper-V host. If you use the Credentials scenario, the User and Password parameters must be omitted.	True	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command adds a new Hyper-V host named "HyperVExchange" using username 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"