Get-VBRLocation - Veeam Backup PowerShell Reference
Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Get-VBRLocation

Short Description

Returns geographical locations created in Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides 3 parameter sets.

  • For getting locations by name:

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

  • For getting locations by ID:

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

  • For getting locations assigned to the backup infrastructure component:

Get-VBRLocation [-Object <Object>]  [<CommonParameters>]

Detailed Description

This cmdlet returns geographical locations created in Veeam Backup & Replication. You can get the list of all locations or search for instances directly by name, ID or associated infrastructure components.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the array of location names.

The cmdlet will return locations with these names.

True

Named

True (ByProperty
Name)

True

Id

Specifies the array of location IDs.

The cmdlet will return locations with these IDs.

True

Named

True (ByProperty
Name)

False

Object

Specifies the Veeam Backup & Replication infrastructure component.

The cmdlet will return a location assigned to this component.

Accepts the following types:

  • CBackupRepository (backup repository)

True

Named

True (ByProperty
Name)

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 locations by name.

PS C:\PS> Get-VBRLocation -Name "Location North", SuperLocation

Example 2

This command returns locations by ID.

PS C:\PS> Get-VBRLocation -Id 97e9f314-690c-410f-a1c2-acc101faa2ce, a1218a40-e863-4d38-813f-e68974c3896

Example 3

This example shows how to get the location assigned to the ESXi host.

You will need to perform the following steps:

  1. Run Find-VBRViEntity to get the ESXi host added to Veeam Backup & Replication. Save the result to the $esxi variable.
  2. Run Get-VBRLocation with the $esxi variable.

PS C:\PS> $esxi = Find-VBRViEntity -Name team.support.north

PS C:\PS> Get-VBRLocation -Object $esxi

Related Commands

Find-VBRViEntity

Find-VBRHvEntity

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation