Set-VBRProtectionGroup

Short Description

Modifies protection groups.

Applies to

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

Syntax

Set-VBRProtectionGroup -ProtectionGroup <VBRProtectionGroup> [-Name <string>] [-Description <string>] [-Container <VBRProtectionGroupContainer>] [-ScheduleOptions <VBRProtectionGroupScheduleOptions>] [-DeploymentOptions <VBRProtectionGroupDeploymentOptions>] [-AdvancedOptions <VBRProtectionGroupAdvancedWindowsOptions>] [-NotificationOptions <VBRProtectionGroupNotificationOptions>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a protection group.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

ProtectionGroup

Specifies the protection group you want to modify.

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

True

Named

True (ByValue,
ByProperty
Name)

Container

Specifies the protection scope. The protection scope can contain Active Directory objects, individual computers or computers imported from a CSV file. The cmdlet will create the protection group with this protection scope.

Accepts the following objects:

To get this object, run one of the following cmdlets:

False

Named

True (ByProperty
Name)

Name

Specifies the name you want to assign to the protection group.

String

False

Named

True (ByProperty
Name)

Description

Specifies the description of the protection group.

String

False

Named

True (ByProperty
Name)

ScheduleOptions

Specifies the discovery schedule. The cmdlet will use this schedule to perform discovery operations for computers in the protection group.

Accepts the VBRProtectionGroupScheduleOptions object. To get this object, run the New-VBRProtectionGroupScheduleOptions cmdlet.

False

Named

True (ByProperty
Name)

DeploymentOptions

Specifies Veeam Agent deployment settings. The cmdlet will use these settings to install Veeam Agent on the discovered computers in the protection group.

Accepts the VBRProtectionGroupDeploymentOptions object. To get this object, run the New-VBRProtectionGroupDeploymentOptions cmdlet.

False

Named

True (ByProperty
Name)

AdvancedOptions

Specifies settings for Veeam Agent for Windows deployed on computers in the protection group. You can specify the following settings:

  • Network usage settings
  • Throttling settings
  • Security settings

Accepts the VBRProtectionGroupAdvancedWindowsOptions object. To get this object, run the New-VBRProtectionGroupAdvancedWindowsOptions cmdlet.

False

Named

True (ByProperty
Name)

NotificationOptions

Specifies notification settings for the protection group.

Accepts the VBRProtectionGroupNotificationOptions object. To get this object, run the New-VBRProtectionGroupNotificationOptions cmdlet.

False

Named

True (ByProperty
Name)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRProtectionGroup

Examples

Adding Computer to Protection Group

This example shows how to add a computer to an existing protection group.

$group = Get-VBRProtectionGroup -Name Computers

$comp = $group.Container.CustomCredentials

$supervisor = New-VBRIndividualComputerCustomCredentials -HostName support.east.local -Credentials support\jsmith

$comp += $supervisor

$newcomp = Set-VBRIndividualComputerContainer -Container $group.Container -CustomCredentials $comp

Set-VBRProtectionGroup -ProtectionGroup $group -Container $newcomp

Perform the following steps:

  1. Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
  2. Use the Container.CustomCredentials property of the $group variable. Save the result to the $comp variable.
  3. Run the New-VBRIndividualComputerCustomCredentials cmdlet. Specify the Name and the Credentials parameter values. Save the result to the $superviser variable.
  4. Add the computer to the group of computers in the $comp variable. Use the += operator.
  5. Run the Set-VBRIndividualComputerContainer cmdlet. Set the Container property of the $group variable as the Container parameter value. Set the $comp variable as the CustomCredentials parameter value. Save the result to the $newcomp variable.
  6. Run the Set-VBRProtectionGroup cmdlet. Set the $group variable as the ProtectionGroup parameter value. Set the $newcomp variable as the Container parameter value.

Related Commands