New-VBRProtectionGroupAdvancedWindowsOptions

Short Description

Creates additional settings for Veeam Agent for Microsoft Windows.

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

Syntax

New-VBRProtectionGroupAdvancedWindowsOptions [-EnableBandwidthThrottling] [-BandwidthThrottlingValue <Int32>]

[-BandwidthThrottlingUnitType <VBRSpeedUnit>] [-DisableBackupOverMeteredConnection]

[-DisableBackupOverVPNConnections] [-UseSpecifiedWiFiNetworks] [-WiFiNetworks <String[]>]

[-EnableAgentThrottling] [-ThrottleAgentOn <VBREpThrottlingAgentType>]

[-EnableFLRWithoutAdministrativeAccount] [-CreateEmbeddedRecoveryMedia] [<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

Tip

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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	`VBRSpeedUnit`	False	Named	True (ByPropertyName)
BandwidthThrottlingValue	Specifies the bandwidth limit value.	`Int32`	False	Named	True (ByPropertyName)
CreateEmbeddedRecoveryMedia	Defines that Veeam Backup & Replication will create recovery media for the Veeam Agent computers added to the protection group and place the media inside the operating system of these computers.	`SwitchParameter`	False	Named	True (ByPropertyName)
DisableBackupOverMeteredConnection	Defines that backup over metered connections will be disabled.	`SwitchParameter`	False	Named	True (ByPropertyName)
DisableBackupOverVPNConnections	Defines that backup over VPN connections will be disabled.	`SwitchParameter`	False	Named	True (ByPropertyName)
EnableAgentThrottling	Enables throttling for Veeam Agent activities during backup. Use the `ThrottleAgentOn` parameter to specify the type of computers.	`SwitchParameter`	False	Named	True (ByPropertyName)
EnableBandwidthThrottling	Enables the bandwidth limit. Use the `BandwidthThrottlingValue` and the `BandwidthThrottlingUnitType` parameters to set the value and the unit type for bandwidth limit.	`SwitchParameter`	False	Named	True (ByPropertyName)
EnableFLRWithoutAdministrativeAccount	Defines 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.	`SwitchParameter`	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`	`VBREpThrottlingAgentType`	False	Named	True (ByPropertyName)
UseSpecifiedWiFiNetworks	Defines 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.	`SwitchParameter`	False	Named	True (ByPropertyName)
WiFiNetworks	Specifies the SSID of the Wi-Fi network. Veeam Agent will perform backup over the specified SSID only.	`String[]`	False	Named	True (ByPropertyName)

<CommonParameters>

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

Output Object

VBRProtectionGroupAdvancedWindowsOptions

Examples

New-VBRProtectionGroupAdvancedWindowsOptions Example 1. Creating Additional Settings for Microsoft Windows Machines

This command creates 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.
Embedded recovery media will be created for the protected computers.

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

New-VBRProtectionGroupAdvancedWindowsOptions Example 2. Applying Additional Settings to Protection Group

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

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

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

Set-VBRProtectionGroup -ProtectionGroup $group -AdvancedOptions $options

Perform the following steps:

Run the New-VBRProtectionGroupAdvancedWindowsOptions cmdlet. Specify the necessary parameters. Save the result to the $options variable.
Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run the Set-VBRProtectionGroup cmdlet. Set the $group variable as the ProtectionGroup parameter value. Set the $options variable as the AdvancedOptions parameter value.

Notes

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