Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
PowerShell Reference

Get-VBOProxy

Short Description

Returns backup proxies.

Syntax

This cmdlet provides 4 parameter sets.

  • For getting all backup proxies added to Veeam Backup for Microsoft Office 365:

Get-VBOProxy  [<CommonParameters>]

  • For getting a backup proxy by DNS-name or IP address:

Get-VBOProxy -Hostname <string>  [<CommonParameters>]

  • For getting a backup proxy by the proxy ID:

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

  • For getting backup proxies by associated Exchange organization:

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

Detailed Description

This cmdlet returns backup proxies added to Veeam Backup for Microsoft Office 365 configuration.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Hostname

Specifies DNS-name or IP address of the proxy server.

True

Named

False

False

Id

Specifies the ID assigned to the backup proxy. The cmdlet will return the backup proxy with this ID.

True

Named

False

False

Organization

Specifies Exchange organization associated with the backup proxy.

True

Named

True (ByValue)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command returns a backup proxy with a specified ID.

PS C:\PS> Get-VBOProxy -Id "d96f55a4-d15d-410b-b0f0-d51d17ccdab6"

Example 2

This command returns a backup proxy by IP address.

PS C:\PS> Get-VBOProxy -Hostname 172.17.53.53

Example 3

This command returns a backup proxy by the associated organization.

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get Exchange organization. Save the result to the $org variable.
  2. Run Get-VBOProxy with the $org variable.

PS C:\PS> $org = Get-VBOOrganization -Name "ABC"

PS C:\PS> Get-VBOProxy -Organization $org

Related Commands

Get-VBOOrganization

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference