Get-VBRJobProxy

In this article

    Short Description

    Returns a list of proxy servers assigned to a specific job.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

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

    Detailed Description

    This cmdlet returns proxy servers assigned to a specific job. If the automatic proxy selection is enabled, the cmdlet will return a warning.

    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)

    Target

    Defines that the cmdlet will return only target proxies.

    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 CBackupJob[] object that contains an array of jobs.

    Examples

    Get-VBRJobProxyExample 1. Getting List of Target Proxies [Using Variable]

    This example shows how to get a list of proxies assigned to the Backup Copy job.

    $job = Get-VBRJob -Name "Backup Copy"

    Get-VBRJobProxy -Job $job -Target

    Perform the following steps:

    1. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the Get-VBRJobProxy cmdlet. Set the $job variable as the Job parameter value. Provide the Target parameter.

    Get-VBRJobProxyExample 2. Getting List of Target Proxies [Using Pipeline]

    This example shows how to get a list of target proxies assigned to the Backup Copy job.

    Get-VBRJob -Name "Backup Job" | Get-VBRJobProxy -Target

    Perform the following steps:

    1. Run the Get-VBRJob cmdlet. Specify the Name parameter value.
    2. Pipe the cmdlet output to the Get-VBRJobProxy cmdlet. Provide the Target parameter.

    Related Commands

    Get-VBRJob