Get-VBOProxy

Short Description

Returns backup proxy servers added to the Veeam Backup for Microsoft 365 infrastructure.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get a backup proxy server by the server DNS name or IP address.

Get-VBOProxy -Hostname <String> [-ExtendedView <SwitchParameter>] [<CommonParameters>]

  • Get a backup proxy server by the server ID.

Get-VBOProxy -Id <Guid> [-ExtendedView <SwitchParameter>] [<CommonParameters>]

  • Get a list of backup proxy servers by the specified organization.

Get-VBOProxy [-Organization <VBOOrganization>] [-ExtendedView <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet returns a list of backup proxy servers added to the Veeam Backup for Microsoft 365 backup infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Hostname

Specifies a DNS name or an IP address of the backup proxy server that you want to get.

String

True

Named

False

False

Id

Specifies an ID of the backup proxy server. The cmdlet will return the backup proxy server with the specified ID.

Guid

True

Named

False

False

Organization

Specifies a Microsoft organization. The cmdlet will return the backup proxy that is assigned to the specified organization.

Accepts the VBOOrganization object.

To get this object, run the Get-VBOOrganization cmdlet.

False

Named

True (ByValue)

False

ExtendedView

Defines whether the cmdlet will return all parameters of the backup proxy server (if the proxy server is online) or exclude from a list the following parameters:

  • ThreadsNumber
  • ThrottlingValue

Default: True

SwitchParameter

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.

Output Object

The cmdlet returns the VBOProxy object that contains a list of backup proxy servers added to the Veeam Backup for Microsoft 365 backup infrastructure.

Examples

Get-VBOProxyExample 1. Getting All Backup Proxy Servers

This command returns all backup proxy servers that are added to the Veeam Backup for Microsoft 365 infrastructure.

Get-VBOProxy

Get-VBOProxyExample 2. Getting Backup Proxy Server by ID

This command returns a backup proxy with the ID d96f55a4-d15d-410b-b0f0-d51d17ccdab6.

Get-VBOProxy -Id d96f55a4-d15d-410b-b0f0-d51d17ccdab6

Get-VBOProxyExample 3. Getting Backup Proxy Server by IP

This command returns a backup proxy with the 172.17.53.53 IP address.

Get-VBOProxy -Hostname 172.17.53.53

Get-VBOProxyExample 4. Getting Backup Proxy Server by Organization

This example shows how to get a backup proxy associated with the Columbus organization.

$org = Get-VBOOrganization -Name "Columbus"

Get-VBOProxy -Organization $org

Perform the following steps:

  1. Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
  2. Run the Get-VBOProxy cmdlet. Set the $org variable as the Organization parameter value.

Related Commands

Get-VBOOrganization