Add-VBRWinServer

In this article

    Short Description

    Adds Windows server to Veeam Backup & Replication.

    Applies to

    Platform: VMware

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

    Syntax

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

    -OR-

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

    Detailed Description

    This cmdlet adds a Windows server to the Veeam Backup & Replication managing console.

    When adding a new Windows server, you will need to provide either user name and password or credentials. This cmdlet provides syntax for both scenarios accordingly.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the DNS name of the Windows server.

    True

    Named

    False

    False

    User

    Specifies the user name you want to use for authenticating with the Windows server.

    True

    Named

    False

    False

    Password

    Specifies the password you want to use for authenticating with the Windows server.

    True

    Named

    False

    False

    Description

    Specifies the description of the Windows server.

    False

    Named

    False

    False

    Credentials

    Specifies the credentials you want to use for authenticating with the Windows server.

    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 Windows server named "WinServer" using user name and password. The user name is "Administrator", and the password is "Password". The description is "Windows File Server".

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

    Example 2

    This command adds a new Windows server named "WinServer" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Windows File Server".

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

    Related Commands

    Get-VBRCredentials

    Get-VBRServer

    Remove-VBRServer