Get-VBOProxy

Short Description

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

Syntax

This cmdlet provides the following parameter sets:

AllParameterSet (Default)

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

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

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

Detailed Description

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ExtendedView	Note: This parameter will be deprecated in future versions of Veeam Backup for Microsoft 365. Defines that the cmdlet will return all parameters of the backup proxy server (if the backup proxy server is online) or exclude from a list the `ThrottlingValue` and `ThreadsNumber` parameters. Default: False	`SwitchParameter`	False	Named	False
Hostname	Specifies a DNS name or an IP address of the backup proxy server that you want to get.	`String`	True	Named	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
Organization	Specifies a Microsoft organization. The cmdlet will return backup proxy servers that are associated with the specified organization. Accepts the `VBOOrganization` object. To get this object, run the `Get-VBOOrganization` cmdlet.	`VBOOrganization`	False	Named	True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

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-VBOProxy Example 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-VBOProxy Example 2: Getting Backup Proxy Server by ID

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

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

Get-VBOProxy Example 3: Getting Backup Proxy Server by IP

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

Get-VBOProxy -Hostname 172.17.53.53

Get-VBOProxy Example 4: Getting Backup Proxy Server by Organization

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

$org = Get-VBOOrganization -Name "Columbus"

Get-VBOProxy -Organization $org

Perform the following steps:

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

Get-VBOOrganization