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: CBackupRepository (backup repository). Run the Get-VBRBackupRepository cmdlet to get this object. VBRScaleOutBackupRepository (scale-out backup repository). Run the Get-VBRBackupRepository cmdlet to get this object. VBRTapeVault (tape vault). Run the Get-VBRTapeVault cmdlet to get this object. VBRTapeLibrary (tape library). Run the Get-VBRTapeLibrary cmdlet to get this object. VBRCloudProvider (cloud provider). Run the Get-VBRCloudProvider cmdlet to get this object. VBRProtectionGroup (protection group). Run the Get-VBRProtectionGroup cmdlet to get this object. Objects returned by the Find-VBRViEntity cmdlet (VMware virtual objects). Objects returned by the Find-VBRHvEntity cmdlet (Hyper-V virtual objects) VBRAmazonS3Repository (Amazon S3 object storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object. VBRAmazonS3CompatibleRepository (S3 compatible object storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object. VBRAzureBlobRepository (Azure Blob object storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object. VBRAzureDataBoxRepository (Azure Data Box storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object.	True	Named	True (ByProperty Name)

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)

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:

CBackupRepository (backup repository). Run the Get-VBRBackupRepository cmdlet to get this object.
VBRScaleOutBackupRepository (scale-out backup repository). Run the Get-VBRBackupRepository cmdlet to get this object.
VBRTapeVault (tape vault). Run the Get-VBRTapeVault cmdlet to get this object.
VBRTapeLibrary (tape library). Run the Get-VBRTapeLibrary cmdlet to get this object.
VBRCloudProvider (cloud provider). Run the Get-VBRCloudProvider cmdlet to get this object.
VBRProtectionGroup (protection group). Run the Get-VBRProtectionGroup cmdlet to get this object.
Objects returned by the Find-VBRViEntity cmdlet (VMware virtual objects).
Objects returned by the Find-VBRHvEntity cmdlet (Hyper-V virtual objects)
VBRAmazonS3Repository (Amazon S3 object storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object.
VBRAmazonS3CompatibleRepository (S3 compatible object storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object.
VBRAzureBlobRepository (Azure Blob object storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object.
VBRAzureDataBoxRepository (Azure Data Box storage). Run the Get-VBRObjectStorageRepository cmdlet to get this object.

True

Named

True (ByProperty
Name)

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-VBRLocation Example 1. Getting Locations by Name

Get-VBRLocation Example 2. Getting Locations by ID

Get-VBRLocation Example 3. Getting Location Assigned to ESXi Host

Related Commands