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

Get-VBOProxy

Short Description

Returns backup proxies added to Veeam Backup for Microsoft Office 365.

Syntax

This cmdlet provides the following parameter sets.

  • Get all backup proxies added to Veeam Backup for Microsoft Office 365

Get-VBOProxy  [<CommonParameters>]

  • Get a backup proxy by DNS name or IP address

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

  • Get a backup proxy by ID

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

  • Get backup proxies by associated organization

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

Detailed Description

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

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Hostname

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

True

Named

False

False

Id

Specifies an ID assigned to a backup proxy that you want to get.

True

Named

False

False

Organization

Specifies an organization associated with a backup proxy that you want to get.

True

Named

True (ByValue)

False

<CommonParameters>

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

Example 1

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

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

Example 2

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

Get-VBOProxy -Hostname 172.17.53.53

Example 3

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

  1. Run the Get-VBOOrganization cmdlet. Set Columbus as 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.

$org = Get-VBOOrganization -Name "Columbus"

Get-VBOProxy -Organization $org

Related Commands

Get-VBOOrganization

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference