New-VBRSureBackupVM

Short Description

Defines VMs to add to application groups.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

VM

Specifies VMs from a job. The cmdlet will add these VMs to the application group.

Accepts the CObjectInJob object. To get this object, run the Get-VBRJobObject cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Role

Specifies a role 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

New-VBRSureBackupVMExample 1. Defining VM and VM Roles to add to Application Group

This example shows how to define the Winsrv2047 VM to add to the application group. The cmdlet will assign the mail server role to the Winsrv2047 VM.

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

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

New-VBRSureBackupVM -VM $backupobject -Role MailServer

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.

New-VBRSureBackupVMExample 2. 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:

  1. Run the New-VBRSureBackupTestScript cmdlet. Specify the PredefinedApplication parameter value.
  2. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  3. 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.
  4. Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Set the $script variable as the TestScript parameter value.

New-VBRSureBackupVMExample 3. 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-VBRApplicationGroupStartupOptions -MaximumBootTime 200 -ApplicationInitializationTimeout 150 -MemoryAllocationPercent 80

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

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