Add-VBRViApplicationGroup

Short Description

Creates VMware application groups for SureBackup jobs.

Applies to

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

Syntax

Add-VBRViApplicationGroup -VM <VBRSureBackupVM[]> [-Name <string>] [-Description <string>] [<CommonParameters>]

Detailed Description

This cmdlet creates application groups for SureBackup jobs.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
VM	Specifies an array of VMs. The cmdlet will add these VMs to the application group.	Accepts the VBRSureBackupVM[] object. To get this object, run the New-VBRSureBackupVM cmdlet.	True	Named	True (ByValue, ByProperty Name)
Name	Specifies a name of an application group. The cmdlet will create the application group with this name.	String	False	Named	False
Description	Specifies a description of an application group. The cmdlet will create the application group with this description.	String	False	Named	False

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 VBRApplicationGroup object that contains settings of application groups for SureBackup jobs.

Examples

Add-VBRViApplicationGroup Example 1. Creating Application Group

This example shows how to create an application group with default name and description.

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

$backupobject = Get-VBRJobObject -Job $job

$vm = New-VBRSureBackupVM -VM $backupobject

Add-VBRViApplicationGroup -VM $vm

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. Save the result to the $job variable.
Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Save the result to the $vm variable.
Run the Add-VBRViApplicationGroup cmdlet. Set the $vm variable as the VM parameter value.

Add-VBRViApplicationGroup Example 2. Creating Application Group with Name

This example shows how to create an application group with the Microsoft Exchange Appgroup name.

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

$backupobject = Get-VBRJobObject -Job $job

$vm = New-VBRSureBackupVM -VM $backupobject

Add-VBRViApplicationGroup -VM $vm -Name "Microsoft Exchange Appgroup"

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. Save the result to the $job variable.
Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Save the result to the $vm variable.
Run the Add-VBRViApplicationGroup cmdlet. Set the $vm variable as the VM parameter value. Specify the Name parameter value.

Add-VBRViApplicationGroup Example 3. Creating Application Group with Name and Description

This example shows how to create an application group with the Microsoft Exchange Appgroup name and the Application group for Exchange-related VMs description.

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

$backupobject = Get-VBRJobObject -Job $job

$vm = New-VBRSureBackupVM -VM $backupobject

Add-VBRViApplicationGroup -VM <VBRSureBackupVM[]> -Name "Microsoft Exchange Appgroup" -Description "Application group for Exchange-related VMs"

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. Save the result to the $job variable.
Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Save the result to the $vm variable.
Run the Add-VBRViApplicationGroup cmdlet. Specify the following settings:

Set the $vm variable as the VM parameter value.
Specify the Name parameter value.
Specify the Description parameter value.

Related Commands