Set-VBRSureBackupVM

Short Description

Modifies settings of VMs to add to application groups.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRSureBackupVM -VM <VBRSureBackupVM> [-Role <VBRSureBackupRole[]> {DNSServer | GlobalCatalog | MailServer | SQLServer | WebServer | DomainControllerAuthoritative | DomainControllerNonAuthoritative | VBO}] [-TestScript <VBRSureBackupTestScript[]>] [-StartupOptions <VBRSureBackupStartupOptions>] [-Credentials <CCredentials>][<CommonParameters>]

Detailed Description

This cmdlet modifies settings of VMs to add to application groups.

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

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBRSureBackupVM object that defines VMs that you want to add to the application group.

Examples

Set-VBRSureBackupVMExample 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 cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Get-VBRJobObject cmdlet. Set the $job variable as the Job parameter value. Specify the Name parameter value. Save the result to the $job variable.
  3. Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Set the MailServer option as the Role parameter value.
  4. Run the Set-VBRSureBackupVM cmdlet. Set the $vm variable as the VM parameter value. Set the GlobalCatalog option as the Role parameter value.

Set-VBRSureBackupVMExample 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 -MemoryAllocationPercent 60

Set-VBRSureBackupVM -VM $vm -StartupOptions $startupoptions

Perform the following steps:

  1. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Get-VBRJobObject cmdlet. Set the $job variable as the Job parameter value. Specify the Name parameter value. Save the result to the $job variable.
  3. Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Set the MailServer option as the Role parameter value.
  4. Run the New-VBRApplicationGroupStartupOptions cmdlet. 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

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.