Set-VBRViLinuxProxy

Short Description

Modifies settings of Linux backup proxy servers to the Veeam Backup & Replication backup infrastructure.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRViLinuxProxy -Proxy <CViProxy> [-Description <string>] [-MaxTasks <int>] [-ProxyVM <CViVmItem>] [-Force][<CommonParameters>]

Detailed Description

This cmdlet modifies settings of Linux backup proxy servers to the Veeam Backup & Replication backup infrastructure. This cmdlet modifies an existing VMware replication job. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Proxy

Specifies the Linux backup proxy server. The cmdlet will modify the settings of this backup proxy server.

Accepts the CViProxy object. To create this object, run the Get-VBRViProxy cmdlet.

True

Named

True (ByValue, ByPropertyName)

Description

Specifies the description of the Linux backup proxy server.

String

False

Named

False

MaxTasks

Specifies the number of concurrent tasks that can be assigned to the backup proxy server simultaneously.

Permitted values: 1-100.

Default: 2.

Int32

False

Named

False

ProxyVM

Specifies a Linux VM that is added to the VMware environment. The cmdlet will assign a backup proxy role explicitly to this Linux VM.

Accepts the SwitchParameter object. To create this object, run the Find-VBRViEntity cmdlet.

False

Named

False

Force

Indicates that the cmdlet will add a Linux backup proxy without showing warnings in the PowerShell console.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBRHvServerVolume object that contains settings of Linux backup proxy added to the Veeam Backup & Replication backup infrastructure.

Examples

Modifying Number of Concurrent Tasks

This example shows how to modify a number of concurrent tasks for the Linux server.

$proxy = Get-VBRViProxy -Name "LinProxy"

Set-VBRViLinuxProxy -Proxy $proxy -MaxTasks 4

Perform the following steps:

  1. Run the Get-VBRViProxy cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
  2. Run the Set-VBRViLinuxProxy cmdlet. Set the $proxy variable as the Proxy parameter value. Specify the MaxTasks parameter value.

Related Commands

Get-VBRViProxy

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.