Set-VBRJobProxy

Short Description

Modifies settings of a backup proxy.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides parameter sets that allow you to:

Assign specific backup proxies to a job.

Set-VBRJobProxy -Job <CBackupJob[]> -Proxy <IProxy[]> [-Target] [<CommonParameters>]

Set automatic proxy selection.

Set-VBRJobProxy -Job <CBackupJob[]> -AutoDetect [-Target] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a backup proxy.

You can run this cmdlet with backup jobs and replica jobs.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Important

If you want to set a custom proxy, make sure that the proxy server is added to the backup infrastructure console, otherwise you will not be able to assign it to the job. The custom proxy server must be configured appropriately. For more information on proxy server settings, see Adding VMware Backup Proxies section in the Veeam Backup & Replication User Guide.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies an array of jobs. The cmdlet will return proxies assigned to these jobs.	Accepts the CBackupJob[] object. To get this object, run the Get-VBRJob cmdlet.	True	Named	True (ByValue, ByProperty Name)
Proxy	Specifies an array of proxies you want to assign to the job.	Accepts the IProxy[] object. To get this object, run the Get-VBRViProxy or Get-VBRHvProxy cmdlet.	True	Named	False
AutoDetect	Defines that the automatic selection mode is enabled. If you provide this parameter, the proxy server selection mode will be set to automatic. Otherwise, you must specify the custom proxy server. Use the Proxy parameter to specify the custom proxy server. Default: False.	SwitchParameter	True	Named	False
Target	Defines that the autodetect option will be enabled for the target proxy server. If you provide this parameter, the automatic selection mode will be enabled for the target proxy server. Otherwise, the automatic selection mode will be enabled for the source proxy server. Default: False.	SwitchParameter	False	Named	False

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

Output Object

The cmdlet returns the CBackupJob[] object that contains an array of jobs.

Examples

Set-VBRJobProxy Example 1. Assigning Hyper-V Proxy to Job [Using Variable]

Set-VBRJobProxy Example 2. Assigning VMware Proxies to Job [Using Pipeline]

Set-VBRJobProxy Example 3. Setting Automatic Proxy Selection to Job [Using Pipeline]

Related Commands