Get-VBRLocation

Short Description

Returns geographic locations created in Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get locations by name.

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

  • Get locations by ID.

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

  • Get locations assigned to the backup infrastructure component.

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

Detailed Description

This cmdlet returns geographic 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

Type

Required

Position

Accept
Pipeline
Input

Name

Specifies the array of location names.

The cmdlet will return locations with these names.

String[]

True

Named

True (ByProperty
Name)

Id

Specifies the array of location IDs.

The cmdlet will return locations with these IDs.

Guid[]

True

Named

True (ByProperty
Name)

Object

Specifies the Veeam Backup & Replication infrastructure component.

The cmdlet will return a location assigned to this component.

Accepts the following objects:

True

Named

True (ByProperty
Name)

<CommonParameters>

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

Output Object

The cmdlet returns the VBRLocation object that lists geographic locations created in Veeam Backup & Replication.

Examples

Get-VBRLocationExample 1. Getting Locations by Name

This command returns locations by name.

Get-VBRLocation -Name "Location North", SuperLocation

Get-VBRLocationExample 2. Getting Locations by ID

This command returns locations by ID.

Get-VBRLocation -Id 97e9f314-690c-410f-a1c2-acc101faa2ce, a1218a40-e863-4d38-813f-e68974c3896

Get-VBRLocationExample 3. Getting Location Assigned to ESXi Host

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

$esxi = Find-VBRViEntity -Name team.support.north

Get-VBRLocation -Object $esxi

Perform the following steps:

  1. Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $esxi variable.
  2. Run the Get-VBRLocation cmdlet. Set the $esxi variable as the Object parameter value.

Related Commands