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

Add-VBRProtectionGroup

Short Description

Creates protection groups in Veeam Backup & Replication.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRProtectionGroup -Name <string> -Container <VBRProtectionGroupContainer> [-Description <string>] [-ScheduleOptions <VBRProtectionGroupScheduleOptions>] [-DeploymentOptions <VBRProtectionGroupDeploymentOptions>] [-AdvancedOptions <VBRProtectionGroupAdvancedWindowsOptions>] [-NotificationOptions <VBRProtectionGroupNotificationOptions>]  [<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 following objects: of Active Directory objects, individual computers or computers imported from a CSV file. For more information about the protection scope, see the following cmdlets:

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 with 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 the discovery schedule. The cmdlet will use this schedule to perform discovery operations for computers in the protection group.

Accepts the VBRProtectionGroupScheduleOptions type.

False

Named

True (ByProperty
Name)

False

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 type.

False

Named

True (ByProperty
Name)

False

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 type.

False

Named

True (ByProperty
Name)

 

NotificationOptions

Specifies notification settings for the protection group.

Accepts the VBRProtectionGroupNotificationOptions type.

False

Named

True (ByProperty
Name)

 

<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 discover computers in the protection group every 12 hours.
  • Veeam Backup & Replication will automatically install Veeam Agent on all discovered computers of this protection group.

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

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

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

$scope = New-VBRIndividualComputerContainer -CustomCredentials $computers

$periodically = New-VBRPeriodicallyOptions -FullPeriod 12 -PeriodicallyKind Hours

$schedule = New-VBRProtectionGroupScheduleOptions -PolicyType Periodically -PeriodicallyOptions $periodically

$deployment = New-VBRProtectionGroupDeploymentOptions -InstallAgent

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 Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation