Set-VBRApplicationGroup

Short Description

Modifies settings of application groups.

Applies to

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

Syntax

Set-VBRApplicationGroup -ApplicationGroup <VBRApplicationGroup> [-VM <VBRSureBackupVM[]>] [-Name <string>] [-Description <string>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of application groups.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
ApplicationGroup	Specifies an application group. The cmdlet will modify this application group.	Accepts the VBRApplicationGroup object. To get this object, run the Get-VBRApplicationGroup cmdlet.	True	Named	True (ByValue, ByProperty Name)
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.	False	Named	False
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 Microsoft Docs.

Output Object

The cmdlet returns the VBRApplicationGroup object that contains settings of application groups for SureBackup jobs.

Examples

Set-VBRApplicationGroup Example 1. Modifying VMs Added to Application Group

This example shows how to add new VMs to the existing application group.

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

$backupobject = Get-VBRJobObject -Job $job

$vm = New-VBRSureBackupVM -VM $backupobject

$appgroup = Get-VBRApplicationGroup

Set-VBRApplicationGroup -ApplicationGroup $appgroup -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 $backupobject variable.
Run the New-VBRSureBackupVM cmdlet. Set the $backupobject variable as the VM parameter value. Save the result to the $vm variable.
Run the Get-VBRApplicationGroup cmdlet. Save the result to the $appgroup variable.
Run the Set-VBRApplicationGroup cmdlet. Set the $appgroup variable as the ApplicationGroup parameter value. Set the $vm variable as the VM parameter value.

Set-VBRApplicationGroup Example 2. Modifying Name of Application Group

This example shows how to modify a name of the application group added to the Veeam Backup & Replication infrastructure.

$appgroup = Get-VBRApplicationGroup

Set-VBRApplicationGroup -ApplicationGroup $appgroup -Name "Additional Application Group"

Perform the following steps:

Run the Get-VBRApplicationGroup cmdlet. Save the result to the $appgroup variable.
Run the Set-VBRApplicationGroup cmdlet. Set the $appgroup variable as the ApplicationGroup parameter value. Specify the Name parameter value.

Set-VBRApplicationGroup Example 3. Modifying Description of Application Group

This example shows how to modify a description of the application group added to the Veeam Backup & Replication infrastructure.

$appgroup = Get-VBRApplicationGroup

Set-VBRApplicationGroup -ApplicationGroup $appgroup -Description "Application Group for Exchange verification"

Perform the following steps:

Run the Get-VBRApplicationGroup cmdlet. Save the result to the $appgroup variable.
Run the Set-VBRApplicationGroup cmdlet. Set the $appgroup variable as the ApplicationGroup parameter value. Specify the Description parameter value.

Related Commands