Get-VBRNASProxyServer

Short Description

Returns general-purpose backup proxies added to the Veeam Backup & Replication infrastructure.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get all general-purpose backup proxies added to the Veeam Backup & Replication infrastructure.

Get-VBRNASProxyServer  [<CommonParameters>]

  • Get general-purpose backup proxies by name.

Get-VBRNASProxyServer -Name <string[]>  [<CommonParameters>]

  • Get general-purpose backup proxies by ID.

Get-VBRNASProxyServer -Id <guid[]>  [<CommonParameters>]

Detailed Description

This cmdlet returns an array of general-purpose backup proxies added to the Veeam Backup & Replication infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

Specifies an array of names of general-purpose backup proxies. The cmdlet will return an array of proxies with the specified names.

String[]

True

Named

False

Id

Specifies an array of IDs of general-purpose backup proxies. The cmdlet will return an array of proxies with the specified IDs.

Guid[]

True

Named

False

<CommonParameters>

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

Output Object

VBRNASProxyServer

Examples

Example 1. Getting All General-Purpose Backup Proxies

This command gets all general-purpose backup proxies. The cmdlet output will contain the following details on general-purpose backup proxies: ID, Description, Server and ConcurrentTaskNumber.

Get-VBRNASProxyServer

Id                            Description                   Server                                 ConcurrentTaskNumber

--                            -----------                   ------                                 --------------------

2df7b4a9-e230-4bc7-97a6-db... Created by Veeam Backup & ... Veeam.Backup.Core.Common.C...                             2

5a7c25b9-87cb-41e3-bb1b-81... Created by Powershell at 8... Veeam.Backup.Core.Common.C...                             7

Example 2. Getting General-Purpose Backup Proxy by Name

This command gets the general-purpose backup proxy by name. The cmdlet output will contain the following details on the general-purpose backup proxy: ID, Description, Server and ConcurrentTaskNumber.

Get-VBRNASProxyServer -Name "File Backup Proxy 09"

Id                            Description                   Server                                 ConcurrentTaskNumber

--                            -----------                   ------                                 --------------------

dbb139cf-4ac1-4a9e-95fa-e9... Created by Powershell at 8... Veeam.Backup.Core.Common.C...                             2

Example 3. Getting General-Purpose Backup Proxy by ID

This command gets the general-purpose backup proxy by ID. The cmdlet output will contain the following details on the general-purpose backup proxy: ID, Description, Server and ConcurrentTaskNumber.

Get-VBRNASProxyServer -Id "02da6898-308d-44ac-b007-94d81576c296"

Id                            Description                   Server                                 ConcurrentTaskNumber

--                            -----------                   ------                                 --------------------

02da6898-308d-44ac-b007-94... Created by Powershell at 8... Veeam.Backup.Core.Common.C...                             2

Page updated 5/26/2025

Page content applies to build 12.3.2.3617