Get-VBRLocation

Short Description

Returns geographical 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 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) VBRScaleOutBackupRepository (scale-out backup repository) VBRTapeVault (tape vault) VBRTapeLibrary (tape library) VBRCloudProvider (cloud provider) VBRProtectionGroup (protection group) Find-VBRViEntity return types (VMware virtual objects) Find-VBRHvEntity return types (Hyper-V virtual objects) VBRAmazonS3Repository (Amazon S3 object storage) VBRAmazonS3CompatibleRepository (S3 compatible object storage) VBRAzureBlobRepository (Azure Blob object storage) VBRAzureDataBoxRepository (Azure Data Box storage)	True	Named	True (ByProperty Name)	False

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

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)
VBRScaleOutBackupRepository (scale-out backup repository)
VBRTapeVault (tape vault)
VBRTapeLibrary (tape library)
VBRCloudProvider (cloud provider)
VBRProtectionGroup (protection group)
Find-VBRViEntity return types (VMware virtual objects)
Find-VBRHvEntity return types (Hyper-V virtual objects)
VBRAmazonS3Repository (Amazon S3 object storage)
VBRAmazonS3CompatibleRepository (S3 compatible object storage)
VBRAzureBlobRepository (Azure Blob object storage)
VBRAzureDataBoxRepository (Azure Data Box storage)

True

Named

True (ByProperty
Name)

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example 1

This command returns locations by name.

Get-VBRLocation -Name "Location North", SuperLocation

Example 2

This command returns locations by ID.

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:

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

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

Get-VBRLocation -Object $esxi

Related Commands

Find-VBRViEntity

Find-VBRHvEntity