Set-VBRHvHost

Short Description

Modifies settings of Hyper-V hosts.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Modifies account user name and password of a Hyper-V host.

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

  • Modifies credentials of Add a Hyper-V host.

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

Detailed Description

This cmdlet modifies settings of Hyper-V hosts.

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 a Hyper-V  which settings you want to modify.

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

True

Named

True (ByPropertyName, ByValue)

Description

Specifies the description of the Hyper-V host.

String

False

Named

False

Credentials

Specifies the credentials you want to use for authenticating with the Hyper-V host.

Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet

False

Named

False

User

Specifies the user name you want to use for authenticating with the Hyper-V host.

String

False

Named

False

Password

Specifies the password you want to use for authenticating with the Hyper-V host.

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 the Hyper-V hosts added to the backup infrastructure.

Set-VBRHvHostExample 1. Modifying User Name and Password of Hyper-V Host

This example shows how to modify the password of the account used to add the Hyper-V Exchange host Hyper-V сluster to the backup infrastructure.

$server = Get-VBRServer

Set-VBRHvHost Server $server" -Password "XXXXXXXXXX"

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-VBRHvHost cmdlet. Set the $server variable as the Server parameter value. Specify the Password parameter value.

Set-VBRHvHostExample 2. Modifying Credentials of Hyper-V Host

This example shows how to modify credentials of the HyperVExchange Hyper-V сluster.

$Administrator = Get-VBRCredentials

$server = Get-VBRServer

Set-VBRHvHost -Server $server -Credentials $Administrator

Perform the following steps:

  1. Run the Get-VBRCredentials cmdlet. Save the result to the $Administrator variable.
  1. Run the Get-VBRServer cmdlet. Save the result to the $server variable.
  1. Run the Set-VBRHvHost cmdlet. Set the $server variable as the Server parameter value. Set the $Administrator variable as the Credentials parameter value.

Related Commands