Set-VBRViApplicationGroup

Short Description

Modifies settings of application groups.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRViApplicationGroup -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

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

Examples

Set-VBRViApplicationGroupExample 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-VBRViApplicationGroup -ApplicationGroup $appgroup -VM $vm

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

Set-VBRViApplicationGroupExample 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-VBRViApplicationGroup -ApplicationGroup $appgroup -Name "Additional Application Group"

Perform the following steps:

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

Set-VBRViApplicationGroupExample 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-VBRViApplicationGroup -ApplicationGroup $appgroup -Description "Application Group for Exchange verification"

Perform the following steps:

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

Related Commands

Get-VBRApplicationGroup

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.