Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRProtectionGroup

Short Description

Modifies protection groups.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires Veeam Agent for Microsoft Windows/Veeam Agent for Linux license

Syntax

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

Detailed Description

This cmdlet modifies settings of a protection group.

To modify settings, enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

ProtectionGroup

Specifies the protection group you want to modify.

Accepts VBRProtectionGroup type.

True

Named

True (ByValue,
ByProperty
Name)

False

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 for this protection scope.

Accepts the following types:

False

Named

True (ByProperty
Name)

False

Name

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

False

Named

True (ByProperty
Name)

False

Description

Specifies the description of the protection group.

False

Named

True (ByProperty
Name)

False

ScheduleOptions

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

Accepts VBRProtectionGroupScheduleOptions type.

False

Named

True (ByProperty
Name)

False

DeploymentOptions

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

Accepts VBRProtectionGroupDeploymentOptions type.

False

Named

True (ByProperty
Name)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRProtectionGroup

Example

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

You will need to perform the following steps:

  1. Run Get-VBRProtectionGroup to get the protection group whose settings you want to modify. Save the result to the $group variable.
  2. Get individual computers. Use the Container.CustomCredentials property of the protection group object saved to the $group variable. Save the result to the $comp variable.
  3. Run New-VBRIndividualComputerCustomCredentials to specify credentials for authenticating with the computer you want to add to the protection group. 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 Set-VBRIndividualComputerContainer with the $group and $comp variables to modify the protection scope. Save the result to the $newcomp variable.
  6. Run Set-VBRProtectionGroup with the $group and $newcomp variables.

PS C:\PS> $group = Get-VBRProtectionGroup -Name Computers

PS C:\PS> $comp = $group.Container.CustomCredentials

PS C:\PS> $supervisor = New-VBRIndividualComputerCustomCredentials -HostName support.east.local -Credentials support\jsmith

PS C:\PS> $comp += $supervisor

PS C:\PS> $newcomp = Set-VBRIndividualComputerContainer -Container $group.Container -CustomCredentials $comp

PS C:\PS> Set-VBRProtectionGroup -ProtectionGroup $group -Container $newcomp

Related Commands

Get-VBRProtectionGroup

New-VBRIndividualComputerCustomCredentials

Set-VBRIndividualComputerContainer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation