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 | Accept |
ProtectionGroup | Specifies the protection group you want to modify. Accepts VBRProtectionGroup type. | True | Named | True (ByValue, | 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 | False |
Name | Specifies the name you want to assign to the protection group. | False | Named | True (ByProperty | False |
Description | Specifies the description of the protection group. | False | Named | True (ByProperty | 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 | 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 | 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
Example
This example shows how to add a computer to an existing protection group.
You will need to perform the following steps:
- Run Get-VBRProtectionGroup to get the protection group whose settings you want to modify. Save the result to the $group variable.
- 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.
- 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.
- Add the computer to the group of computers in the $comp variable. Use the += operator.
- Run Set-VBRIndividualComputerContainer with the $group and $comp variables to modify the protection scope. Save the result to the $newcomp variable.
- 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
New-VBRIndividualComputerCustomCredentials
Set-VBRIndividualComputerContainer
