Remove-VBRDiscoveredComputerConfigurationPolicy

Short Description

Removes policies that contain configuration options for Veeam Agent settings.

Important

Make sure to test this cmdlet in the lab before you run it in the production environment.

Applies to

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

Syntax

Remove-VBRDiscoveredComputerConfigurationPolicy -Policy <VBRDiscoveredComputerConfigurationPolicy[]> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet removes policies that contain configuration options for Veeam Agent settings.

Important

The cmdlet does not update settings on discovered computers to which the policy has been applied. If you want to change the settings, you must create a new policy and assign it to discovered computers. To create a new policy, run the Add-VBRDiscoveredComputerConfigurationPolicy cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Policy

Specifies the policy that you want to remove.

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

True

Named

False

WhatIf

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

SwitchParamter

False

Named

False

Confirm

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

SwitchParamter

False

Named

False

<CommonParameters>

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

Output Object

None.

Examples

Removing Policy

This example shows how to remove a policy using the policy ID.

$PolicyToRemove = Get-VBRDiscoveredComputerConfigurationPolicy -Id a78eceb5-d5b8-4fe0-9a8c-cc788a123c4a

Remove-VBRDiscoveredComputerConfigurationPolicy -Policy $PolicyToRemove

Perform the following steps:

  1. Run the Get-VBRDiscoveredComputerConfigurationPolicy cmdlet. Specify the Id parameter value. Save the result to the $PolicyToRemove variable.
  2. Run the Remove-VBRDiscoveredComputerConfigurationPolicy cmdlet. Set the $PolicyToRemove variable as the Policy parameter value.

Related Commands