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. Note: This parameter is available starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131).	SwitchParamter	False	Named	False

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

Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Get-VBRJobObject cmdlet. Set the $job variable as the Job parameter value. Specify the Name parameter value. Save the result to the $backupobject variable.
Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Set the MailServer option for the Role parameter.
Run the Set-VBRSureBackupVM cmdlet. Set the $vm variable as the VM parameter value. Set the GlobalCatalog option for the Role parameter.

Set-VBRSureBackupVM 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-VBRSureBackupStartupOptions -MaximumBootTime 100 -ApplicationInitializationTimeout 150 -AllocatedMemory 60

Set-VBRSureBackupVM -VM $vm -StartupOptions $startupoptions

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Get-VBRJobObject cmdlet. Set the $job variable as the Job parameter value. Specify the Name parameter value. Save the result to the $backupobject variable.
Run the New-VBRSureBackupVM 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.
Run the New-VBRApplicationGroupStartupOptions cmdlet. Specify the MaximumBootTime, ApplicationInitializationTimeout and AllocatedMemory parameter values. Save the result to the $startupoptions variable.
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