Disable-VBRViProxy

Short Description

Disables a VMware backup proxy.

Applies to

Platform: VMware

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

Syntax

Disable-VBRViProxy -Proxy <CViProxy[]> [<CommonParameters>]

Detailed Description

This cmdlet allows you to temporarily disable a VMware backup proxy. The disabled proxy is not used by any job.

Run the Enable-VBRViProxy cmdlet to enable a VMware backup proxy.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Proxy	Specifies an array of VMware proxies you want to disable.	Accepts the CViProxy[] object. To get this object, run the Get-VBRViProxy cmdlet.	True	Named	True (ByValue, ByProperty Name)

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

Output Object

The cmdlet returns the CViProxy[] that contains an array of VMware backup proxy servers added to the backup infrastructure.

Examples

Example 1. Disabling VMware Backup Proxy [Using Variable]

This example shows how to disable the VMware backup proxy named Local Backup Proxy.

$proxy = Get-VBRViProxy -Name "Local Backup Proxy"

Disable-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 Disable-VBRViProxy cmdlet. Set the $proxy variable as the Proxy parameter value.

Example 2. Disabling VMware Backup Proxy [Using Pipeline]

This example shows how to disable the VMware backup proxy named VMware Backup Proxy 01.

Get-VBRViProxy -Name "VMware Backup Proxy 01" | Disable-VBRViProxy

Perform the following steps:

Related Commands