Get-VBRComputerFileProxyServer

Short Description

Returns file proxy servers 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 file proxy servers added to the Veeam Backup & Replication infrastructure.

Get-VBRComputerFileProxyServer  [<CommonParameters>]

  • Get file proxy servers by the server name.

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

  • Get file proxy servers by the server ID.

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

Detailed Description

This cmdlet returns an array of file proxy servers added to your Veeam Backup & Replication infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

Specifies an array of names of a file proxy server. The cmdlet will return an array of these servers with the specified name.

String

False

Named

False

Id

Specifies an array of IDs of file proxy server. The cmdlet will return an array of these servers with the specified ID.

Guid

False

Named

False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRComputerFileProxyServer object that contains settings of the file proxy server added to the Veeam Backup & Replication infrastructure.

Examples

Get-VBRComputerFileProxyServerExample 1. Getting All File Proxy Servers

This command gets all file proxy servers that are added to the Veeam Backup & Replication infrastructure. The cmdlet output will contain the following details on file proxy servers: ID, Description, Server and ConcurrentTaskNumber.

Get-VBRComputerFileProxyServer

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

Get-VBRComputerFileProxyServerExample 2. Getting File Proxy Server by Name

This command gets all file proxy servers that are added to the Veeam Backup & Replication infrastructure by the file proxy server name. The cmdlet output will contain the following details on file proxy servers: ID, Description, Server and ConcurrentTaskNumber.

Get-VBRComputerFileProxyServer -Name "File Proxy 01"

Id                            Description                   Server                                 ConcurrentTaskNumber

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

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

Get-VBRComputerFileProxyServerExample 3. Getting File Proxy Server by ID

This command gets all file proxy servers that are added to the Veeam Backup & Replication infrastructure by the file proxy server ID. The cmdlet output will contain the following details on file proxy servers: ID, Description, Server and ConcurrentTaskNumber.

Get-VBRComputerFileProxyServer -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 1/5/2024

Page content applies to build 12.3.0.310