Add-VBRHvHost

Short Description

Adds Hyper-V hosts to the backup infrastructure.

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

Syntax

This cmdlet provides the following parameter sets:

AddCredentials

Add-VBRHvHost -Name <String> -User <String> -Password <String> [-Description <String>] [<CommonParameters>]
Credentials

Add-VBRHvHost -Name <String> [-Description <String>] -Credentials <CCredentials> [<CommonParameters>]
UseCertificate

Add-VBRHvHost -Name <String> [-Description <String>] [-UseCertificate] [<CommonParameters>]

Detailed Description

This cmdlet adds a Hyper-V host to the backup infrastructure.

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

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the credentials you want to use for authenticating with the Hyper-V host. Accepts the `CCredentials` object. To get this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	True	Named	False
Description	Specifies the description of the Hyper-V host.	`String`	False	Named	False
Name	Specifies the DNS name of the Hyper-V host.	`String`	True	Named	False
Password	Specifies the password you want to use for authenticating with the Hyper-V host.	`String`	True	Named	False
UseCertificate	Defines that the cmdlet will use certificate-based authentication to authenticate with the Hyper-V host. This authentication method requires Veeam Deployment Kit pre-installed on the target Hyper-V host.	`SwitchParameter`	True	Named	False
User	Specifies the user name you want to use for authenticating with the Hyper-V host.	`String`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the CHost object that contains settings of the Hyper-V hosts added to the backup infrastructure.

Examples

Add-VBRHvHost Example 1. Adding New Hyper-V Host Using User Name and Password

This command adds a new Hyper-V host named HyperVExchange with the Administrator user name and the qwerty password of the account. The description is Hyper-V Exchange host.

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

Add-VBRHvHost Example 2. Adding New Hyper-V Host Using Credentials

This example shows how to add a new Hyper-V host named HyperVExchange using credentials. The description is Hyper-V Exchange host.

$Administrator = Get-VBRCredentials

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

Perform the following steps:

Run the Get-VBRCredentials cmdlet. Save the result to the $Administrator variable.
Run the Add-VBRHvHost cmdlet. Specify the Name parameter value. Set the $Administrator variable as the Credentials parameter value. Specify the Description parameter value.

Add-VBRHvHost Example 3. Adding New Hyper-V Host Using Certificate-Based Authentication

This example shows how to add a new Hyper-V host named HyperVExchange using a certificate. The description is Hyper-V Exchange host.

Add-VBRHvHost -Name "HyperVExchange" -Description "Hyper-V Exchange host" -UseCertificate

Perform the following steps:

Install Veeam Deployment Kit on the target Hyper-V host.
Run the Add-VBRHvHost cmdlet. Specify the Name and the Description parameter values. Provide the UseCertificate parameter.

Get-VBRCredentials