Add-VBRProtectionGroup

Short Description

Creates protection groups in Veeam Backup & Replication.

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

Syntax

Add-VBRProtectionGroup -Name <String> [-Description <String>] -Container <VBRProtectionGroupContainer>

[-ScheduleOptions <VBRProtectionGroupScheduleOptions>]

[-DeploymentOptions <VBRProtectionGroupDeploymentOptions>]

[-AdvancedOptions <VBRProtectionGroupAdvancedWindowsOptions>]

[-NotificationOptions <VBRProtectionGroupNotificationOptions>] [-CacheRepository <VBRBackupRepository>] [<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:

Active Directory objects.
Individual computers.
Cloud machines.
Computers imported from a CSV file.
Computers with pre-installed backup agents.
MongoDB Replica sets.
InterSystems IRIS servers.

For more information about the protection scope, see the following cmdlets:

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`VBRProtectionGroupAdvancedWindowsOptions`	False	Named	True (ByPropertyName)
CacheRepository	Specifies the cache repository for the protection group. Veeam Backup & Replication will keep the .VCACHE files on this repository. This parameter applies only to protection groups with the IrisServers container type. If you do not specify the parameter, Veeam Backup & Replication will automatically select a default cache repository. Accepts the `VBRBackupRepository` object. To get this object, run the `Get-VBRBackupRepository` cmdlet.	`VBRBackupRepository`	False	Named	True (ByPropertyName)
Container	Specifies the protection scope. The protection scope can contain the following objects: Active Directory objects. Individual computers. Cloud machines. Computers imported from a CSV file. Computers with pre-installed backup agents. MongoDB Replica sets. InterSystems IRIS servers. The cmdlet will create the protection group with this protection scope. Accepts the following objects: `VBRADContainer` `VBRIndividualComputerContainer` `VBRAmazonEC2Container` `VBRAzureContainer` `VBRCSVContainer` `VBRManuallyDeployedContainer` `VBRMongoDBContainer` `VBRIrisContainer` To get this objects, run one of the following cmdlets: `New-VBRADContainer` `New-VBRIndividualComputerContainer` `New-VBRAmazonEC2Container` `New-VBRAzureContainer` `New-VBRCSVContainer` `New-VBRManuallyDeployedContainer` `New-VBRMongoDBContainer` `New-VBRIrisContainer`	`VBRProtectionGroupContainer`	True	Named	True (ByPropertyName, ByValue)
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.	`VBRProtectionGroupDeploymentOptions`	False	Named	True (ByPropertyName)
Description	Specifies the description of the protection group.	`String`	False	Named	True (ByPropertyName)
Name	Specifies the name you want to assign to the protection group.	`String`	True	Named	True (ByPropertyName)
NotificationOptions	Specifies notification settings for the protection group. Accepts the `VBRProtectionGroupNotificationOptions` object. To get this object, run the `New-VBRProtectionGroupNotificationOptions` cmdlet.	`VBRProtectionGroupNotificationOptions`	False	Named	True (ByPropertyName)
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.	`VBRProtectionGroupScheduleOptions`	False	Named	True (ByPropertyName)

<CommonParameters>

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

Output Object

VBRProtectionGroup

Examples

Add-VBRProtectionGroup Example 1. Creating Protection Group for Individual Computers

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.

$creds = Get-VBRCredentials -Name "jsmith@support.east.local"

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

$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

Perform the following steps:

Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $creds variable.
Run the New-VBRIndividualComputerCustomCredentials cmdlet. Use the ForEach statement to apply the same credentials to multiple computers. Set the $creds variable as the -Credentials parameter value. Save the result to the $computers variable.
Run the New-VBRIndividualComputerContainer cmdlet. Set the $computers variable as the CustomCredentials parameter value. Save the result to the $scope variable.
Run the New-VBRPeriodicallyOptions cmdlet. Specify the FullPeriod and the PeriodicallyKind parameter values. Save the result to the $periodically variable.
Run the New-VBRProtectionGroupScheduleOptions cmdlet. Set the Periodically value as the PolicyType parameter value. Set the $periodically variable as the PeriodicallyOptions parameter value. Save the result to the $schedule variable.
Run the New-VBRProtectionGroupDeploymentOptions cmdlet. Provide the InstallAgent parameter. Save the result to the $deployment variable.
Run the Add-VBRProtectionGroup cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $scope variable as the Container parameter value.
- Set the $schedule variable as the ScheduleOptions parameter value.
- Set the $deployment variable as the DeploymentOptions parameter value.

Add-VBRProtectionGroup Example 2. Creating Protection Group for Pre-Installed Veeam Agents

This example shows how to create a protection group that will include Linux and Unix computers with pre-installed Veeam Agents.

$linuxdistr = Get-VBRProtectionGroupLinuxPackage -LinuxDistributionName "debian", "ubuntu" -LinuxPackageBitness X64

$unixdistr = Get-VBRProtectionGroupUnixPackage -Name "Solaris Intel"

$preinstalledcontainer = New-VBRManuallyDeployedContainer -Path \\srv001\VeeamBackups -LinuxPackage $linuxdistr -UnixPackage $unixdistr

Add-VBRProtectionGroup -Name PreinstalledPG -Container $preinstalledcontainer

Perform the following steps:

Run the Get-VBRProtectionGroupLinuxPackage cmdlet. Specify the LinuxDistributionName and LinuxPackageBitness parameter values. Save the result to the $linuxdistr variable.
Run the Get-VBRProtectionGroupUnixPackage cmdlet. Specify the Name parameter value. Save the result to the $unixdistr variable.
Run the New-VBRManuallyDeployedContainer cmdlet. Specify the Path parameter value. Set the $linuxdistr variable as the LinuxPackage parameter value. Set the $unixdistr variable as the UnixPackage parameter value. Save the result to the $preinstalledcontainer variable.
Run the Add-VBRProtectionGroup cmdlet. Specify the Name parameter value. Set the $preinstalledcontainer variable as the Container parameter value.