Set-VBRWinServer

Short Description

Modifies Windows server added 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:

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

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

  • Modify an account user name and a password of a Windows server added to the backup infrastructure.

Set-VBRWinServer -Server <CHost> [-Description <String>] [-Password <String>] [-User <String>] [<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 parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Server

Specifies the Windows server which settings you want to modify.

Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet.

True

Named

True (ByPropertyName, ByValue)

User

Specifies a 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 a description of the Windows server.

String

False

Named

False

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

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

Examples

Set-VBRWinServerExample 1. Modifying Credentials of Windows Server

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

$Administrator = Get-VBRCredentials

$server = Get-VBRServer

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

Perform the following steps:

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

Set-VBRWinServerExample 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

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

Perform the following steps:

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

Related Commands