Remove-VBRViProxy

Short Description

Removes a VMware backup proxy from the backup infrastructure.

Applies to

Platform: VMware

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

Syntax

Remove-VBRViProxy -Proxy <CViProxy[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes the specified VMware backup proxy from the backup infrastructure.

When you remove a backup proxy, Veeam Backup & Replication unassigns the proxy role from the server, so it is no longer used as a backup proxy. The actual server remains added to the backup infrastructure.

Note:

You cannot remove a backup proxy that is explicitly selected in any backup, replication or VM copy job. To remove such a proxy, you need to delete all job references to it first.

Run the Disable-VBRViProxy cmdlet to disable a VMware backup proxy.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Proxy	Specifies an array of VMware proxies you want to remove.	Accepts the CViProxy[] object. To get this object, run the Get-VBRViProxy cmdlet.	True	Named	True (ByValue, ByProperty Name)
WhatIf	Defines that the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines that 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

Proxy

Specifies an array of VMware proxies you want to remove.

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

True

Named

True (ByValue,
ByProperty
Name)

WhatIf

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

SwitchParameter

False

Named

False

Confirm

Defines that 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-VBRViProxy Example 1. Removing VMware Backup Proxy [Using Variable]

This example shows how to remove the VMware backup proxy named LocalProxy.

$proxy = Get-VBRViProxy -Name "LocalProxy"

Remove-VBRViProxy -Proxy $proxy

Perform the following steps:

Run the Get-VBRViProxy cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
Run the Remove-VBRViProxy cmdlet. Set the $proxy variable as the Proxy parameter value.

Remove-VBRViProxy Example 2. Removing VMware Backup Proxy [Using Pipeline]

This example shows how to remove VMware backup proxy named LocalProxy.

Get-VBRViProxy -Name "LocalProxy"| Remove-VBRViProxy

Perform the following steps:

Run the Get-VBRViProxy cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Remove-VBRViProxy cmdlet.

Related Commands

Get-VBRViProxy