New-VBRProtectionGroupAdvancedWindowsOptions

In this article

    Short Description

    Creates additional settings for Veeam Agent for Microsoft Windows.

    Applies to

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

    Syntax

    New-VBRProtectionGroupAdvancedWindowsOptions [-EnableBandwidthThrottling] [-BandwidthThrottlingValue <int>] [-BandwidthThrottlingUnitType <VBRSpeedUnit> {MbitPerSec | MbytePerSec | KbytePerSec}] [-DisableBackupOverMeteredConnection] [-DisableBackupOverVPNConnections] [-UseSpecifiedWiFiNetworks] [-WiFiNetworks <string[]>] [-EnableAgentThrottling] [-ThrottleAgentOn <VBREpThrottlingAgentType> {Workstations | Servers | AllHosts}] [-EnableFLRWithoutAdministrativeAccount]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates the VBRProtectionGroupAdvancedWindowsOptions object. This object contains additional settings for Veeam Agent for Microsoft Windows machines. These settings will be applied to Veeam Agent deployed on computers added to a protection group. You can specify the following types of settings:

    • Network usage settings
    • Throttling settings
    • Security settings

    New-VBRProtectionGroupAdvancedWindowsOptions Tip:

    To apply the settings to an existing protection group, save the VBRProtectionGroupAdvancedWindowsOptions object to the variable and run the Set-VBRProtectionGroup cmdlet.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    EnableBandwidthThrottling

    Enables the bandwidth limit.

    Use the BandwidthThrottlingValue and the BandwidthThrottlingUnitType parameters to set the value and the unit type for bandwidth limit.

    False

    Named

    True (ByProperty
    Name)

     

    BandwidthThrottlingValue

    Specifies the bandwidth limit value.

    False

    Named

    True (ByProperty
    Name)

     

    BandwidthThrottlingUnitType

    Specifies the measure units for measure limit. You can select the following type of measure units:

    • MbitPerSec: for megabit per second unit
    • MbytePerSec: for megabyte per second unit
    • KbytePerSec: for kilobyte per second unit

    False

    Named

    True (ByProperty
    Name)

     

    DisableBackupOverMeteredConnection

    Indicates that backup over metered connections will be disabled.

    False

    Named

    True (ByPropertyName)

     

    DisableBackupOverVPNConnections

    Indicates that backup over VPN connections will be disabled.

    False

    Named

    True (ByPropertyName)

     

    UseSpecifiedWiFiNetworks

    Indicates that Veeam Backup & Replication will restrict the WiFi usage to the specified networks.

    Use the WiFiNetworks parameter to specify the networks over which backup will be allowed.

    False

    Named

    True (ByPropertyName)

     

    WiFiNetworks

    Specifies the SSID of the Wi-Fi network. Veeam Agent will perform backup over the specified SSID only.

    False

    Named

    True (ByPropertyName)

     

    EnableAgentThrottling

    Enables throttling for Veeam Agent activities during backup.

    Use the ThrottleAgentOn parameter to specify the type of computers.

    False

    Named

    True (ByPropertyName)

     

    ThrottleAgentOn

    Specifies the type of computers. Veeam Backup & Replication will throttle Veeam Agent activities during backup on computers of these types.

    You can select one of the following types of the computers:

    • Workstations
    • Servers
    • AllHosts

    False

    Named

    True (ByPropertyName)

     

    EnableFLRWithoutAdministrativeAccount

    Indicates that users without administrative privileges will be able to perform file-level restore on Veeam Agent computers.

    NOTE: This parameter works only for backups located on Veeam Backup & Replication.

    False

    Named

    True (ByPropertyName)

     

    <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 1

    This example shows how to create additional settings for Veeam Agent for Microsoft Windows machines. The additional settings will have the following options:

    • Bandwidth limit is enabled and set to 20 megabytes per second
    • Backup over metered connections option is enabled
    • Throttling for Veeam Agent activities is enabled on all machines
    • Users without administrative privileges will be able to perform the file-level restore on Veeam Agent computers

    New-VBRProtectionGroupAdvancedWindowsOptions -EnableBandwidthThrottling -BandwidthThrottlingValue 20  -BandwidthThrottlingUnitType MbytePerSec -DisableBackupOverMeteredConnection:$false  -EnableAgentThrottling -ThrottleAgentOn AllHosts -EnableFLRWithoutAdministrativeAccount

    Example 2

    This example shows how to create additional settings for the protection group and apply these settings to the existing protection group.

    1. Run New-VBRProtectionGroupAdvancedWindowsOptions to create the advanced settings. Save the result to the $options variable.
    2. Run Get-VBRProtectionGroup to get the protection group whose settings you want to modify. Save the result to the $group variable.
    3. Run Set-VBRProtectionGroup with the $group and $options variables.

    $options = New-VBRProtectionGroupAdvancedWindowsOptions -EnableBandwidthThrottling -BandwidthThrottlingValue 20 -BandwidthThrottlingUnitType MbytePerSec -DisableBackupOverMeteredConnection:$false  -EnableAgentThrottling -ThrottleAgentOn AllHosts -EnableFLRWithoutAdministrativeAccount

    $group = Get-VBRProtectionGroup -Name "Windows machines"

    Set-VBRProtectionGroup -ProtectionGroup $group -AdvancedOptions $options

    Related Commands

    Get-VBRProtectionGroup