Set-VBRWinServer

Short Description

Modifies Windows server added to the backup infrastructure.

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

Syntax

This cmdlet provides the following parameter sets:

Credentials (Default)

Set-VBRWinServer -Server <CHost> [-Description <String>] [-Credentials <CCredentials>] [<CommonParameters>]
AddCredentials

Set-VBRWinServer -Server <CHost> [-User <String>] [-Password <String>] [-Description <String>] [<CommonParameters>]
UseCertificate

Set-VBRWinServer -Server <CHost> [-Description <String>] [-UseCertificate] [<CommonParameters>]

Detailed Description

This cmdlet modifies a Windows server added to the backup infrastructure.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies credentials you want to use for authenticating with the Windows server. Accepts the `CCredentials` object. To get this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	False	Named	False
Description	Specifies a description of the Windows server.	`String`	False	Named	False
Password	Specifies the password you want to use for authenticating with the Windows server.	`String`	False	Named	False
Server	Specifies the Windows server which settings you want to modify. Accepts the `CHost` object. To create this object, run the `Get-VBRServer` cmdlet.	`CHost`	True	Named	True (ByPropertyName, ByValue)
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`	False	Named	False
User	Specifies a user name you want to use for authenticating with the Windows server.	`String`	False	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 a Windows server added to the backup infrastructure.

Examples

Set-VBRWinServer Example 1. Modifying Credentials of Windows Server

This example shows how to modify credentials of the WinServer07 Windows server.

$Administrator = Get-VBRCredentials

$server = Get-VBRServer -Name "WinServer07"

Set-VBRWinServer -Server $server -Credentials $Administrator -Description "Windows File Server 07"

Perform the following steps:

Run the Get-VBRCredentials cmdlet. Save the result to the $Administrator variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Set-VBRWinServer cmdlet. Specify the following settings:
- Set the $server variable as the Server parameter value.
- Set the $Administrator variable as the Credentials parameter value.
- Specify the Description parameter value.

Set-VBRWinServer Example 2. Modifying User Name and Password of Windows Server

This example shows how to modify user name and password of the Windows server.

$server = Get-VBRServer -Name "WinServer07"

Set-VBRWinServer -Server $server -User "Administrator02" -Password "XXXXXXXX"

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Set-VBRWinServer cmdlet. Set the $server variable as the Server parameter value. Specify the User parameter value. Specify the Password parameter value.

Set-VBRWinServer Example 3. Modifying Authentication Method of Windows Server to Certificate-Based Authentication

This example shows how to switch the authentication method of the WinServer07 Windows server to certificate-based authentication.

$server = Get-VBRServer -Name "WinServer07"

Set-VBRWinServer -Server $server -UseCertificate

Perform the following steps:

Install Veeam Deployment Kit on the Windows server you want to modify.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Set-VBRWinServer cmdlet. Set the $server variable as the Server parameter value. Provide the UseCertificate parameter.