Set-VBRNetworkTrafficRule

In this article

    Short Description

    Modifies network traffic rules.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRNetworkTrafficRule -Rule <VBRNetworkTrafficRule> [-Name <string>] [-SourceIPStart <ipaddress>][-SourceIPEnd <ipaddress>] [-TargetIPStart <ipaddress>] [-TargetIPEnd <ipaddress>] [-EnableEncryption][-EnableThrottling] [-ThrottlingUnit <VBRSpeedUnit> {MbitPerSec | MbytePerSec | KbytePerSec}] [-ThrottlingValue <int>] [-EnableThrottlingWindow] [-ThrottlingWindowOptions <VBRBackupWindowOptions>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies network traffic rules.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Rule

    Specifies a network traffic rule that you want to modify.

    True

    Named

    True (ByValue)

    False

    Name

    Specifies a that you want to assign to a network traffic rule.

    False

    Named

    False

    False

    SourceIPStart

    Specifies the first IP address of the IP source range.

    False

    Named

    False

    False

    SourceIPEnd

    Specifies the last IP address of the IP source range.

    False

    Named

    False

    False

    TargetIPStart

    Specifies the first IP address of the IP target range.

    False

    Named

    False

    False

    TargetIPEnd

    Specifies the last IP address of the IP target range.

    False

    Named

    False

    False

    EnableEncryption

    Enables encryption for a network traffic rule. Veeam Backup & Replication will encrypt the data that is passed between backup infrastructure components on the source and target side.

    False

    Named

    False

    False

    EnableThrottling

    Enables throttling for a network traffic rule. Veeam Backup & Replication will limit the traffic throughput between the backup infrastructure components within the specified IP range.

    Use the following parameters to set the maximum value:

    • ThrottlingValue
    • ThrottlingUnit

    False

    Named

    False

    False

    ThrottlingValue

    Specifies the maximum speed value that must be used to transfer VM machine data from source to target.

    False

    Named

    False

    False

    ThrottlingUnit

    For the EnableThrottling parameter.

    Specifies the measuring unit for the ThrottlingValue parameter: You can set the following units:

    • MbitPerSec
    • MbytePerSec
    • KbytePerSec

    Default: MbitPerSec.

    False

    Named

    False

    False

    ThrottlingValue

    Specifies the maximum speed value that must be used to transfer VM machine data from source to target.

    False

    Named

    False

    False

    EnableThrottlingWindow

    Indicates that a schedule for a network traffic rule is enabled.

    False

    Named

    False

    False

    ThrottlingWindowOptions

    Specifies the time intervals during which Veeam Backup & Replication must apply a network traffic rule.

    Accepts the  VBRBackupWindowOptions type.

    False

    Named

    False

    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 enable encryption for a network traffic rule.

    1. Run Get-VBRNetworkTrafficRule to get the network traffic rule that you want to modify. Save the result to the $rule variable.
    2. Run Set-VBRNetworkTrafficRule with the $rule variable. Use the EnableEncryption parameter to enable encryption.

    $rule = Get-VBRNetworkTrafficRule -Name "New rule"

    Set-VBRNetworkTrafficRule -Rule $rule -EnableEncryption

    Related Commands

    Get-VBRNetworkTrafficRule