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

Add-VBRProtectionGroup

Short Description

Creates protection groups in Veeam Backup & Replication.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

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

Syntax

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

Detailed Description

This cmdlet creates protection groups.

Before creating a protection group, you must create a protection scope for this group. Protection groups can include the scope of Active Directory objects, individual computers or computers imported from a CSV file. For more information on protection scopes, see New-VBRADContainer, New-VBRIndividualComputerContainer and New-VBRCSVContainer.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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:

True

Named

True (ByValue,
ByProperty
Name)

False

Name

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

True

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 create a protection group with the following settings:

  • The created protection group will include individual computers.
  • Veeam Backup & Replication will perform discovery operations every 12 hours for the computers of this protection group.
  • Veeam Backup & Replication will automatically install Veeam Agents on all discovered computers of this protection group.

To create a protection group, you will need to perform the following steps:

  1. Run New-VBRIndividualComputerCustomCredentials to specify credentials for the computers you want to add to the protection group. Use the ForEach statement to apply the same credentials to multiple computers. Save the result to the $computers variable.
  2. Run New-VBRIndividualComputerContainer with the $computers variable to create the scope of computers for the protection group. Save the result to the $scope variable.
  3. Run New-VBRPeriodicallyOptions to create an object with the periodically schedule settings. Save the result to the $periodically variable.
  4. Run New-VBRProtectionGroupScheduleOptions with the $periodically variable to create a discovery schedule for the protection group. Save the result to the $schedule variable.
  5. Run New-VBRProtectionGroupDeploymentOptions with the InstallAgent parameter to create an object with the agent deployment settings.
  6. Run Add-VBRProtectionGroup with the $scope, $schedule and $deployment variables.

PS C:\PS> $computers = @("support.east.local", "qa.east.local", "adm-v8931") | ForEach { New-VBRIndividualComputerCustomCredentials -HostName $_ -Credentials "support\jsmith"}

PS C:\PS> $scope = New-VBRIndividualComputerContainer -CustomCredentials $computers

PS C:\PS> $periodically = New-VBRPeriodicallyOptions -FullPeriod 12 -PeriodicallyKind Hours

PS C:\PS> $schedule = New-VBRProtectionGroupScheduleOptions -PolicyType Periodically -PeriodicallyOptions $periodically

PS C:\PS> $deployment = New-VBRProtectionGroupDeploymentOptions -InstallAgent

PS C:\PS> Add-VBRProtectionGroup -Name "Support_East" -Container $scope -ScheduleOptions $schedule -DeploymentOptions $deployment

Related Commands

New-VBRIndividualComputerCustomCredentials

New-VBRIndividualComputerContainer

New-VBRPeriodicallyOptions

New-VBRProtectionGroupScheduleOptions

New-VBRProtectionGroupDeploymentOptions

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

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