Disable-VBRHvProxy

Short Description

Disables the Hyper-V backup proxy.

Platform: Hyper-V

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

Syntax

Disable-VBRHvProxy -Proxy <CHvProxy[]> [<CommonParameters>]

Detailed Description

This cmdlet allows you to disable the Hyper-V backup proxy. The disabled proxy is not used by any job.

Run the Enable-VBRHvProxy cmdlet to enable the Hyper-V backup proxy.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Proxy	Specifies an array of the Hyper-V proxies you want to disable. Accepts the `CHvProxy[]` object. To get this object, run the `Get-VBRHvProxy` cmdlet.	`CHvProxy[]`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

The cmdlet returns the CHvProxy[] that contains an array of Hyper-V backup proxy servers added to the backup infrastructure.

Examples

Disable-VBRHvProxy Example 1. Disabling Hyper-V Backup Proxy [Using Variable]

This example shows how to disable the Hyper-V backup proxy named Local Backup Proxy.

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

Disable-VBRHvProxy -Proxy $proxy

Perform the following steps:

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

Disable-VBRHvProxy Example 2. Disabling Hyper-V Backup Proxy [Using Pipeline]

This example shows how to disable the Hyper-V backup proxy named Hyper-V Backup Proxy 01.

Get-VBRHvProxy -Name "Hyper-V Backup Proxy 01" | Disable-VBRHvProxy

Perform the following steps: