Set-VBRProtectionGroup

In this article

    Short Description

    Modifies protection groups.

    Applies to

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

    Syntax

    Set-VBRProtectionGroup -ProtectionGroup <VBRProtectionGroup> [-Name <string>] [-Description <string>] [-Container <VBRProtectionGroupContainer>] [-ScheduleOptions <VBRProtectionGroupScheduleOptions>] [-DeploymentOptions <VBRProtectionGroupDeploymentOptions>] [-AdvancedOptions <VBRProtectionGroupAdvancedWindowsOptions>][-NotificationOptions <VBRProtectionGroupNotificationOptions>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies settings of a protection group.

    To modify settings, specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    ProtectionGroup

    Specifies the protection group you want to modify.

    Accepts VBRProtectionGroup type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    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 with this protection scope.

    Accepts the following types:

    False

    Named

    True (ByProperty
    Name)

    False

    Name

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

    False

    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 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 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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRProtectionGroup

    Example

    This example shows how to add a computer to an existing protection group.

    You will need to perform the following steps:

    1. Run Get-VBRProtectionGroup to get the protection group whose settings you want to modify. Save the result to the $group variable.
    2. 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.
    3. Run New-VBRIndividualComputerCustomCredentials to specify credentials to connect to the computer that you want to add to the protection group. Save the result to the $superviser variable.
    4. Add the computer to the group of computers in the $comp variable. Use the += operator.
    5. Run Set-VBRIndividualComputerContainer with the $group and $comp variables to modify the protection scope. Save the result to the $newcomp variable.
    6. Run Set-VBRProtectionGroup with the $group and $newcomp variables.

    $group = Get-VBRProtectionGroup -Name Computers

    $comp = $group.Container.CustomCredentials

    $supervisor = New-VBRIndividualComputerCustomCredentials -HostName support.east.local -Credentials support\jsmith

    $comp += $supervisor

    $newcomp = Set-VBRIndividualComputerContainer -Container $group.Container -CustomCredentials $comp

    Set-VBRProtectionGroup -ProtectionGroup $group -Container $newcomp

    Related Commands

    Get-VBRProtectionGroup

    New-VBRIndividualComputerCustomCredentials

    Set-VBRIndividualComputerContainer