Remove-VBRLocation

Short Description

Removes geographic locations from Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRLocation -Location <VBRLocation[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes geographic locations from the Veeam Backup & Replication database.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Location	Specifies the array of locations you want to remove.	Accepts the VBRLocation[] object. To get this object, run the Get-VBRLocation cmdlet.	True	Named	True (ByValue, ByProperty Name)
WhatIf	Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Location

Specifies the array of locations you want to remove.

Accepts the VBRLocation[] object. To get this object, run the Get-VBRLocation cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

WhatIf

Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

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

Output Object

None.

Examples

Remove-VBRLocation Example 1. Removing Selected Geographic Location

This example shows how to remove a selected geographic location from Veeam Backup & Replication.

$location = Get-VBRLocation -Name "Sacramento"

Remove-VBRLocation -Location $location

Perform the following steps:

Run the Get-VBRLocation cmdlet. Specify the Name parameter value. Save the result to the $location variable.
Run the Remove-VBRLocation cmdlet. Set the $location variable as the Location parameter value.

Remove-VBRLocation Example 2. Removing Several Geographic Locations

This example shows how to remove several geographic locations from Veeam Backup & Replication.

$locations = Get-VBRLocation -Name North*

Remove-VBRLocation -Location $locations

Perform the following steps:

Run the Get-VBRLocation cmdlet. Specify the Name parameter value. Save the result to the $locations variable.
Run the Remove-VBRLocation cmdlet. Set the $locations variable as the Location parameter value.

Related Commands

Get-VBRLocation