---
title: "Set-VBRHvInstantRecoveryHelperAppliance"
description: "Modifies settings for a helper appliance. Platform: Hyper-V Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet modifies settings of a helper appliance used in Instant Recovery to Microsoft Hyper-V."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrhvinstantrecoveryhelperappliance.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Data Recovery > Instant Recovery > Set-VBRHvInstantRecoveryHelperAppliance"
dateModified: "2026-08-19"
---

# Set-VBRHvInstantRecoveryHelperAppliance

## Short Description
Modifies settings for a helper appliance.

**Platform**: Hyper-V

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

## Syntax
```
Set-VBRHvInstantRecoveryHelperAppliance -HelperAppliance <VBRHvInstantRecoveryHelperAppliance>
 [-Network <VBRHvServerNetworkInfo>] [-VLanID <Int32>] [-EnableIPv4Interface] [-ObtainIPAutomatically]
 [-IpAddress <IPAddress>] [-SubnetMask <IPAddress>] [-DefaultGateway <IPAddress>] [-ObtainDNSAutomatically]
 [-PreferredDNSServer <IPAddress>] [-AlternateDNSServer <IPAddress>] [-EnableIPv6Interface]
 [-ObtainIPv6AddressAutomatically] [-IPv6Address <IPAddress>] [-IPv6PrefixLength <Int32>]
 [-IPv6DefaultGateway <IPAddress>] [-ObtainIPv6DNSAutomatically] [-IPv6PreferredDNSServer <IPAddress>]
 [-IPv6AlternateDNSServer <IPAddress>] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings of a helper appliance used in Instant Recovery to Microsoft Hyper-V.

::: 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

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AlternateDNSServer</span></p>
        </td>
        <td>
          <p>Specifies the IPv4 address of an alternate DNS server in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">DefaultGateway</span></p>
        </td>
        <td>
          <p>Specifies the IPv4 address of the default gateway in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableIPv4Interface</span></p>
        </td>
        <td>
          <p>Enables the option to use IPv4 addresses.</p><p>IPv4 is used by default.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableIPv6Interface</span></p>
        </td>
        <td>
          <p>Enables the option to use IPv6 addresses.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">HelperAppliance</span></p>
        </td>
        <td>
          <p>Specifies a helper appliance which settings you want to modify.</p><p>Accepts the <code>VBRHvInstantRecoveryHelperAppliance</code> object. To create this object, run the <a href="new-vbrhvinstantrecoveryhelperappliance.md"><code>New-VBRHvInstantRecoveryHelperAppliance</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRHvInstantRecoveryHelperAppliance</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">IpAddress</span></p>
        </td>
        <td>
          <p>For the <code>ObtainIPAutomatically</code> parameter set to <code>False</code>.</p><p>Specifies the IPv4 address of the helper appliance.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">IPv6Address</span></p>
        </td>
        <td>
          <p>For the <code>EnableIPv6Interface</code> parameter specified and the <code>ObtainIPAutomatically</code> parameter set to <code>False</code>.</p><p>If you provide this parameter Veeam Backup & Replication will use IPv6 addresses.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">IPv6AlternateDNSServer</span></p>
        </td>
        <td>
          <p>For the <code>EnableIPv6Interface</code> parameter specified and the <code>ObtainIPAutomatically</code> parameter set to <code>False</code>.</p><p>Specifies the IPv6 address of the alternate DNS server in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">IPv6DefaultGateway</span></p>
        </td>
        <td>
          <p>For the <code>EnableIPv6Interface</code> parameter specified and the <code>ObtainIPAutomatically</code> parameter set to <code>False</code>.</p><p>Specifies the IPv6 address of the default gateway in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">IPv6PreferredDNSServer</span></p>
        </td>
        <td>
          <p>For the <code>EnableIPv6Interface</code> parameter specified and the <code>ObtainIPAutomatically</code> parameter set to <code>False</code>.</p><p>Specifies the IPv6 address of the DNS server in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">IPv6PrefixLength</span></p>
        </td>
        <td>
          <p>For the <code>EnableIPv6Interface</code> parameter specified and the <code>ObtainIPAutomatically</code> parameter set to <code>False</code>.</p><p>Specifies the length of the IPv6 prefix.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Network</span></p>
        </td>
        <td>
          <p>Specifies an array of production networks to which the helper appliance must be connected.</p><p>Accepts the <code>VBRHvServerNetworkInfo[]</code> object. To get this object, run the <a href="get-vbrhvservernetworkinfo.md"><code>Get-VBRHvServerNetworkInfo</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrhvservernetworkinfo.md"><code>VBRHvServerNetworkInfo</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ObtainDNSAutomatically</span></p>
        </td>
        <td>
          <p>Use if you have a DHCP server in the network.</p><p>If you provide this parameter, Veeam Backup & Replication will obtain an IPv4 address of the DNS server automatically.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ObtainIPAutomatically</span></p>
        </td>
        <td>
          <p>Use if you have a DHCP server in the network.</p><p>If you provide this parameter, Veeam Backup & Replication will obtain an IP address of the helper appliance automatically.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ObtainIPv6AddressAutomatically</span></p>
        </td>
        <td>
          <p>Use if you have a DHCP server in the network.</p><p>If you provide this parameter, Veeam Backup & Replication will obtain an IPv6 address of the helper appliance automatically.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ObtainIPv6DNSAutomatically</span></p>
        </td>
        <td>
          <p>For the <code>EnableIPv6Interface</code> parameter specified and the <code>ObtainIPAutomatically</code> parameter set to <code>False</code>.</p><p>Use if you have a DHCP server in the network.</p><p>If you provide this parameter, Veeam Backup & Replication will obtain an IPv6 address of the DNS server automatically.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PreferredDNSServer</span></p>
        </td>
        <td>
          <p>Specifies the IPv4 address of the DNS server in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SubnetMask</span></p>
        </td>
        <td>
          <p>Specifies the subnet mask of the network where the helper appliance will be connected.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">VLanID</span></p>
        </td>
        <td>
          <p>Specifies the VLAN ID where the helper appliance must reside.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
The cmdlet returns the `VBRHvInstantRecoveryHelperAppliance` object that defines helper appliance settings.

## Examples

::: example
### Change IP address settings of a helper appliance

This example shows how to modify IP address settings for a helper appliance.

```
$network = Get-VBRHvServerNetworkInfo -Server "srv01.tech.local"
$appliance = New-VBRHvInstantRecoveryHelperAppliance -Network $network
Set-VBRHvInstantRecoveryHelperAppliance -HelperAppliance $appliance -ObtainIPAutomatically
```

Perform the following steps:

1. Run the [`Get-VBRHvServerNetworkInfo`](get-vbrhvservernetworkinfo.md) cmdlet. Specify the `Server` parameter. Save the result to the `$network` variable.
2. Run the [`New-VBRHvInstantRecoveryHelperAppliance`](new-vbrhvinstantrecoveryhelperappliance.md) cmdlet. Set the `$network` variable as the `Network` parameter value. Save the result to the `$appliance` variable.
3. Run the `Set-VBRHvInstantRecoveryHelperAppliance` cmdlet. Set the `$appliance` variable as the `HelperAppliance` parameter value. Provide the `ObtainIPAutomatically` parameter.

:::