New-VBRSureBackupVM

Short Description

Defines VMs to add to the SureBackup job or to the application group.

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

Syntax

This cmdlet provides the following parameter sets:

VM (Default)

New-VBRSureBackupVM -VM <CObjectInJob> [-Role <VBRSureBackupRole[]>] [-TestScript <VBRSureBackupTestScript[]>]

[-StartupOptions <VBRSureBackupStartupOptions>] [-Credentials <CCredentials>] [-Exclude] [<CommonParameters>]

RestorePoint

New-VBRSureBackupVM [-Role <VBRSureBackupRole[]>] [-TestScript <VBRSureBackupTestScript[]>]

[-StartupOptions <VBRSureBackupStartupOptions>] [-Credentials <CCredentials>] [-Exclude] -RestorePoint <COib> [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRSureBackupVM object that defines VMs that you want to add to the SureBackup job or to the application group.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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. Accepts the `CCredentials` object. To get this object, run the Get-VBRCredentials cmdlet.	`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.	`SwitchParameter`	False	Named	False
RestorePoint	Specifies VMs added to a restore point. The cmdlet will add these VMs to the SureBackup job or to the application group. Accepts the `COib` object. To get this object, run the `Get-VBRRestorePoint` cmdlet.	`COib`	True	Named	True (ByPropertyName, ByValue)
Role	Specifies a role of VMs that you want to add to the SureBackup job or 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
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.	`VBRSureBackupStartupOptions`	False	Named	False
TestScript	Specifies a script for VMs that you want to add to the SureBackup job or 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.	`VBRSureBackupTestScript[]`	False	Named	False
VM	Specifies VMs added to a job. The cmdlet will add these VMs to the SureBackup job or to the application group. Accepts the `CObjectInJob` object. To get this object, run the `Get-VBRJobObject` cmdlet.	`CObjectInJob`	True	Named	True (ByPropertyName, ByValue)

<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

New-VBRSureBackupVM Example 1. Defining VM and VM Roles to Add to Application Group Using Job

This example shows how to define an application group settings. The cmdlet will add Winsrv2047 VM to the application group using a job and will assign the mail server role to this VM.

$job = Get-VBRJob -Name "Exchange backup"

$backupobject = Get-VBRJobObject -Job $job -Name "Winsrv2047"

New-VBRSureBackupVM -VM $backupobject -Role MailServer

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.

New-VBRSureBackupVM Example 2. Defining VM and VM Roles to Add to Application Group Using Restore Point

This example shows how to define an application group settings. The cmdlet will add Winsrv2047 VM to the application group using a restore point and will assign the mail server role to this VM.

$backup = Get-VBRBackup -Name "MSExchange"

$restPoint = Get-VBRRestorePoint -Name "Winsrv2047" -Backup $backup

New-VBRSureBackupVM -RestorePoint $restPoint -Role MailServer

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Set the $backup variable as the Backup parameter value. Save the result to the $restPoint variable.
Run the New-VBRSureBackupVM cmdlet. Set the $restPoint variable as the RestorePoint parameter value. Set the MailServer option for the Role parameter.

New-VBRSureBackupVM Example 3. Defining Verification Script for VM

This example shows how to define the Winsrv2047 VM to add to the application group. The cmdlet will define the Winsrv2047 VM with the following settings:

The Winsrv2047 VM will have the DNS Server role.
Veeam Backup & Replication will run a script to verify applications inside the Winsrv2047 VM.

$script = New-VBRSureBackupTestScript -PredefinedApplication DNSServer

$job = Get-VBRJob -Name "Exchange backup"

$backupobject = Get-VBRJobObject -Job $job -Name "Winsrv2047"

New-VBRSureBackupVM -VM $backupobject -Role DNSServer -TestScript $script

Perform the following steps:

Run the New-VBRSureBackupTestScript cmdlet. Set the DNSServer option for the PredefinedApplication parameter. Save the result to the $script variable.
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 DNSServer option for the Role parameter. Set the $script variable as the TestScript parameter value.

New-VBRSureBackupVM Example 4. Defining Startup settings of VMs

This example shows how to define the Winsrv2047 VM to add to the application group. The cmdlet will define the Winsrv2047 VM with the following settings:

The Winsrv2047 VM will have the DNS Server role.
Veeam Backup & Replication will run a script to verify applications inside the Winsrv2047 VM.
The period that is required for VMs to boot is set to 200 seconds.
The timeout required to initialize applications on VMs is set to 150 seconds.
The amount of memory provided for VMs is set to 80 percent.

$startupoptions = New-VBRSureBackupStartupOptions -MaximumBootTime 200 -ApplicationInitializationTimeout 150 -AllocatedMemory 80 -PingCheck -HeartbeatCheck

$job = Get-VBRJob -Name "Exchange backup"

$backupobject = Get-VBRJobObject -Job $job Name "Winsrv2047"

New-VBRSureBackupVM -VM $backupobject -Role DNSServer -StartupOptions $startupoptions

Perform the following steps:

Run the New-VBRSureBackupStartupOptions cmdlet. Specify the necessary parameters. Save the result to the $startupoptions variable.
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 DNSServer option for the Role parameter. Set the $startupoptions variable as the StartupOptions parameter value.

New-VBRSureBackupVM Example 5. Excluding VMs From SureBackup Job

This example shows how to exclude the Winsrv2047 VM from the SureBackup job.

$sbjob = Get-VBRSureBackupJob

$bjob = Get-VBRJob -Name "Backup"

$vm = Get-VBRJobObject -Job $bjob -Name "Winsrv2047"

$sbvm = New-VBRSureBackupVM -VM $vm -Exclude

Perform the following steps:

Run the Get-VBRSureBackupJob cmdlet. Save the result to the $sbjob variable.
Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $bjob variable.
Run the Get-VBRJobObject cmdlet. Set the $bjob variable as the Job parameter value. Specify the Name parameter value. Save the result to the $vm variable.
Run the New-VBRSureBackupVM cmdlet. Set the $vm variable as the VM parameter value. Provide the Exclude parameter.