Add-VBRViLinuxProxy

Short Description

Adds Linux backup proxy servers to the Veeam Backup & Replication backup infrastructure.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRViLinuxProxy -Server <CHost> [-Description <string>] [-MaxTasks <int>] [-ProxyVM <CViVmItem>] [-Force][<CommonParameters>]

Detailed Description

This cmdlet adds Linux backup proxy servers to the Veeam Backup & Replication backup infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Server

Specifies a Linux VM which will act as a backup proxy server. The cmdlet will assign a role of a backup proxy server to the Linux server that is added to the Veeam Backup & Replication backup infrastructure.

Note: You must provide the ProxyVM parameter in the following cases:

  • If Veeam Backup & Replication can not get the BIOS UUID of the Linux VM that you want to add as a backup proxy server.
  • If the disk.EnableUUID parameter in the vSphere configuration settings is set to False for the Linux VM that you want to add as a backup proxy server.
  • If the Linux VM that you want to add as a backup proxy server has been cloned or converted and this duplicate VM has the same BIOS UUID as the original one.

Accepts the CHost object. To create this object, run the Get-VBRServer 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

Add-VBRViLinuxProxyExample 1. Adding Linux Backup Proxy Server

This example shows how to add the LinSrv2045 VM as a Linux backup proxy server to the Veeam Backup & Replication infrastructure. The backup proxy server is assigned 3 maximum concurrent tasks.

$linuxsrv = Get-VBRServer -Name "LinSrv2045"

Add-VBRViLinuxProxy -Server $linuxsrv -MaxTasks 3 -Force

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $linuxsrv variable.
  2. Run the Add-VBRViLinuxProxy cmdlet. Set the $linuxsrv variable as the Server parameter value. Provide the Force parameter value.

Add-VBRViLinuxProxyExample 2. Adding Linux Backup Proxy Server and Assigning Backup Proxy Role Explicitly

This example shows how to add a Linux backup proxy server to the Veeam Backup & Replication backup infrastructure. The backup proxy server will be configured with 2 maximum concurrent tasks.

$linuxsrv = Get-VBRServer -Name "LinSrv2045"

$proxy = Find-VBRViEntity -Name "LinSrv2045"

Add-VBRViLinuxProxy -Server $linuxsrv -ProxyVM $proxy -Force

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $linuxsrv variable.
  2. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
  3. Run the Add-VBRViLinuxProxy cmdlet. Specify the following settings:
  • Set the $linuxsrv variable as the Server parameter value.
  • Set the $proxy variable as the ProxyVM parameter value.
  • Provide the Force parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

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