Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRJobProxy

Short Description

Assigns a specific proxy to a job or enables automatic proxy selection.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRJobProxy -Job <CBackupJob[]> -Proxy <IProxy[]> [-Target] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Set-VBRJobProxy -Job <CBackupJob[]> -AutoDetect [-Target] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet assigns a specific proxy to a job or enables automatic proxy selection.

When you create a job, the proxy server is set automatically by default. With this cmdlet, you can assign a custom proxy to a job or set the automatic proxy selection back. This cmdlet provides two scenarios for each case.

You can run this cmdlet with backup and replica jobs.

Set-VBRJobProxy Important!

If you want to set a custom proxy you should make sure that the proxy server is added to Veeam Backup & Replication console, otherwise you will not be able to assign it to the job. The custom proxy server should be configured appropriately. Read more about proxy server settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center.

Run Get-VBRJobProxy to get the list of proxies assigned to a specific job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the array of jobs. The cmdlet will apply the proxy selection mode to these jobs.

True

Named

True (ByValue,
ByProperty
Name)

False

Proxy

Specifies the array of  proxies you want to assign to the job.

True

Named

False

False

Target

If set, the command returns the list of target proxies. If omitted, the command returns the list of source proxy servers.

False

Named

False

False

AutoDetect

If set, the proxy server selection mode is set to automatic. If you do not set this parameter, you should specify the custom proxy server.

True

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.

Example 1

This command assigns the custom VMware source proxy to the jobs named "Backup Job 01" and "Backup Job 02". The jobs are obtained with Get-VBRJob and piped down. The proxy to assign is obtained with Get-VBRViProxy and assigned to the $SourceProxy variable beforehand. The -Target parameter is not set to enable the source proxy allocation.

PS C:\PS> Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Set-VBRJobProxy -Proxy $SourceProxy

Example 2

This command assigns the custom Hyper-V target proxy to the job represented by the $job variable. The proxy to assign is obtained with Get-VBRHvProxy and assigned to the $proxy variable beforehand. The -Target parameter is set to enable target proxy allocation.

PS C:\PS> Set-VBRJobProxy -Job $job -Proxy $proxy -Target

Example 3

This command sets the automatic source proxy selection mode to the  jobs named "Backup Job 01" and "Backup Job 02". The jobs are obtained with Get-VBRJob and piped down. The -Target parameter is not set to enable the source proxy allocation.

PS C:\PS> Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Set-VBRJobProxy -AutoDetect

Related Commands

Get-VBRJob

Get-VBRViProxy / Get-VBRHvProxy

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation