Add-VBRAdvancedLatencyOptions

Short Description

Defines latency settings for a specific datastore.

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

Vi

Add-VBRAdvancedLatencyOptions -ViDatastore <VBRViDatastore> [-LatencyLimitMs <Int32>]

[-ThrottlingIOLimitMs <Int32>] [<CommonParameters>]
Hv

Add-VBRAdvancedLatencyOptions -HvVolume <VBRHvServerVolumeObject> [-LatencyLimitMs <Int32>]

[-ThrottlingIOLimitMs <Int32>] [<CommonParameters>]

Detailed Description

This creates the VBRAdvancedLatencyOptions object that defines latency settings for a specific datastore.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
HvVolume	Specifies the following types of datastores: Microsoft Hyper-V Microsoft SMB3 servers The cmdlet will define latency settings for these datastores. Accepts the `VBRHvServerVolumeObject` object. To get this object, run the `Get-VBRHvServerVolume` cmdlet.	`VBRHvServerVolumeObject`	True	Named	True (ByPropertyName, ByValue)
LatencyLimitMs	Specifies the I/O latency limit at which Veeam Backup & Replication will not assign new tasks that are targeted at the datastore. Default: 20 ms.	`Int32`	False	Named	False
ThrottlingIOLimitMs	Specifies the I/O latency speed limit. When Veeam Backup & Replication reaches this limit, it will decrease the speed at which it either gets data from a datastore or writes data to it. Default: 30 ms.	`Int32`	False	Named	False
ViDatastore	Specifies the VMware datastores. The cmdlet will define latency settings for these datastores. Accepts the `VBRViDatastore` object. To get this object, run the `Find-VBRViDatastore` cmdlet.	`VBRViDatastore`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

The cmdlet returns the VBRAdvancedLatencyOptions object that defines latency settings for a specific datastore.

Examples

Add-VBRAdvancedLatencyOptions Example 1. Defining Latency Settings for VMware Datastore

This example shows how to set the I/O latency limit of new tasks that are targeted at the VMware datastore to 50 ms.

$server = Get-VBRServer -Name esx06.tech.local

$datastore = Find-VBRViDatastore -Server $server

Add-VBRAdvancedLatencyOptions -ViDatastore $datastore -LatencyLimitMs 50

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Find-VBRViDatastore cmdlet. Set the $server variable as the Server parameter value. Save the result to the $datastore variable.
Run the Add-VBRAdvancedLatencyOptions cmdlet. Set the $datastore variable as the ViDatastore parameter value. Specify the LatencyLimitMs parameter value.

Add-VBRAdvancedLatencyOptions Example 2. Defining Latency Settings for Hyper-V Datastores

This example shows how to set the I/O latency speed limit to 40 ms for The Hyper-V datastore.

$server = Get-VBRServer -Name hyperv09.tech.local

$volume = Get-VBRHvServerVolume -Server $server

Add-VBRAdvancedLatencyOptions -HvVolume $volume -ThrottlingIOLimitMs 40

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRHvServerVolume cmdlet. Set the $server variable as the Server parameter value. Save the result to the $volume variable.
Run the Add-VBRAdvancedLatencyOptions cmdlet. Set the $volume variable as the HvVolume parameter value. Specify the ThrottlingIOLimitMs parameter value.