Add-VBRWinServer

Short Description

Adds a Windows server to the backup infrastructure.

Applies to

Platform: VMware

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

Syntax

This cmdlet provides parameter sets that allow you to:

Add a Windows server using an account user name and a password.

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

Add a Windows server using credentials managed by Veeam Backup & Replication.

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

Add a Windows server using credentials using certificate-based authentication.

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

Detailed Description

This cmdlet adds a Windows server to the backup infrastructure.

Parameters

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

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 a Windows server added to the backup infrastructure.

Examples

Example 1. Adding New Windows Server Using User Name and Password

This command adds a new Windows server named WinServer with the Administrator user name and the qwerty password of the account. The description is Windows File Server.

Add-VBRWinServer -Name "WinServer" -User "Administrator" -Password "qwerty" -Description "Windows File Server"

Example 2. Adding New Windows Server Using Credentials

This example shows how to add a new Windows server named WinServer using credentials. The description is Windows File Server.

$Administrator = Get-VBRCredentials

Add-VBRWinServer -Name "WinServer" -Credentials $Administrator -Description "Windows File Server"

Perform the following steps:

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

Example 3. Adding New Windows Server Using Certificate-Based Authentication

This example shows how to add a new Windows server named WinServer using a certificate. The description is Windows File Server.

Add-VBRWinServer -Name "WinServer" -Description "Windows File Server" -UseCertificate

Perform the following steps:

Install Veeam Deployment Kit on the target Windows server.
Run the Add-VBRWinServer cmdlet. Specify the Name and the Description parameter values. Provide the UseCertificate parameter.

Related Commands

Get-VBRCredentials