Uninstall-VBRServerComponent

Short Description

Removes a backup infrastructure component from the backup infrastructure.

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

Syntax

Uninstall-VBRServerComponent -Server <CHost> -ComponentType <VBRComponentType> [<CommonParameters>]

Detailed Description

This cmdlet removes the following infrastructure components from the backup infrastructure:

  • CatalystSdk
  • DDBoostSdk
  • GuestInteractionProxy

Note

Consider the following:

  • You will not be able to remove the CatalystSdk or DDBoostSdk components if they are used as as a gateway server for one or more backup repositories.
  • You must reboot the host from which the components are removed, otherwise the DD Boost library will not be removed.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

ComponentType

Specifies the component that you want to remove:

  • CatalystSdk
  • DDBoostSdk
  • GuestInteractionProxy

VBRComponentType

True

Named

False

Server

Specifies the host. The cmdlet will remove components from this host.

CHost

True

Named

True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Removing Guest Interaction Proxy from Backup Infrastructure

This example shows how to remove the guest interaction proxy from the backup infrastructure.

$server = Get-VBRServer -Name hyperv09.tech.local

Uninstall-VBRServerComponent -Server $server -ComponentType GuestInteractionProxy

Perform the following steps:

  1. Run the Get-VBRServerReturns hosts connected to the backup infrastructure. cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Uninstall-VBRServerComponent cmdlet. Set the $server variable as the Server parameter value. Set the GuestInteractionProxy property as the ComponentType parameter value.

Get-VBRServerReturns hosts connected to the backup infrastructure.

Page updated 2026-08-19

Page content applies to build 13.1.1.18