Add-VBRWinServer

In this article

    Short Description

    Adds 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 the account user name and password.

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

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

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

    Detailed Description

    This cmdlet adds a Windows server to the backup infrastructure.

    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

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    None.

    Examples

    Add-VBRWinServerExample 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"

    Add-VBRWinServerExample 2. Adding New Windows Server Using Credentials

    This command adds 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:

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

    Related Commands