Apply-VBRManagedByAgentPolicy

Short Description

Assigns Veeam Agent backup policies to protected computers.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Apply-VBRManagedByAgentPolicy [-Policy] <VBRComputerBackupJob[]> [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet assigns Veeam Agent backup policies to protected computers.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Policy

Specifies a Veeam Agent backup policy that you want to assign to protected computers.

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

True

0

True (ByValue, ByPropertyName)

RunAsync

Defines that the command returns immediately without waiting for the task to complete.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

VBRSession

Examples

Assigning Veeam Agent Backup Policy to Protected Computers

This example shows how to assign a Veeam Agent backup policy to protected computers.

$job = Get-VBRComputerBackupJob -Name "WinSrv2049"

Apply-VBRManagedByAgentPolicy -Policy $job

Perform the following steps:

  1. Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Apply-VBRManagedByAgentPolicy cmdlet. Set the $job variable as the Policy parameter value.

Related Commands

Get-VBRComputerBackupJob

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.