Add-VBRProtectionGroup
Short Description
Creates protection groups in Veeam Backup & Replication.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
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 | Type | Required | Position | Accept |
---|---|---|---|---|---|
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: | True | Named | True (ByValue, |
Name | Specifies the name you want to assign to the protection group. | String | True | Named | True (ByProperty |
Description | Specifies the description of the protection group. | String | False | Named | True (ByProperty |
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 |
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 |
AdvancedOptions | Specifies settings for Veeam Agent for Windows deployed on computers in the protection group. You can specify the following settings:
| Accepts the VBRProtectionGroupAdvancedWindowsOptions object. To get this object, run the New-VBRProtectionGroupAdvancedWindowsOptions cmdlet. | False | Named | True (ByProperty |
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 |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
Examples
Creating Protection Group
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.
$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 |
Perform the following steps:
- Run the New-VBRIndividualComputerCustomCredentials cmdlet. Use the ForEach statement to apply the same credentials to multiple computers. 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.
Related Commands