Set-VBRJobProxy

In this article

    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, Veeam Universal License

    Syntax

    This cmdlet provides the following parameter sets.

    • To assign specific backup proxies to a job

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

    • To set automatic proxy selection

    Set-VBRJobProxy -Job <CBackupJob[]> -AutoDetect [-Target]  [<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.

    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.

    Accepts the IProxy[] type.

    True

    Named

    False

    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.

    True

    Named

    False

    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.

    False

    Named

    False

    False

    <CommonParameters>

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

    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.

    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.

    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.

    Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Set-VBRJobProxy -AutoDetect

    Related Commands

    Get-VBRJob

    Get-VBRViProxy / Get-VBRHvProxy

    I want to report a typo

    There is a misspelling right here:

     

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