Set-VBRSureBackupVM

Short Description

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

Applies to

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

Parameter

Description

Type

Required

Position

Accept Pipeline Input

VM

Specifies a VM whose settings you want to modify.

Accepts the VBRSureBackupVM object. To creates this object, run the New-VBRSureBackupVM cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Role

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:

  • DNSServer
  • GlobalCatalog
  • MailServer
  • SQLServer
  • WebServer
  • DomainControllerAuthoritative
  • DomainControllerNonAuthoritative
  • VBO

VBRSureBackupRole[]

False

Named

False

TestScript

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.

Accepts the VBRSureBackupTestScript[] object. To get this object, run the New-VBRSureBackupTestScript cmdlet.

False

Named

False

StartupOptions

Specifies startup settings for VMs that you want to add to the application group. Veeam Backup & Replication will apply these startup options to VMs.

Accepts the VBRSureBackupStartupOptions object. To get this object, run the New-VBRSureBackupStartupOptions cmdlet.

False

Named

False

Credentials

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.

CCredentials

False

Named

False

Exclude

Defines that the cmdlet will exclude VMs from the SureBackup job.

You can exclude VMs from the SureBackup job only if they were added through the linked backup or replication job.

SwitchParamter

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 VBRSureBackupVM object that defines VMs added to the SureBackup job or the application group.

Examples

Set-VBRSureBackupVMExample 1. Modifying Role of VM

Set-VBRSureBackupVMExample 2. Modifying Startup Settings of VMs

Related Commands

Page updated 8/14/2024

Page content applies to build 12.3.1.1139