---
title: "Set-VBRSureBackupVM"
description: "This cmdlet modifies settings of VMs added to the SureBackup job or to the application group. To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrsurebackupvm.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > SureBackup > SureBackup Application Groups > Set-VBRSureBackupVM"
dateModified: "2026-08-19"
---

# Set-VBRSureBackupVM

## Short Description
Modifies settings of VMs added to the SureBackup job or to the application group.

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

## Syntax
```
Set-VBRSureBackupVM -VM <VBRSureBackupVM> [-Role <VBRSureBackupRole[]>]
 [-TestScript <VBRSureBackupTestScript[]>] [-StartupOptions <VBRSureBackupStartupOptions>]
 [-Credentials <CCredentials>] [-Exclude] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies settings of VMs added to the SureBackup job or to the application group.

::: 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">Credentials</span></p>
        </td>
        <td>
          <p>Specifies credentials to access VMs and run verification scripts. If you do not specify this parameter, the cmdlet will use the account under which Veeam Backup & Replication is currently running.</p>
        </td>
        <td style="width:10%;">
          <p><code>CCredentials</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">Exclude</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will exclude VMs from the SureBackup job.</p><p>You can exclude VMs from the SureBackup job only if they were added through the linked backup or replication job.</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">Role</span></p>
        </td>
        <td>
          <p>Specifies roles of VMs that you want to add to the application group. The cmdlet will assign the specified role to VMs. You can specify either of the following roles:</p><ul><li><code>DNSServer</code></li><li><code>GlobalCatalog</code></li><li><code>MailServer</code></li><li><code>SQLServer</code></li><li><code>WebServer</code></li><li><code>DomainControllerAuthoritative</code></li><li><code>DomainControllerNonAuthoritative</code></li><li><code>VBO</code></li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRSureBackupRole[]</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">StartupOptions</span></p>
        </td>
        <td>
          <p>Specifies startup settings for VMs that you want to add to the application group. Veeam Backup & Replication will apply these startup options to VMs.</p><p>Accepts the <code>VBRSureBackupStartupOptions</code> object. To get this object, run the <a href="new-vbrsurebackupstartupoptions.md"><code>New-VBRSureBackupStartupOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRSureBackupStartupOptions</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">TestScript</span></p>
        </td>
        <td>
          <p>Specifies a script for VMs that you want to add to the application group. Veeam Backup & Replication will run this script to verify the role of VMs.</p><p>Accepts the <code>VBRSureBackupTestScript[]</code> object. To get this object, run the <a href="new-vbrsurebackuptestscript.md"><code>New-VBRSureBackupTestScript</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRSureBackupTestScript[]</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">VM</span></p>
        </td>
        <td>
          <p>Specifies a VM whose settings you want to modify.</p><p>Accepts the <code>VBRSureBackupVM</code> object. To creates this object, run the <a href="new-vbrsurebackupvm.md"><code>New-VBRSureBackupVM</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRSureBackupVM</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>
    </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 `VBRSureBackupVM` object that defines VMs added to the SureBackup job or the application group.

## Examples

::: example
### Example 1. Modifying Role of VM

This example shows how to modify a role of the VM that you want to add to the application group. The cmdlet will change the role of the VM from the Mail Server role to the Global Catalog role.

```
$job = Get-VBRJob -Name "Exchange backup"
$backupobject = Get-VBRJobObject -Job $job -Name "Winsrv2047"
$vm = New-VBRSureBackupVM -VM $backupobject -Role MailServer
Set-VBRSureBackupVM -VM $vm -Role GlobalCatalog
```

Perform the following steps:

1. Run the [`Get-VBRJob`](get-vbrjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$job` variable.
2. Run the [`Get-VBRJobObject`](get-vbrjobobject.md) cmdlet. Set the `$job` variable as the `Job` parameter value. Specify the `Name` parameter value. Save the result to the `$backupobject` variable.
3. Run the [`New-VBRSureBackupVM`](new-vbrsurebackupvm.md) cmdlet. Set the `$backupobject` variable as the `VM` parameter value. Set the `MailServer` option for the `Role` parameter.
4. Run the `Set-VBRSureBackupVM` cmdlet. Set the `$vm` variable as the `VM` parameter value. Set the `GlobalCatalog` option for the `Role` parameter.

:::

::: example
### Example 2. Modifying Startup Settings of VMs

This example shows how to modify startup settings of the VM that you want to add to the application group. The VM will have the following startup settings:

- The period that is required for VMs to boot is set to 100 seconds.
- The timeout required to initialize applications on VMs is set to 150 seconds.
- The amount of memory provided for VMs is set to 60 percent.

```
$job = Get-VBRJob -Name "Exchange backup"
$backupobject = Get-VBRJobObject -Job $job -Name "Winsrv2047"
$vm = New-VBRSureBackupVM -VM $backupobject -Role MailServer
$startupoptions = New-VBRApplicationGroupStartupOptions -MaximumBootTime 100 -ApplicationInitializationTimeout 150 -AllocatedMemory 60
Set-VBRSureBackupVM -VM $vm -StartupOptions $startupoptions
```

Perform the following steps:

1. Run the [`Get-VBRJob`](get-vbrjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$job` variable.
2. Run the [`Get-VBRJobObject`](get-vbrjobobject.md) cmdlet. Set the `$job` variable as the `Job` parameter value. Specify the `Name` parameter value. Save the result to the `$backupobject` variable.
3. Run the [`New-VBRSureBackupVM`](new-vbrsurebackupvm.md) cmdlet. Set the `$backupobject` variable as the `VM` parameter value. Set the `MailServer` option for the `Role` parameter. Save the result to the `$vm` variable.
4. Run the [`New-VBRApplicationGroupStartupOptions`](new-vbrapplicationgroupstartupoptions_surebackup.md) cmdlet. Specify the `MaximumBootTime`, `ApplicationInitializationTimeout` and `AllocatedMemory` parameter values. Save the result to the `$startupoptions` variable.
5. Run the `Set-VBRSureBackupVM` cmdlet. Set the `$vm` variable as the `VM` parameter value. Set the `$startupoptions` variable as the `StartupOptions` parameter value.

:::

## Related Commands

- [`Get-VBRJob`](get-vbrjob.md)
- [`Get-VBRJobObject`](get-vbrjobobject.md)
- [`New-VBRSureBackupVM`](new-vbrsurebackupvm.md)
- [`New-VBRApplicationGroupStartupOptions`](new-vbrapplicationgroupstartupoptions_surebackup.md)