Get-VBRViProxy

In this article

    Short Description

    Returns VMware backup proxies.

    Applies to

    Platform: VMware

    For Hyper-V, run Get-VBRHvProxy.

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

    Syntax

    Get-VBRViProxy [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns VMware backup proxies managed by Veeam Backup & Replication.

    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

    Name

    Specifies the array of names of VMware proxies. The cmdlet will return proxies with these names.

    False

    Named

    False

    True

    <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 returns the list of all VMware proxies.

    Get-VBRViProxy

    Example 2

    This command returns the proxy with the name "LocalProxy".

    Get-VBRViProxy -Name "LocalProxy"

    Example 3

    This command returns the ID of the proxy.

    You will need to perform the following steps:

    1. Run Get-VBRViProxy to get the proxy. Save the result to the $proxy variable.
    2. Get the proxy ID using the Id property of the VMware proxy object saved to the $proxy variable. Save the result to the $proxyid variable.

    $proxy = Get-VBRViProxy -Name "LocalProxy"

    $proxyid = $proxy.id

    I want to report a typo

    There is a misspelling right here:

     

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